Annotation of pkgsrc/doc/pkgsrc.html, revision 1.198
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.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.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.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
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.194 bsiegert 33: <div><p class="copyright">Copyright © 1994-2015 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.28 2015/01/01 05:19:02 jnemeth Exp $</p></div>
1.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.195 wiz 48: <dl class="toc">
1.75 rillig 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>
1.157 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</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>
1.151 obache 82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 92: </dl></dd>
93: </dl></dd>
94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
97: <dd><dl>
98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
103: <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>
104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
105: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 106: </dl></dd>
107: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
108: <dd><dl>
109: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
110: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
111: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
112: </dl></dd>
113: </dl></dd>
114: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
115: <dd><dl>
116: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
117: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 118: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 119: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 120: <dd><dl>
1.103 wiz 121: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 122: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
123: <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 124: </dl></dd>
1.103 wiz 125: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
126: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 127: </dl></dd>
128: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
129: <dd><dl>
130: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
131: <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 132: </dl></dd>
133: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
134: builds)</a></span></dt>
1.75 rillig 135: <dd><dl>
1.180 wiz 136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
138: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
139: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 140: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 142: </dl></dd>
143: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
144: <dd><dl>
1.128 wiz 145: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
146: <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 147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194 bsiegert 151: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
152: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
153: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
154: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
155: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
156: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
157: <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>
158: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
159: <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
1.128 wiz 160: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 161: <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>
162: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
163: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
164: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
165: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
167: <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 168: </dl></dd>
169: </dl></dd>
170: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
171: <dd><dl>
1.106 rillig 172: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 173: <dd><dl>
1.106 rillig 174: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 175: <dd><dl>
1.106 rillig 176: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 177: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 178: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 179: </dl></dd>
1.106 rillig 180: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
181: <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>
182: </dl></dd>
183: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
184: <dd><dl>
1.128 wiz 185: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
186: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 187: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
188: <dd><dl>
189: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
190: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
193: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
194: </dl></dd>
195: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
196: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
197: <dd><dl>
198: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
199: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
201: </dl></dd>
1.128 wiz 202: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
203: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 204: </dl></dd>
1.128 wiz 205: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 206: <dd><dl>
207: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 208: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
210: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
211: <dd><dl>
212: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
213: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
214: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
215: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
217: </dl></dd>
218: </dl></dd>
219: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
220: <dd><dl>
221: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 222: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
223: <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 224: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
225: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 226: <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 227: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 228: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
229: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106 rillig 230: </dl></dd>
231: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
232: <dd><dl>
233: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 234: <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 235: <dd><dl>
236: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 237: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
238: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
239: and
240: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
241: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 242: </dl></dd>
1.128 wiz 243: <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 244: <dd><dl>
1.128 wiz 245: <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 246: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
247: </dl></dd>
248: </dl></dd>
249: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
250: <dd><dl>
251: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
254: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
255: </dl></dd>
256: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
257: <dd><dl>
1.128 wiz 258: <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 259: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
260: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
261: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
262: </dl></dd>
263: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
264: <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>
265: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
266: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
267: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
268: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
269: <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>
270: </dl></dd>
271: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
272: <dd><dl>
273: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 274: <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 275: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 276: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 277: </dl></dd>
278: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
281: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
282: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
283: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 284: <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 285: <dd><dl>
286: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
287: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
288: </dl></dd>
1.128 wiz 289: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
298: <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 299: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
300: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
301: </dl></dd>
302: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
303: <dd><dl>
304: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
305: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
306: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
307: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 314: <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 315: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
1.128 wiz 326: <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 327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <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>
330: </dl></dd>
1.128 wiz 331: <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 332: <dd><dl>
333: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
336: </dl></dd>
337: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
338: <dd><dl>
339: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
340: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
341: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 342: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
343: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 344: </dl></dd>
1.128 wiz 345: <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 346: <dd><dl>
347: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
348: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 349: <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 350: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
351: </dl></dd>
1.128 wiz 352: <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 353: <dd><dl>
354: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
355: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
356: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
357: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
358: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
359: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
360: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
361: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 362: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 363: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 364: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
365: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
366: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
367: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
368: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
369: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
370: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
371: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 372: emulation</a></span></dt>
1.106 rillig 373: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
374: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 375: </dl></dd>
1.106 rillig 376: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 377: </dl></dd>
1.106 rillig 378: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
379: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 380: <dd><dl>
1.106 rillig 381: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
382: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
383: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 384: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 385: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 386: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
387: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 388: </dl></dd>
389: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
390: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
391: <dd><dl>
392: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
393: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
394: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
395: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 396: </dl></dd>
1.75 rillig 397: </dl></dd>
398: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
399: <dd><dl>
1.106 rillig 400: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 401: <dd><dl>
1.106 rillig 402: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
403: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 405: <dd><dl>
1.106 rillig 406: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
407: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 408: </dl></dd>
1.106 rillig 409: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
410: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 411: <dd><dl>
1.106 rillig 412: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
413: <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 414: </dl></dd>
1.106 rillig 415: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 416: <dd><dl>
1.128 wiz 417: <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>
418: <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 419: </dl></dd>
420: </dl></dd>
1.106 rillig 421: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 422: <dd><dl>
1.106 rillig 423: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
424: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 426: <dd><dl>
1.106 rillig 427: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
428: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 429: </dl></dd>
430: </dl></dd>
1.106 rillig 431: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 432: <dd><dl>
1.106 rillig 433: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
434: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 435: </dl></dd>
436: </dl></dd>
437: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
440: <dd><dl>
441: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
442: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
443: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 444: <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 445: </dl></dd>
446: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
447: </dl></dd>
448: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
449: <dd><dl>
450: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
451: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
452: </dl></dd>
1.76 rillig 453: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
454: <dd><dl>
1.128 wiz 455: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
456: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
457: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
458: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
459: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
460: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 461: source packages</a></span></dt>
462: </dl></dd>
1.75 rillig 463: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
464: <dd><dl>
1.79 rillig 465: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 466: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
467: </dl></dd>
468: </dl>
469: </div>
1.82 rillig 470: <div class="list-of-tables">
471: <p><b>List of Tables</b></p>
472: <dl>
473: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
474: </dt>
1.106 rillig 475: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 476: </dt>
1.106 rillig 477: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 478: </dt>
1.82 rillig 479: </dl>
480: </div>
1.148 asau 481: <div class="chapter">
482: <div class="titlepage"><div><div><h1 class="title">
483: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 484: <div class="toc">
485: <p><b>Table of Contents</b></p>
1.195 wiz 486: <dl class="toc">
1.75 rillig 487: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 488: <dd><dl>
489: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
490: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
491: </dl></dd>
1.75 rillig 492: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
493: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 494: <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 495: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
496: </dl>
497: </div>
1.148 asau 498: <div class="sect1">
1.75 rillig 499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
500: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 501: <p>There is a lot of software freely available for Unix-based
502: systems, which is usually available in form of the source code. Before
503: such software can be used, it needs to be configured to the local
504: system, compiled and installed, and this is exactly what The NetBSD
505: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
506: to handle binary packages, so that not every user has to build the
507: packages for himself, which is a time-costly task.</p>
1.75 rillig 508: <p>pkgsrc currently contains several thousand packages,
509: including:</p>
1.148 asau 510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 511: <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 512: web server</p></li>
1.189 snj 513: <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 514: web browser</p></li>
1.189 snj 515: <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 516: Desktop Environment</p></li>
1.189 snj 517: <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 518: Desktop Environment</p></li>
519: </ul></div>
520: <p>...just to name a few.</p>
521: <p>pkgsrc has built-in support for handling varying dependencies,
522: such as pthreads and X11, and extended features such as IPv6 support on
523: a range of platforms.</p>
1.148 asau 524: <div class="sect2">
1.82 rillig 525: <div class="titlepage"><div><div><h3 class="title">
526: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
527: <p>
528: pkgsrc provides the following key features:
529: </p>
1.148 asau 530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 531: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 532: and installation of binary packages. The source and latest
533: patches are retrieved from a master or mirror download site, checksum
534: verified, then built on your system. Support for binary-only
535: distributions is available for both native platforms and NetBSD
536: emulated platforms.</p></li>
1.128 wiz 537: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 538: including binaries, libraries, man pages and other
539: documentation.</p></li>
1.128 wiz 540: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 541: are handled automatically. The configuration files of various
542: packages are handled automatically during updates, so local changes
543: are preserved.</p></li>
1.128 wiz 544: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 545: consists of highly portable code. This allows the greatest speed of
1.132 spz 546: development when porting to a new platform. This portability also
1.82 rillig 547: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
548: platforms</em></span>.</p></li>
1.128 wiz 549: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 550: international encryption requirements and build-time options for a
551: large number of packages are all set in a simple, central
552: configuration file.</p></li>
1.128 wiz 553: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 554: freely available under a BSD license, so you may extend and adapt
555: pkgsrc to your needs. Support for local packages and patches is
556: available right out of the box, so you can configure it specifically
557: for your environment.</p></li>
558: </ul></div>
1.91 rillig 559: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 561: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 562: — That means, if a package contains bugs, it's better to find
1.91 rillig 563: them and to complain about them rather than to just install the package
564: and hope that it works. There are numerous checks in pkgsrc that try to
1.189 snj 565: 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
1.91 rillig 566: of shell scripts), and post-installation checks (installed files,
567: references to shared libraries, script interpreters).</p></li>
1.128 wiz 568: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 569: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 570: pkgsrc has been ported to many operating systems. Care is taken that
571: packages behave the same on all platforms.</p></li>
572: </ul></div>
1.82 rillig 573: </div>
1.148 asau 574: <div class="sect2">
1.82 rillig 575: <div class="titlepage"><div><div><h3 class="title">
576: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
577: <p>pkgsrc consists of both a source distribution and a binary
578: distribution for these operating systems. After retrieving the required
579: source or binaries, you can be up and running with pkgsrc in just
580: minutes!</p>
1.75 rillig 581: <p>pkgsrc was derived from FreeBSD's ports system, and
582: initially developed for NetBSD only. Since then, pkgsrc has
583: grown a lot, and now supports the following platforms:</p>
1.82 rillig 584: <div class="table">
585: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 586: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 587: <colgroup>
588: <col>
589: <col>
590: </colgroup>
591: <thead><tr>
592: <th>Platform</th>
593: <th>Date Support Added</th>
594: </tr></thead>
595: <tbody>
596: <tr>
1.110 hubertf 597: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 598: <td align="center">Aug 1997</td>
599: </tr>
600: <tr>
1.110 hubertf 601: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 602: <td align="center">Mar 1999</td>
603: </tr>
604: <tr>
1.110 hubertf 605: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 606: <td align="center">Jun 1999</td>
607: </tr>
608: <tr>
609: <td>
1.110 hubertf 610: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
611: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 612: </td>
613: <td align="center">Oct 2001</td>
614: </tr>
615: <tr>
1.110 hubertf 616: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 617: <td align="center">Nov 2002</td>
618: </tr>
619: <tr>
1.110 hubertf 620: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 621: <td align="center">Nov 2002</td>
622: </tr>
623: <tr>
1.110 hubertf 624: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 625: <td align="center">Dec 2002</td>
626: </tr>
627: <tr>
628: <td>BSD/OS</td>
629: <td align="center">Dec 2003</td>
630: </tr>
631: <tr>
1.110 hubertf 632: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 633: <td align="center">Dec 2003</td>
634: </tr>
635: <tr>
636: <td>
1.110 hubertf 637: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 638: (Microsoft Windows Services for Unix)
639: </td>
640: <td align="center">Mar 2004</td>
641: </tr>
642: <tr>
1.110 hubertf 643: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 644: <td align="center">Oct 2004</td>
645: </tr>
646: <tr>
1.110 hubertf 647: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 648: <td align="center">Nov 2004</td>
649: </tr>
1.98 wiz 650: <tr>
1.110 hubertf 651: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 652: <td align="center">Apr 2007</td>
653: </tr>
1.128 wiz 654: <tr>
655: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
656: <td align="center">Sep 2010</td>
657: </tr>
1.151 obache 658: <tr>
659: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 660: <td align="center">Jan 2011</td>
1.151 obache 661: </tr>
662: <tr>
663: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
664: <td align="center">Nov 2011</td>
665: </tr>
666: <tr>
667: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
668: <td align="center">Mar 2013</td>
669: </tr>
1.166 jnemeth 670: <tr>
671: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
672: <td align="center">Jul 2013</td>
673: </tr>
1.82 rillig 674: </tbody>
1.91 rillig 675: </table></div>
1.82 rillig 676: </div>
1.91 rillig 677: <br class="table-break">
1.82 rillig 678: </div>
1.75 rillig 679: </div>
1.148 asau 680: <div class="sect1">
1.75 rillig 681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
682: <a name="overview"></a>1.2. Overview</h2></div></div></div>
683: <p>This document is divided into three parts. The first,
1.110 hubertf 684: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 685: describes how one can use one of the packages in the Package
686: Collection, either by installing a precompiled binary package,
1.93 rillig 687: or by building one's own copy using the NetBSD package system.
1.110 hubertf 688: 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 689: package so it can be easily built by other NetBSD users without
690: knowing about the package's building details. The third part,
1.110 hubertf 691: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 692: is intended for those who want to understand how pkgsrc is
693: implemented.</p>
694: <p>This document is available in various formats:
1.110 hubertf 695: <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 696: </div>
1.148 asau 697: <div class="sect1">
1.75 rillig 698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
699: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 700: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
701: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 702: terminology used within this document.</p>
1.148 asau 703: <div class="variablelist"><dl class="variablelist">
1.75 rillig 704: <dt><span class="term">Package</span></dt>
705: <dd><p>A set of files and building instructions
706: that describe what's necessary
707: to build a certain piece of software using
708: pkgsrc. Packages are traditionally stored under
1.76 rillig 709: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 710: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 711: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 712: is part of the NetBSD operating system and can be bootstrapped
713: to run on non-NetBSD operating systems as well. It handles
714: building (compiling), installing, and removing of
715: packages.</p></dd>
1.75 rillig 716: <dt><span class="term">Distfile</span></dt>
717: <dd><p>This term describes the file or files that are
718: provided by the author of the piece of software to
719: distribute his work. All the changes necessary to build on
720: NetBSD are reflected in the corresponding package. Usually
721: the distfile is in the form of a compressed tar-archive,
722: but other types are possible, too. Distfiles are usually
723: stored below
1.76 rillig 724: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 725: <dt><span class="term">Port</span></dt>
726: <dd><p>This is the term used by FreeBSD and OpenBSD people
727: for what we call a package.
1.128 wiz 728: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 729: architecture.</p></dd>
730: <dt><span class="term">Precompiled/binary package</span></dt>
731: <dd>
732: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 733: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 734: file so it can be installed on machines of the same
735: machine architecture without the need to
736: recompile. Packages are usually generated in
1.76 rillig 737: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 738: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 739: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 740: especially in the context of precompiled packages.</p>
741: </dd>
742: <dt><span class="term">Program</span></dt>
1.88 wiz 743: <dd><p>The piece of software to be installed which will be
744: constructed from all the files in the distfile by the
745: actions defined in the corresponding package.</p></dd>
1.75 rillig 746: </dl></div>
1.148 asau 747: <div class="sect2">
1.75 rillig 748: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 749: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 750: <div class="variablelist"><dl class="variablelist">
1.75 rillig 751: <dt><span class="term">pkgsrc users</span></dt>
752: <dd>
753: <p>The
754: pkgsrc users are people who use the packages provided by pkgsrc.
755: Typically they are system administrators. The people using the
1.128 wiz 756: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
757: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 758: <p>There are two kinds of pkgsrc users: Some only want to
759: install pre-built binary packages. Others build the pkgsrc
760: packages from source, either for installing them directly or for
1.110 hubertf 761: 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 762: documentation.</p>
763: </dd>
764: <dt><span class="term">package maintainers</span></dt>
765: <dd><p>A
1.110 hubertf 766: 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 767: <dt><span class="term">infrastructure developers</span></dt>
768: <dd><p>These people are involved in all those files
1.76 rillig 769: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 770: 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 771: too.</p></dd>
772: </dl></div>
773: </div>
774: </div>
1.148 asau 775: <div class="sect1">
1.75 rillig 776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
777: <a name="typography"></a>1.4. Typography</h2></div></div></div>
778: <p>When giving examples for commands, shell prompts are used to
779: show if the command should/can be issued as root, or if
1.128 wiz 780: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 781: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
782: shell prompt, assuming they use the C-shell or tcsh.</p>
783: </div>
784: </div>
1.148 asau 785: <div class="part">
1.75 rillig 786: <div class="titlepage"><div><div><h1 class="title">
787: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
788: <div class="toc">
789: <p><b>Table of Contents</b></p>
1.195 wiz 790: <dl class="toc">
1.75 rillig 791: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
792: <dd><dl>
793: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
794: <dd><dl>
1.157 asau 795: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 796: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 797: </dl></dd>
798: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
799: <dd><dl>
800: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
801: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
802: </dl></dd>
803: </dl></dd>
804: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
805: <dd><dl>
1.82 rillig 806: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
807: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
808: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
809: <dd><dl>
1.151 obache 810: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
811: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
812: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 813: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
814: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
815: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
816: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
817: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
818: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
819: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 820: </dl></dd>
821: </dl></dd>
822: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
823: <dd><dl>
824: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
825: <dd><dl>
826: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
827: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 828: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
829: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
830: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
831: <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>
832: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
833: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 834: </dl></dd>
835: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
836: <dd><dl>
837: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
838: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
839: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
840: </dl></dd>
841: </dl></dd>
842: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
843: <dd><dl>
844: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
845: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 846: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 847: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 848: <dd><dl>
1.103 wiz 849: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 850: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
851: <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 852: </dl></dd>
1.103 wiz 853: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
854: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 855: </dl></dd>
856: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
857: <dd><dl>
858: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
859: <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 860: </dl></dd>
861: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
862: builds)</a></span></dt>
1.75 rillig 863: <dd><dl>
1.180 wiz 864: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
865: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
866: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
867: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 868: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
869: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 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>
1.194 bsiegert 879: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
880: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
881: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
882: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
883: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
884: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
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>
886: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
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
1.128 wiz 888: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 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>
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>
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>
894: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
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.148 asau 899: <div class="chapter">
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>
1.195 wiz 904: <dl class="toc">
1.75 rillig 905: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
906: <dd><dl>
1.157 asau 907: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</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.148 asau 925: <div class="sect1">
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.188 snj 934: <code class="literal">2014Q3</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>
1.157 asau 938: <p>Note that tar archive contains CVS working copy.
939: Thus you can switch to using CVS at any later time.</p>
1.148 asau 940: <div class="sect2">
1.75 rillig 941: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 942: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 943: <p>The primary download location for all pkgsrc files is
1.157 asau 944: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
945: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
946: (it points to the same location).
947: There are a number of subdirectories for different purposes,
948: which are 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>
949: <p>The tar archive for the current branch is in the directory
950: <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75 rillig 951: It is autogenerated daily.</p>
1.157 asau 952: <p>To save download time we provide bzip2- and
953: xz-compressed archives which are published at
954: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
955: and
956: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
957: respectively.
958: </p>
959: <p>You can fetch the same files using FTP.</p>
1.188 snj 960: <p>The tar file for the stable branch 2014Q3 is in the
961: directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112 weinem 962: <p>To download a pkgsrc stable tarball, run:</p>
963: <pre class="screen">
1.166 jnemeth 964: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.126 jakllsch 965: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 966: stable branch to be downloaded, for example,
1.188 snj 967: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
968: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 969: or your web browser.</p>
1.112 weinem 970: <p>Then, extract it with:</p>
1.188 snj 971: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 972: <p>This will create the directory <code class="filename">pkgsrc/</code>
973: in <code class="filename">/usr/</code> and all the package source will be
974: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
975: <p>To download pkgsrc-current, run:</p>
976: <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 977: </div>
1.148 asau 978: <div class="sect2">
1.75 rillig 979: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 980: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
981: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 982: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.128 wiz 983: </pre>
984: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.188 snj 985: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.128 wiz 986: <p>This will create the directory <code class="filename">pkgsrc/</code>
987: in your <code class="filename">/usr/</code> directory and all the package source
988: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
989: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 990: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 grant 991: </pre>
1.188 snj 992: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 993: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146 wiz 994: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128 wiz 995: </pre>
996: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
997: For Bourne shells, you can set it in your <code class="filename">.profile</code>
998: or better globally in <code class="filename">/etc/profile</code>:</p>
999: <pre class="programlisting">
1000: # set CVS remote shell command
1001: CVS_RSH=ssh
1002: export CVS_RSH
1003: </pre>
1004: <p>By default, CVS doesn't do things like most people would expect it to do.
1005: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1006: in your home directory and saving the following lines to it.
1007: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1008: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1009: <pre class="programlisting">
1010: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1011: cvs -q -z2
1.101 rillig 1012: checkout -P
1.103 wiz 1013: update -dP
1014: diff -upN
1.101 rillig 1015: rdiff -u
1.128 wiz 1016: release -d
1.101 rillig 1017: </pre>
1.75 rillig 1018: </div>
1019: </div>
1.148 asau 1020: <div class="sect1">
1.75 rillig 1021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1022: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1023: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1024: (which also works if you have first installed it via a tar
1025: file). It saves bandwidth and hard disk activity, compared to
1026: downloading the tar file again.</p>
1.148 asau 1027: <div class="sect2">
1.75 rillig 1028: <div class="titlepage"><div><div><h3 class="title">
1029: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1030: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1031: <h3 class="title">Warning</h3>
1.77 rillig 1032: <p>When updating from a tar file, you first need to
1033: completely remove the old pkgsrc directory. Otherwise those
1034: files that have been removed from pkgsrc in the mean time will
1035: not be removed on your local disk, resulting in inconsistencies.
1036: When removing the old files, any changes that you have done to
1037: the pkgsrc files will be lost after updating. Therefore updating
1038: via CVS is strongly recommended.</p>
1.75 rillig 1039: </div>
1.82 rillig 1040: <p>Note that by default the distfiles and the binary packages
1041: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1042: before updating. You can also configure pkgsrc to store distfiles
1043: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1044: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1045: 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 1046: <p>To update pkgsrc from a tar file, download the tar file as
1047: explained above. Then, make sure that you have not made any
1048: changes to the files in the pkgsrc directory. Remove the pkgsrc
1049: directory and extract the new tar file. Done.</p>
1050: </div>
1.148 asau 1051: <div class="sect2">
1.75 rillig 1052: <div class="titlepage"><div><div><h3 class="title">
1053: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1054: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1055: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1056: </pre>
1057: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1058: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1059: </pre>
1.148 asau 1060: <div class="sect3">
1.75 rillig 1061: <div class="titlepage"><div><div><h4 class="title">
1062: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1063: <p>When updating pkgsrc, the CVS program keeps track of the
1064: branch you selected. But if you, for whatever reason, want to
1065: switch from the stable branch to the current one, you can do it
1.128 wiz 1066: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1067: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1068: back to the stable branch, add the
1.188 snj 1069: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.75 rillig 1070: </div>
1.148 asau 1071: <div class="sect3">
1.75 rillig 1072: <div class="titlepage"><div><div><h4 class="title">
1073: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1074: <p>When you update pkgsrc, the CVS program will only touch
1075: those files that are registered in the CVS repository. That
1076: means that any packages that you created on your own will stay
1077: unmodified. If you change files that are managed by CVS, later
1078: updates will try to merge your changes with those that have been
1079: done by others. See the CVS manual, chapter
1.128 wiz 1080: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1081: </div>
1082: </div>
1083: </div>
1084: </div>
1.148 asau 1085: <div class="chapter">
1.75 rillig 1086: <div class="titlepage"><div><div><h2 class="title">
1087: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1088: <div class="toc">
1089: <p><b>Table of Contents</b></p>
1.195 wiz 1090: <dl class="toc">
1.82 rillig 1091: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1092: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1093: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1094: <dd><dl>
1.151 obache 1095: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1096: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1097: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 1098: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1099: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1100: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1101: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1102: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1103: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1104: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 1105: </dl></dd>
1106: </dl>
1107: </div>
1.148 asau 1108: <div class="sect1">
1.75 rillig 1109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1110: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1111: <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 1112: </div>
1.148 asau 1113: <div class="sect1">
1.82 rillig 1114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1115: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1116: <p>pkgsrc can be bootstrapped for use in two different modes:
1117: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1118: to privileged one all programs are installed under one particular user
1.149 asau 1119: and cannot utilise privileged operations (packages don't create
1120: special users and all special file permissions like setuid are ignored).
1121: </p>
1.82 rillig 1122: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1123: <pre class="screen">
1.167 asau 1124: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75 rillig 1125: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1126: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1127: </pre>
1.149 asau 1128: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1129: <p>By default, in privileged mode pkgsrc uses
1130: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1131: where programs will be installed in,
1.87 wiz 1132: and <code class="filename">/var/db/pkg</code> for the package database
1.149 asau 1133: directory where pkgsrc will do its internal bookkeeping,
1134: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1135: where packages install their persistent data.
1136: In unprivileged mode pkgsrc uses
1137: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1138: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1139: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1140: </p>
1141: <p>You can change default layout using command-line arguments.
1142: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1143: </p>
1.148 asau 1144: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1145: <h3 class="title">Note</h3>
1.110 hubertf 1146: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1147: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1148: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1149: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1150: </div>
1.149 asau 1151: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1152: <h3 class="title">Note</h3>
1153: <p>It is possible to bootstrap multiple instances of pkgsrc
1154: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1155: corresponding to the installation you're working with to build
1156: and install packages.
1157: </p>
1158: </div>
1.75 rillig 1159: </div>
1.148 asau 1160: <div class="sect1">
1.75 rillig 1161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1162: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1163: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 asau 1164: <div class="sect2">
1.75 rillig 1165: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1166: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1167: <p>Cygwin 1.7.x and later are supported.</p>
1168: <p>You need to install minimal base packages in `Base' category
1169: plus any of compiler, gcc, gcc4, and/or clang.
1170: For gcc and gcc4, C and C++ compiler will be installed by default,
1171: but you can install Fortran compiler additionally
1172: because it will be required to use libtool.
1173: If it is not installed (or too old), Fortran compiler will be
1174: installed with pkgsrc automatically.</p>
1175: <p>As noted in
1176: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1177: su(1) command has been in Cygwin distribution, but it has never worked.
1178: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1179: </p>
1180: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1181: then pick "Run as administrator".</p></li></ul></div>
1182: </div>
1183: <div class="sect2">
1184: <div class="titlepage"><div><div><h3 class="title">
1185: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.148 asau 1186: <p>Darwin 5.x and up are supported.</p>
1187: <p>Before you start, you need to download and install
1188: the Mac OS X Developer Tools from Apple's Developer Connection.
1189: This requires (free) membership. See
1.126 jakllsch 1190: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 asau 1191: for details. Also, make sure you install X11 (an optional
1192: package included with the Developer Tools) if you intend
1193: to build packages that use the X11 Window System.
1194: (If you don't want or need the full Xcode GUI,
1195: download and install Command Line Tools for Xcode.)</p>
1.75 rillig 1196: </div>
1.148 asau 1197: <div class="sect2">
1.75 rillig 1198: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1199: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136 dholland 1200: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1201: other versions may work.</p>
1.75 rillig 1202: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1203: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1204: <div class="orderedlist"><ol class="orderedlist" type="1">
1205: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1206: <code class="filename">/var/db/pkg</code>. It is therefore
1207: recommended that you choose a different location (e.g.
1208: <code class="filename">/usr/pkgdb</code>) by
1209: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1210: <li class="listitem">
1.75 rillig 1211: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1212: good idea to move them out of the way to avoid confusion, e.g.</p>
1213: <pre class="screen">
1214: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1215: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1216: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1217: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1218: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1219: </pre>
1.75 rillig 1220: </li>
1.128 wiz 1221: <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 1222: <code class="filename">/etc/mk.conf.example</code> file
1223: when you use the bootstrap script.</p></li>
1.75 rillig 1224: </ol></div>
1225: </div>
1.148 asau 1226: <div class="sect2">
1.75 rillig 1227: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1228: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1229: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1230: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1231: <p> You should install ncurses (libncurses and libncurses-dev)
1232: packages.</p>
1233: </div>
1234: <div class="sect2">
1235: <div class="titlepage"><div><div><h3 class="title">
1236: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75 rillig 1237: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1238: providing a Unix-like environment with a tighter kernel integration than
1239: available with Cygwin. It is part of the Windows Services for Unix
1240: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1241: (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 1242: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1243: are not officially supported. (The main difference in 3.0/3.1 is lack
1244: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 wiz 1245: <p>Services for Unix Applications (aka SUA) is an integrated
1246: component of Windows Server 2003 R2 (5.2), Windows Vista and
1247: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1248: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1249: 6.1 (64bit) subsystems have been tested. Other versions may
1250: work as well. The Interix 5.x subsystem has not yet been tested
1251: with pkgsrc.</p>
1.148 asau 1252: <div class="sect3">
1.75 rillig 1253: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1254: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1255: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1256: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 asau 1257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1258: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1259: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1260: <li class="listitem"><p>Remote Connectivity</p></li>
1261: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1262: </ul></div>
1263: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1264: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1265: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1266: pkgsrc (or from a binary package).</p>
1.75 rillig 1267: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1268: not need to be installed, but Remote Connectivity itself should be
1269: installed in order to have a working inetd.</p>
1.75 rillig 1270: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1271: behavior for Interix programs, and whether to make pathnames default to
1272: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1273: enabled. (Without case-sensitivity, a large number of packages including
1274: perl will not build.)</p>
1.75 rillig 1275: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1276: works (via the Data Execution Prevention feature). In order to use
1277: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1278: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1279: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1280: support contract; however, Debian Interix Port has made most Interix
1281: 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 1282: <p>In addition to the hotfix noted above, it may be necessary to
1283: disable Data Execution Prevention entirely to make Interix functional.
1284: This may happen only with certain types of CPUs; the cause is not fully
1285: understood at this time. If gcc or other applications still segfault
1286: repeatedly after installing one of the hotfixes note above, the
1287: following option can be added to the appropriate "boot.ini" line on the
1288: Windows boot drive: /NoExecute=AlwaysOff
1289: (WARNING, this will disable DEP completely, which may be a security
1290: risk if applications are often run as a user in the Administrators
1291: group!)</p>
1.75 rillig 1292: </div>
1.148 asau 1293: <div class="sect3">
1.75 rillig 1294: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1295: <a name="platform.interix-sfu-postinstall"></a>3.3.5.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75 rillig 1296: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1297: with pkgsrc, note the following things.</p>
1.148 asau 1298: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1299: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1300: Windows Services for UNIX, then click Change. In the installer, choose
1301: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1302: <li class="listitem">
1.75 rillig 1303: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1304: change the following registry key:</p>
1.75 rillig 1305: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1306: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1307: </li>
1.128 wiz 1308: <li class="listitem">
1.75 rillig 1309: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1310: following registry key:</p>
1.75 rillig 1311: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1312: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1313: </li>
1314: </ul></div>
1315: </div>
1.148 asau 1316: <div class="sect3">
1.75 rillig 1317: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1318: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1319: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1320: running "pkg_add") must be a member of the local Administrators
1321: group. Such a user must also be used to run the bootstrap. This is
1322: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1323: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1324: automatically complain if this is not the case. This ensures that
1325: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1326: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1327: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1328: NOT be used in conjunction with pkgsrc. If you choose to use them at
1329: the same time as the pkgsrc packages, ensure that you use the proper
1330: pkg_* tools for each type of binary package.</p>
1.75 rillig 1331: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1332: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1333: don't have a termcap/terminfo entry for it, but the following .termcap
1334: entry provides adequate emulation in most cases:</p>
1.75 rillig 1335: <pre class="programlisting">
1.100 rillig 1336: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1337: </pre>
1.75 rillig 1338: </div>
1.148 asau 1339: <div class="sect3">
1.75 rillig 1340: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1341: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1342: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1343: for a full Unix-like platform, it has some drawbacks that should
1344: be noted for those desiring to make the most of Interix.</p>
1.148 asau 1345: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1346: <li class="listitem">
1.75 rillig 1347: <p><span class="strong"><strong>X11:</strong></span></p>
1348: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1349: and can run X11 based applications, but it does
1350: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1351: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1352: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1353: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1354: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1355: and the free X11 server included with
1.110 hubertf 1356: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1357: </li>
1.128 wiz 1358: <li class="listitem">
1.75 rillig 1359: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1360: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1361: Win32 applications, it does not currently support various X11
1362: protocol extensions for acceleration (such as MIT-SHM or DGA).
1363: Most interactive applications to a local X server will run
1364: reasonably fast, but full motion video and other graphics
1365: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1366: </li>
1.128 wiz 1367: <li class="listitem">
1.75 rillig 1368: <p><span class="strong"><strong>Audio:</strong></span></p>
1369: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1370: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1371: audio system on Interix. Unlike on most platforms, the
1.189 snj 1372: <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 1373: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1374: server component. To output audio via an Interix host, the
1.189 snj 1375: <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 1376: must also be installed.</p>
1.75 rillig 1377: </li>
1.128 wiz 1378: <li class="listitem">
1.75 rillig 1379: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1380: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1381: is not currently possible to access CD/DVD drives, USB devices,
1382: or SCSI devices through non-filesystem means. Among other things,
1383: this makes it impossible to use Interix directly for CD/DVD
1384: burning.</p>
1.75 rillig 1385: </li>
1.128 wiz 1386: <li class="listitem">
1.75 rillig 1387: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1388: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1389: drives are also not directly accessible in Interix. However,
1390: support is in work to make tape drive access possible by using
1391: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1392: esound server).</p>
1.75 rillig 1393: </li>
1394: </ul></div>
1395: </div>
1.148 asau 1396: <div class="sect3">
1.75 rillig 1397: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1398: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1399: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1400: Windows system; any member of the local Administrators group will
1401: suffice. However, some packages currently assume that the user
1402: named "root" is the privileged user. To accommodate these, you
1403: may create such a user; make sure it is in the local group
1404: Administrators (or your language equivalent).</p>
1.110 hubertf 1405: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1406: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1407: time being, install packages as the local Administrator (or
1408: your language equivalent), or run the following command after
1409: installing a package to work around the issue:</p>
1.75 rillig 1410: <pre class="screen">
1.87 wiz 1411: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1412: </pre>
1.75 rillig 1413: </div>
1414: </div>
1.148 asau 1415: <div class="sect2">
1.75 rillig 1416: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1417: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75 rillig 1418: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1419: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1420: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1421: 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 1422: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.189 snj 1423: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87 wiz 1424: etc.</p>
1.86 schwarz 1425: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1426: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1427: you start out using "abi=n32", that's what all your packages will be built
1428: with.</p>
1429: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1430: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1431: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1432: try to link n32 object files with lib64 or vice versa. Check your
1433: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1434: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1435: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1436: as it appears that IRIX linker occasionally runs into issues when trying to
1437: link over a network-mounted file system.</p>
1.75 rillig 1438: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1439: as imake(1), but you may want to set some options depending on your local
1440: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1441: course, your compiler's man pages for details.</p>
1.75 rillig 1442: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1443:
1.87 wiz 1444: </p>
1.75 rillig 1445: <pre class="programlisting">
1.100 rillig 1446: PKGSRC_COMPILER= mipspro
1.87 wiz 1447: </pre>
1.75 rillig 1448: <p>
1.1 grant 1449:
1.110 hubertf 1450: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1451: are using gcc and may end up passing invalid flags to the compiler. Note that
1452: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1453: default.</p>
1.75 rillig 1454: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1455: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1456: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1457: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1458: '--preserve-path' flag.</p>
1.75 rillig 1459: </div>
1.148 asau 1460: <div class="sect2">
1.75 rillig 1461: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1462: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87 wiz 1463: <p>Some versions of Linux (for example Debian GNU/Linux) need
1464: either libtermcap or libcurses (libncurses). Installing the
1465: distributions libncurses-dev package (or equivalent) should fix
1466: the problem.</p>
1467: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1468: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1469: i386 have been tested.</p>
1.75 rillig 1470: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1471: directory:</p>
1.75 rillig 1472: <pre class="programlisting">
1.138 wiz 1473: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1474: </pre>
1.148 asau 1475: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1476: <h3 class="title">Note</h3>
1.138 wiz 1477: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1478: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1479: <p>For icc 10.1 neither of these appears to be necessary.</p>
1480: </div>
1481: <p>Use a value for ICCBASE that corresponds to the directory
1482: where icc is installed. After bootstrapping, set
1483: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137 wiz 1484: <pre class="programlisting">
1.138 wiz 1485: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1486: </pre>
1.138 wiz 1487: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1488: <code class="filename">/opt/intel_cc_80</code>. This is the default
1489: install directory for icc 8.0. If you are using a more recent
1490: version, be sure to set the correct path explicitly.
1491: </p>
1.75 rillig 1492: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1493: provided by icc, so binaries can be run on other systems which do not
1494: have the shared libraries installed.</p>
1495: <p>Libtool, however, extracts a list of libraries from the
1.189 snj 1496: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87 wiz 1497: records it, throwing away the -Bstatic and -Bdynamic options
1498: interspersed between the libraries. This means that
1499: libtool-linked C++ shared libraries will have a runtime
1500: dependency on the icc libraries until this is fixed in
1501: libtool.</p>
1.75 rillig 1502: </div>
1.148 asau 1503: <div class="sect2">
1.75 rillig 1504: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1505: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163 bsiegert 1506: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1507: Older versions might also work. Releases before #10 are not
1508: supported.</p>
1509: <p>The package tools of the (older) native ports tree,
1510: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1511: have the same names as the ones used by pkgsrc. Care should be taken
1512: that the right tools are used. When installing packages from source,
1513: use the <code class="filename">bmake</code> command for pkgsrc and
1514: <code class="filename">mmake</code> for MirPorts.</p>
1515: <p>pkgsrc and MirPorts use the same location for the package
1516: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1517: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1518: tree is self-contained. This is also the default setting used in the
1519: binary package builds.</p>
1520: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1521: server. The bootstrap kit there already contains the
1522: <span class="command"><strong>pkgin</strong></span> package manager. See the
1523: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1524: page for more details.</p>
1525: </div>
1526: <div class="sect2">
1527: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1528: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136 dholland 1529: <p>OpenBSD 5.1 has been tested and supported,
1530: other versions may work.</p>
1.75 rillig 1531: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1532: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1533: <div class="orderedlist"><ol class="orderedlist" type="1">
1534: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1535: <code class="filename">/var/db/pkg</code>. It is therefore
1536: recommended that you choose a different location (e.g.
1537: <code class="filename">/usr/pkgdb</code>) by
1538: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1539: <li class="listitem">
1.75 rillig 1540: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1541: good idea to move them out of the way to avoid confusion, e.g.</p>
1542: <pre class="screen">
1543: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1544: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1545: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1546: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1547: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1548: </pre>
1.75 rillig 1549: </li>
1.128 wiz 1550: <li class="listitem">
1.110 hubertf 1551: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1552: <code class="filename">/etc/mk.conf.example</code> file
1553: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1554: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1555: as well. You can work around this by enclosing all the pkgsrc-specific parts
1556: of the file with:</p>
1557: <pre class="programlisting">
1.100 rillig 1558: .ifdef BSD_PKG_MK
1559: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1560: .else
1561: # OpenBSD stuff
1562: .endif
1.87 wiz 1563: </pre>
1.75 rillig 1564: </li>
1565: </ol></div>
1566: </div>
1.148 asau 1567: <div class="sect2">
1.75 rillig 1568: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1569: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142 wiz 1570: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1571: You will need a working C compiler. Both gcc 4.5.3 and
1.87 wiz 1572: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1573: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1574: process and to build packages.</p>
1.148 asau 1575: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1576: <li class="listitem"><p>SUNWsprot</p></li>
1577: <li class="listitem"><p>SUNWarc</p></li>
1578: <li class="listitem"><p>SUNWbtool</p></li>
1579: <li class="listitem"><p>SUNWtoo</p></li>
1580: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1581: </ul></div>
1.78 rillig 1582: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1583: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1584: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1585: your $prefix are in your <code class="varname">PATH</code>. This includes
1586: <code class="filename">/usr/ccs/{bin,lib}</code>
1587: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148 asau 1588: <div class="sect3">
1.75 rillig 1589: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1590: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1591: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1592: for building all packages.</p>
1.75 rillig 1593: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1594: then either build gcc from
1.189 snj 1595: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.87 wiz 1596: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1597: <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 1598: </div>
1.148 asau 1599: <div class="sect3">
1.75 rillig 1600: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1601: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1602: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1603: 5.0)</p>
1.148 asau 1604: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1605: <li class="listitem"><p>SPROcc
1.87 wiz 1606: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1607: <li class="listitem"><p>SPROcpl
1.87 wiz 1608: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1609: <li class="listitem"><p>SPROild
1.87 wiz 1610: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1611: <li class="listitem"><p>SPROlang
1.87 wiz 1612: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1613: </ul></div>
1.96 rillig 1614: <p>You should set the following variables in your
1.110 hubertf 1615: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1616: <pre class="programlisting">
1.100 rillig 1617: CC= cc
1618: CXX= CC
1619: CPP= cc -E
1620: CXXCPP= CC -E
1.96 rillig 1621: </pre>
1.148 asau 1622: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1623: <h3 class="title">Note</h3>
1624: <p>The <code class="varname">CPP</code> setting might break some
1625: packages that use the C preprocessor for processing things other
1626: than C source code.</p>
1627: </div>
1.75 rillig 1628: </div>
1.148 asau 1629: <div class="sect3">
1.75 rillig 1630: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1631: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1632: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1633: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1634: <pre class="programlisting">
1.100 rillig 1635: PKGSRC_COMPILER= sunpro
1636: ABI= 64
1.96 rillig 1637: </pre>
1.148 asau 1638: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1639: <h3 class="title">Note</h3>
1640: <p>This setting has been tested for the SPARC
1641: architecture. Intel and AMD machines need some more
1642: work.</p>
1643: </div>
1.75 rillig 1644: </div>
1.148 asau 1645: <div class="sect3">
1.75 rillig 1646: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1647: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110 hubertf 1648: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1649: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1650: The workaround is to use another shell for the configure
1.189 snj 1651: 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 1652: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1653: <pre class="programlisting">
1.100 rillig 1654: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1655: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1656: </pre>
1.189 snj 1657: <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 1658: </div>
1659: </div>
1660: </div>
1661: </div>
1.148 asau 1662: <div class="chapter">
1.75 rillig 1663: <div class="titlepage"><div><div><h2 class="title">
1664: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1665: <div class="toc">
1666: <p><b>Table of Contents</b></p>
1.195 wiz 1667: <dl class="toc">
1.75 rillig 1668: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1669: <dd><dl>
1670: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1671: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1672: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1673: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1674: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1675: <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>
1676: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1677: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1678: </dl></dd>
1679: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1680: <dd><dl>
1681: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1682: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1683: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1684: </dl></dd>
1685: </dl>
1686: </div>
1687: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1688: is to only install the package tools and to use binary packages
1.128 wiz 1689: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1690: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1691: of pkgsrc, too. Then you are able to build your own packages,
1692: and you can still use binary packages from someone else.</p>
1.148 asau 1693: <div class="sect1">
1.75 rillig 1694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1695: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1696: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1697: server and its mirrors, there are collections of binary packages,
1698: ready to be installed. These binary packages have been built using the
1699: default settings for the directories, that is:</p>
1.148 asau 1700: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1701: <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>
1702: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1703: <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 1704: </ul></div>
1705: <p>If you cannot use these directories for whatever reasons (maybe
1706: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1707: 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.148 asau 1708: <div class="sect2">
1.75 rillig 1709: <div class="titlepage"><div><div><h3 class="title">
1710: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1711: <p>To install binary packages, you first need to know from where
1712: to get them. The first place where you should look is on the main
1.110 hubertf 1713: 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 1714: <p>This directory contains binary packages for multiple
1715: platforms. First, select your operating system. (Ignore the
1716: directories with version numbers attached to it, they just exist for
1717: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1718: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1719: <p>In this directory, you often find a file called
1720: <code class="filename">bootstrap.tar.gz</code> which contains the package
1721: management tools. If the file is missing, it is likely that your
1722: operating system already provides those tools. Download the file and
1723: extract it in the <code class="filename">/</code> directory. It will create
1724: the directories <code class="filename">/usr/pkg</code> (containing the tools
1725: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1726: (the database of installed packages).</p>
1.75 rillig 1727: </div>
1.148 asau 1728: <div class="sect2">
1.75 rillig 1729: <div class="titlepage"><div><div><h3 class="title">
1730: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1731: <p>In the directory from the last section, there is a
1.196 wiz 1732: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1733: binary packages that are available for the platform, excluding those
1734: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1735: medium you are using).</p>
1.109 rillig 1736: <p>To install packages directly from an FTP or HTTP server, run
1737: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1738: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1739: <pre class="screen">
1740: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196 wiz 1741: <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>
1.109 rillig 1742: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1743: </pre>
1744: <p>Instead of URLs, you can also use local paths, for example if
1745: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1746: repository. If you want to install packages from multiple sources,
1747: you can separate them by a semicolon in
1748: <code class="varname">PKG_PATH</code>.</p>
1749: <p>After these preparations, installing a package is very
1750: easy:</p>
1751: <pre class="screen">
1752: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1753: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1754: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1755: </pre>
1.75 rillig 1756: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1757: package in question will be installed, too, assuming they are
1758: present where you install from.</p>
1.128 wiz 1759: <p>Adding packages might install vulnerable packages.
1760: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1761: regularly, especially after installing new packages, and verify
1762: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1763: <p>After you've installed packages, be sure to have
1.88 wiz 1764: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1765: <code class="varname">PATH</code> so you can actually start the just
1766: installed program.</p>
1.75 rillig 1767: </div>
1.148 asau 1768: <div class="sect2">
1.75 rillig 1769: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1770: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1771: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1772: installed from source code or from a binary package. The
1.110 hubertf 1773: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1774: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1775: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1776: name can be given with or without version number. Wildcards can
1777: also be used to deinstall a set of packages, for example
1778: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1779: so that the shell does not expand them before
1780: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1781: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1782: removes all the packages that require the package in question
1783: and then removes the package itself. For example:
1.82 rillig 1784:
1.88 wiz 1785: </p>
1.82 rillig 1786: <pre class="screen">
1.88 wiz 1787: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1788: </pre>
1.82 rillig 1789: <p>
1790:
1.88 wiz 1791: will remove jpeg and all the packages that used it; this allows
1792: upgrading the jpeg package.</p>
1.82 rillig 1793: </div>
1.148 asau 1794: <div class="sect2">
1.82 rillig 1795: <div class="titlepage"><div><div><h3 class="title">
1796: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1797: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1798: installed packages or binary package files.</p>
1.82 rillig 1799: </div>
1.148 asau 1800: <div class="sect2">
1.82 rillig 1801: <div class="titlepage"><div><div><h3 class="title">
1802: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1803: <p>
1.88 wiz 1804: The NetBSD Security-Officer and Packages Groups maintain a list of
1805: known security vulnerabilities to packages which are (or have been)
1806: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1807: 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 1808: </p>
1.82 rillig 1809: <p>
1.125 wiz 1810: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1811: this list can be downloaded
1812: automatically, and a security audit of all packages installed on a system
1813: can take place.
1814: </p>
1.82 rillig 1815: <p>
1.125 wiz 1816: There are two components to auditing. The first
1817: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1818: is for downloading
1.88 wiz 1819: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1820: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1821: installed packages are vulnerable. If a package is vulnerable, you
1822: will see output similar to the following:
1823: </p>
1.82 rillig 1824: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1825: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1826: <p>
1.125 wiz 1827: You may wish to have the
1.110 hubertf 1828: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1829: file downloaded daily so that
1830: it remains current. This may be done by adding an appropriate entry
1.189 snj 1831: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1832: </p>
1833: <pre class="screen">
1834: # download vulnerabilities file
1835: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1836: </pre>
1837: <p>
1838: will update the vulnerability list every day at 3AM. You may wish to do
1839: this more often than once a day.
1840:
1841: In addition, you may wish to run the package audit from the daily
1842: security script. This may be accomplished by adding the following
1843: line to <code class="filename">/etc/security.local</code>:
1844: </p>
1845: <pre class="screen">
1846: /usr/sbin/pkg_admin audit
1847: </pre>
1848: <p>
1.88 wiz 1849: </p>
1.82 rillig 1850: </div>
1.148 asau 1851: <div class="sect2">
1.82 rillig 1852: <div class="titlepage"><div><div><h3 class="title">
1853: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1854: <p>
1.189 snj 1855: 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 1856: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1857: argument to check if your packages are up-to-date, e.g.
1858: </p>
1859: <pre class="screen">
1860: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1861: ...
1.88 wiz 1862: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1863: </pre>
1.110 hubertf 1864: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1865: package on your system and rebuild any dependencies.
1866: </p>
1.82 rillig 1867: </div>
1.148 asau 1868: <div class="sect2">
1.82 rillig 1869: <div class="titlepage"><div><div><h3 class="title">
1870: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1871: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1872: administrative functions on the package system.</p>
1.82 rillig 1873: </div>
1.148 asau 1874: <div class="sect2">
1.82 rillig 1875: <div class="titlepage"><div><div><h3 class="title">
1876: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1877: <p>Please pay very careful attention to the warnings
1.189 snj 1878: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88 wiz 1879: inherent dangers of installing binary packages which you did
1880: not create yourself, and the security holes that can be
1881: introduced onto your system by indiscriminate adding of such
1882: files.</p>
1.75 rillig 1883: <p>The same warning of course applies to every package you
1.88 wiz 1884: install from source when you haven't completely read and
1885: understood the source code of the package, the compiler that
1886: is used to build the package and all the other tools that are
1887: involved.</p>
1.75 rillig 1888: </div>
1889: </div>
1.148 asau 1890: <div class="sect1">
1.75 rillig 1891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1892: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1893: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1894: directory now contains a set of packages, organized into
1895: categories. You can browse the online index of packages, or run
1.110 hubertf 1896: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1897: directory to build local <code class="filename">README.html</code> files for
1.189 snj 1898: 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 1899: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1900: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1901: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1902: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1903: different <code class="varname">LOCALBASE</code> definitions on the same
1904: system (inside a chroot is an exception). </p>
1905: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1906: 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 1907: instructions how to create your own packages.</p>
1.148 asau 1908: <div class="sect2">
1.75 rillig 1909: <div class="titlepage"><div><div><h3 class="title">
1910: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1911: <p>To build packages from source, you need a working C
1.88 wiz 1912: compiler. On NetBSD, you need to install the
1.128 wiz 1913: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1914: sets. If you want to build X11-related packages, the
1.128 wiz 1915: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1916: sets are required, too.</p>
1.75 rillig 1917: </div>
1.148 asau 1918: <div class="sect2">
1.75 rillig 1919: <div class="titlepage"><div><div><h3 class="title">
1920: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1921: <p>The first step for building a package is downloading the
1.88 wiz 1922: distfiles (i.e. the unmodified source). If they have not yet been
1923: downloaded, pkgsrc will fetch them automatically.</p>
1924: <p>If you have all files that you need in the
1925: <code class="filename">distfiles</code> directory,
1926: you don't need to connect. If the distfiles are on CD-ROM, you can
1927: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1928: </p>
1.82 rillig 1929: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1930: <p>
1.110 hubertf 1931: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1932: <p>By default a list of distribution sites will be randomly
1933: intermixed to prevent huge load on servers which holding popular
1934: packages (for example, SourceForge.net mirrors). Thus, every
1935: time when you need to fetch yet another distfile all the mirrors
1936: will be tried in new (random) order. You can turn this feature
1937: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1938: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1939: <p>You can overwrite some of the major distribution sites to
1940: fit to sites that are close to your own. By setting one or two
1941: variables you can modify the order in which the master sites are
1942: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1943: delimited list of domain suffixes.
1944: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1945: contains a whitespace delimited list of regular expressions. It
1946: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1947: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1948: some examples. This may save some of your bandwidth and
1949: time.</p>
1.75 rillig 1950: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1951: if you want to keep the settings, by editing the
1.110 hubertf 1952: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1953: and adding the definitions there.</p>
1.82 rillig 1954: <p>
1.88 wiz 1955: If a package depends on many other packages (such as
1.189 snj 1956: <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 1957: alternate between periods of
1958: downloading source, and compiling. To ensure you have all the source
1959: downloaded initially you can run the command:
1960: </p>
1.82 rillig 1961: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1962: <p>
1.88 wiz 1963: which will output and run a set of shell commands to fetch the
1964: necessary files into the <code class="filename">distfiles</code> directory. You can
1965: also choose to download the files manually.
1966: </p>
1.75 rillig 1967: </div>
1.148 asau 1968: <div class="sect2">
1.75 rillig 1969: <div class="titlepage"><div><div><h3 class="title">
1970: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1971: <p>
1.88 wiz 1972: Once the software has downloaded, any patches will be applied, then it
1973: will be compiled for you. This may take some time depending on your
1974: computer, and how many other packages the software depends on and their
1975: compile time.
1976: </p>
1.148 asau 1977: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1978: <h3 class="title">Note</h3>
1979: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1980: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1981: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1982: </div>
1.87 wiz 1983: <p>For example, type</p>
1.88 wiz 1984: <pre class="screen">
1985: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1986: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1987: </pre>
1.75 rillig 1988: <p>at the shell prompt to build the various components of the
1.88 wiz 1989: package.</p>
1.82 rillig 1990: <p>The next stage is to actually install the newly compiled
1.88 wiz 1991: program onto your system. Do this by entering:
1.82 rillig 1992:
1.88 wiz 1993: </p>
1.82 rillig 1994: <pre class="screen">
1.88 wiz 1995: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1996: </pre>
1.82 rillig 1997: <p>
1998:
1.88 wiz 1999: while you are still in the directory for whatever package you
2000: are installing.</p>
1.82 rillig 2001: <p>Installing the package on your system may require you to
1.88 wiz 2002: be root. However, pkgsrc has a
2003: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2004: to only become root for the actual installation step.</p>
1.82 rillig 2005: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2006: You can now enter:
1.82 rillig 2007:
1.88 wiz 2008: </p>
1.82 rillig 2009: <pre class="screen">
1.88 wiz 2010: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2011: </pre>
1.82 rillig 2012: <p>
2013:
1.88 wiz 2014: to remove the compiled files in the work directory, as you shouldn't need
2015: them any more. If other packages were also added to your system
2016: (dependencies) to allow your program to compile, you can tidy these up
2017: also with the command:</p>
1.82 rillig 2018: <pre class="screen">
1.88 wiz 2019: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2020: </pre>
1.75 rillig 2021: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2022: 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 2023: <p>The program is installed under the default root of the
2024: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2025: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2026: variable in your environment, and it will use that value as the
2027: root of your packages tree. So, to use
2028: <code class="filename">/usr/local</code>, set
2029: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2030: Please note that you should use a directory which is dedicated to
2031: packages and not shared with other programs (i.e., do not try and
2032: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2033: to add any of your own files or directories (such as
2034: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2035: <code class="filename">pkgsrc/</code>) below the
2036: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2037: conflicts between programs and other files installed by the
2038: package system and whatever else may have been installed
2039: there.</p>
1.110 hubertf 2040: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2041: alter some configuration options at build time. Have a look at
2042: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2043: of what will be set there by default. Environment variables such
2044: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2045: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2046: set them each time you want to use pkgsrc.</p>
1.128 wiz 2047: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2048: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 2049: or being installed. This may be for debugging purposes, or out of
2050: simple curiosity. A number of utility values have been added to
2051: help with this.</p>
1.128 wiz 2052: <div class="orderedlist"><ol class="orderedlist" type="1">
2053: <li class="listitem">
1.189 snj 2054: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 2055: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2056: information will be displayed. For example,</p>
1.75 rillig 2057: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2058: <p>will show all the commands that are invoked, up to and
1.128 wiz 2059: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 2060: </li>
1.128 wiz 2061: <li class="listitem">
1.189 snj 2062: <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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2063: definition, then the <code class="varname">VARNAME</code> definition
2064: should be used, in conjunction with the show-var
1.189 snj 2065: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2066: variable <code class="varname">LOCALBASE</code>:</p>
2067: <pre class="screen">
2068: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2069: /usr/pkg
2070: <code class="prompt">%</code>
1.88 wiz 2071: </pre>
1.75 rillig 2072: </li>
2073: </ol></div>
2074: <p>If you want to install a binary package that you've either
1.88 wiz 2075: created yourself (see next section), that you put into
2076: pkgsrc/packages manually or that is located on a remote FTP
2077: server, you can use the "bin-install" target. This target will
1.189 snj 2078: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 2079: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2080: sites searched is kept in the variable
2081: <code class="varname">BINPKG_SITES</code>, which defaults to
1.189 snj 2082: 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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 2083: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2084: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2085: details.</p>
2086: <p>A final word of warning: If you set up a system that has a
2087: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2088: set that before any packages are installed, as you cannot use
2089: several directories for the same purpose. Doing so will result in
2090: pkgsrc not being able to properly detect your installed packages,
2091: and fail miserably. Note also that precompiled binary packages are
2092: usually built with the default <code class="varname">LOCALBASE</code> of
2093: <code class="filename">/usr/pkg</code>, and that you should
2094: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2095: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2096: </div>
2097: </div>
2098: </div>
1.148 asau 2099: <div class="chapter">
1.75 rillig 2100: <div class="titlepage"><div><div><h2 class="title">
2101: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2102: <div class="toc">
2103: <p><b>Table of Contents</b></p>
1.195 wiz 2104: <dl class="toc">
1.75 rillig 2105: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2106: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2107: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2108: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2109: <dd><dl>
1.103 wiz 2110: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2111: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2112: <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 2113: </dl></dd>
1.103 wiz 2114: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2115: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2116: </dl>
2117: </div>
1.104 rillig 2118: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2119: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2120: that file depends on the installation. On NetBSD, when you use
1.189 snj 2121: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 2122: <code class="filename">/etc/</code>. In all other cases the default location is
2123: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2124: bootstrap program to install the binary packages.</p>
2125: <p>During the bootstrap, an example configuration file is created. To
2126: use that, you have to create the directory
2127: <code class="filename">${PREFIX}/etc</code> and copy the example file
2128: there.</p>
2129: <p>The format of the configuration file is that of the usual
2130: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2131: is done by setting variables in this file. Note that you can define all
2132: kinds of variables, and no special error checking (for example for
2133: spelling mistakes) takes place, so you have to try it out to see if it
2134: works.</p>
1.148 asau 2135: <div class="sect1">
1.75 rillig 2136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2137: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2138: <p>In this section, you can find some variables that apply to all
1.89 rillig 2139: pkgsrc packages. A complete list of the variables that can be
2140: configured by the user is available in
2141: <code class="filename">mk/defaults/mk.conf</code>, together with some
2142: comments that describe each variable's intent.</p>
1.148 asau 2143: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2144: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2145: packages will be installed. The default is
1.76 rillig 2146: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2147: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2148: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2149: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2150: installed. The default is
1.76 rillig 2151: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2152: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2153: X11 is installed on the system. The default is
1.194 bsiegert 2154: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 2155: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2156: downloaded copies of the original source distributions used
2157: for building pkgsrc packages. The default is
1.76 rillig 2158: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2159: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2160: database about installed packages is stored. The default is
2161: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2162: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2163: If set, override the packages'
2164: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2165: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2166: Backup location(s) for distribution files and patch files
2167: if not found locally or in
1.76 rillig 2168: <code class="filename">${MASTER_SITES}</code> or
2169: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2170: The defaults are
1.132 spz 2171: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2172: and
1.76 rillig 2173: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2174: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2175: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2176: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2177: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2178: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2179: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2180: List of acceptable licenses. License names are case-sensitive.
2181: Whenever you try to build a package whose license is not in this
2182: list, you will get an error message. If the license condition is
2183: simple enough, the error message will include specific
2184: instructions on how to change this variable.</p></li>
1.75 rillig 2185: </ul></div>
2186: </div>
1.148 asau 2187: <div class="sect1">
1.75 rillig 2188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2189: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2190: <p>XXX
2191: </p>
1.148 asau 2192: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2193: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2194: directory for the binary packages. The default is
1.76 rillig 2195: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2196: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2197: The top level directory where, if defined, the separate
2198: working directories will get created, and symbolically
1.76 rillig 2199: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2200: This is useful for building packages on several
1.76 rillig 2201: architectures, then <code class="filename">${PKGSRCDIR}</code>
2202: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2203: is local to every architecture. (It should be noted that
2204: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2205: — it is an internal definition which refers to the
1.75 rillig 2206: root of the pkgsrc tree. It is possible to have many
2207: pkgsrc tree instances.)</p></li>
1.128 wiz 2208: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2209: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2210: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2211: information.</p></li>
1.128 wiz 2212: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2213: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2214: BSD-style Makefile. If this is not set,
2215: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2216: <code class="filename">/dev/null</code> to avoid picking up
2217: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2218: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2219: By default, dependencies are only installed, and no binary
2220: package is created for them. You can set this variable to
1.174 asau 2221: <code class="literal">package-install</code> to automatically create binary
1.190 wiz 2222: packages after installing dependencies. Please note that the
1.194 bsiegert 2223: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.190 wiz 2224: <code class="literal">yes</code> to preserve binary packages when
2225: using the <code class="literal">install</code> as well.</p></li>
1.75 rillig 2226: </ul></div>
2227: </div>
1.148 asau 2228: <div class="sect1">
1.75 rillig 2229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2230: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2231: <p>Most packages support installation into a
1.103 wiz 2232: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2233: to be built, before the actual filesystem is touched. DESTDIR
2234: support exists in two variations:</p>
1.148 asau 2235: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2236: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 2237: installation and packaging is still run as root.</p></li>
2238: <li class="listitem"><p>Full DESTDIR support can run the complete
2239: build, installation and packaging as normal user. Root
2240: privileges are only needed to add packages.</p></li>
2241: </ul></div>
2242: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2243: you can set
2244: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2245: so it's preferable to convert a package to DESTDIR instead.</p>
1.103 wiz 2246: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2247: clean</code></strong> needs to be run as root.</p>
1.118 imil 2248: <p>Considering the <code class="filename">foo/bar</code> package,
2249: DESTDIR full support can be tested using the following commands
2250:
2251: </p>
2252: <pre class="programlisting">
2253: <code class="prompt">$</code> id
2254: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2255: <code class="prompt">$</code> mkdir $HOME/packages
2256: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2257: </pre>
2258: <p>
2259:
2260: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2261: should be needed
2262:
2263: </p>
2264: <pre class="programlisting">
1.174 asau 2265: <code class="prompt">$</code> make stage-install
1.118 imil 2266: </pre>
2267: <p>
2268:
2269: Create a package without root privileges
2270:
2271: </p>
2272: <pre class="programlisting">
1.174 asau 2273: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 2274: </pre>
2275: <p>
2276:
2277: For the following command, you must be able to gain root
1.189 snj 2278: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 2279:
2280: </p>
2281: <pre class="programlisting">
1.174 asau 2282: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 2283: </pre>
2284: <p>
2285:
2286: Then, as a simple user
2287:
2288: </p>
2289: <pre class="programlisting">
2290: <code class="prompt">$</code> make clean
2291: </pre>
2292: <p>
2293:
2294: </p>
1.103 wiz 2295: </div>
1.148 asau 2296: <div class="sect1">
1.103 wiz 2297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2298: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 2299: <div class="sect2">
1.78 rillig 2300: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2301: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2302: <p>By default, pkgsrc will use GCC to build packages. This may be
2303: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 2304: <div class="variablelist"><dl class="variablelist">
1.89 rillig 2305: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2306: <dd>
2307: <p>This is a list of values specifying the chain of
2308: compilers to invoke when building packages. Valid values
2309: are:</p>
1.148 asau 2310: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 2311: <li class="listitem"><p><code class="varname">ccc</code>:
2312: Compaq C Compilers (Tru64)</p></li>
2313: <li class="listitem"><p><code class="varname">ccache</code>:
2314: compiler cache (chainable)</p></li>
2315: <li class="listitem"><p><code class="varname">clang</code>:
2316: Clang C and Objective-C compiler</p></li>
1.128 wiz 2317: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2318: distributed C/C++ (chainable)</p></li>
1.174 asau 2319: <li class="listitem"><p><code class="varname">f2c</code>:
2320: Fortran 77 to C compiler (chainable)</p></li>
2321: <li class="listitem"><p><code class="varname">icc</code>:
2322: Intel C++ Compiler (Linux)</p></li>
2323: <li class="listitem"><p><code class="varname">ido</code>:
2324: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 2325: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2326: GNU C/C++ Compiler</p></li>
1.174 asau 2327: <li class="listitem"><p><code class="varname">hp</code>:
2328: HP-UX C/aC++ compilers</p></li>
1.128 wiz 2329: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2330: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 2331: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 2332: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2333: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2334: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 2335: <li class="listitem"><p><code class="varname">xlc</code>:
2336: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89 rillig 2337: </ul></div>
2338: <p>The default is
1.128 wiz 2339: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2340: <code class="varname">ccache</code> and/or
2341: <code class="varname">distcc</code> with an appropriate
2342: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2343: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2344: variable should always be terminated with a value for
2345: a real compiler. Note that only one real compiler
1.128 wiz 2346: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2347: is not allowed).</p>
1.89 rillig 2348: </dd>
2349: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2350: <dd><p>This specifies the minimum version of GCC to use
2351: when building packages. If the system GCC doesn't
2352: satisfy this requirement, then pkgsrc will build and
2353: install one of the GCC packages to use instead.</p></dd>
2354: </dl></div>
2355: </div>
1.148 asau 2356: <div class="sect2">
1.89 rillig 2357: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2358: <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 2359: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2360: please make sure to use the <code class="literal">+=</code> operator
2361: instead of the <code class="literal">=</code> operator:</p>
2362: <pre class="programlisting">
1.100 rillig 2363: CFLAGS+= -your -flags
1.78 rillig 2364: </pre>
2365: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2366: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2367: need to add their own flags. You may want to take a look
1.189 snj 2368: 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 2369: package if you're interested in optimization specifically
2370: for the current CPU. </p>
1.78 rillig 2371: </div>
1.148 asau 2372: <div class="sect2">
1.88 wiz 2373: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2374: <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 2375: <p>If you want to pass flags to the linker, both in the configure
2376: step and the build step, you can do this in two ways. Either set
2377: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2378: between the two is that <code class="varname">LIBS</code> will be appended to
2379: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2380: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2381: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2382: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2383: <code class="varname">CFLAGS</code>, if you do not wish to override these
2384: settings, use the <code class="literal">+=</code> operator:</p>
2385: <pre class="programlisting">
1.100 rillig 2386: LDFLAGS+= -your -linkerflags
1.88 wiz 2387: </pre>
2388: </div>
1.78 rillig 2389: </div>
1.148 asau 2390: <div class="sect1">
1.78 rillig 2391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2392: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 2393: <p>
1.75 rillig 2394: </p>
1.148 asau 2395: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2396: <li class="listitem">
1.75 rillig 2397: <p><code class="varname">PKG_DEVELOPER</code>:
2398: Run some sanity checks that package developers want:
2399: </p>
1.148 asau 2400: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2401: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2402: fuzz</p></li>
1.128 wiz 2403: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2404: binaries will find their shared libs.</p></li>
1.75 rillig 2405: </ul></div>
2406: <p>
1.87 wiz 2407: </p>
1.75 rillig 2408: </li>
1.128 wiz 2409: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2410: of debugging output which is displayed whilst making and
2411: installing the package. The default value for this is 0,
2412: which will not display the commands as they are executed
2413: (normal, default, quiet operation); the value 1 will display
2414: all shell commands before their invocation, and the value 2
2415: will display both the shell commands before their invocation,
1.110 hubertf 2416: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2417: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2418: </ul></div>
2419: <p>
2420: </p>
2421: </div>
1.148 asau 2422: <div class="sect1">
1.75 rillig 2423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2424: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2425: <p>Some packages have build time options, usually to select
2426: between different dependencies, enable optional support for big
2427: dependencies or enable experimental features.</p>
1.75 rillig 2428: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2429: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2430: show-options</strong></span>, for example:</p>
1.75 rillig 2431: <pre class="programlisting">
2432: The following options are supported by this package:
2433: ssl Enable SSL support.
2434: Exactly one of the following gecko options is required:
2435: firefox Use firefox as gecko rendering engine.
2436: mozilla Use mozilla as gecko rendering engine.
2437: At most one of the following database options may be selected:
2438: mysql Enable support for MySQL database.
2439: pgsql Enable support for PostgreSQL database.
1.1 grant 2440:
1.75 rillig 2441: These options are enabled by default: firefox
2442: These options are currently enabled: mozilla ssl
1.1 grant 2443: </pre>
1.75 rillig 2444: <p>The following variables can be defined in
1.110 hubertf 2445: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2446: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2447: which can be used to select or disable options for all packages
2448: that support them, and
2449: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2450: which can be used to select or disable options specifically for
2451: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2452: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2453: are disabled. A few examples:</p>
1.75 rillig 2454: <pre class="screen">
1.110 hubertf 2455: <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 2456: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2457: PKG_OPTIONS.kdebase= debug -sasl
2458: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2459: <p>It is important to note that options that were specifically
1.120 snj 2460: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2461: you do not wish to include the option. If you are unsure you can view
2462: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2463: <p>The following settings are consulted in the order given, and
2464: the last setting that selects or disables an option is
2465: used:</p>
1.128 wiz 2466: <div class="orderedlist"><ol class="orderedlist" type="1">
2467: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2468: maintainer</p></li>
1.128 wiz 2469: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2470: variables (see below)</p></li>
1.128 wiz 2471: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2472: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2473: </ol></div>
2474: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2475: selected is used, all others are automatically disabled. If an
2476: option of the group is explicitly disabled, the previously
2477: selected option, if any, is used. It is an error if no option
2478: from a required group of options is selected, and building the
2479: package will fail.</p>
2480: <p>Before the options framework was introduced, build options
2481: were selected by setting a variable (often named
2482: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2483: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2484: transition to the options framework for the user, these legacy
2485: variables are converted to the appropriate options setting
2486: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2487: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2488: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2489: directly. Support for the legacy variables will be removed
2490: eventually.</p>
1.75 rillig 2491: </div>
2492: </div>
1.148 asau 2493: <div class="chapter">
1.75 rillig 2494: <div class="titlepage"><div><div><h2 class="title">
2495: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2496: <div class="toc">
2497: <p><b>Table of Contents</b></p>
1.195 wiz 2498: <dl class="toc">
1.75 rillig 2499: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2500: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2501: </dl>
2502: </div>
1.148 asau 2503: <div class="sect1">
1.75 rillig 2504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2505: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2506: <p>Once you have built and installed a package, you can create
2507: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.189 snj 2508: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2509: the same package on a group of hosts and wasting CPU time. It also
2510: provides a simple means for others to install your package, should
2511: you distribute it.</p>
2512: <p>To create a binary package, change into the appropriate
1.110 hubertf 2513: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2514: package</strong></span>:</p>
2515: <pre class="screen">
2516: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2517: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2518: </pre>
2519: <p>This will build and install your package (if not already done),
2520: and then build a binary package from what was installed. You can
1.110 hubertf 2521: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2522: it. Binary packages are created by default in
2523: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2524: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.189 snj 2525: 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 2526: <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 2527: such a binary package.</p>
1.75 rillig 2528: </div>
1.148 asau 2529: <div class="sect1">
1.75 rillig 2530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2531: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2532: <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 2533: </div>
2534: </div>
1.148 asau 2535: <div class="chapter">
1.106 rillig 2536: <div class="titlepage"><div><div><h2 class="title">
2537: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2538: builds)</h2></div></div></div>
2539: <div class="toc">
2540: <p><b>Table of Contents</b></p>
1.195 wiz 2541: <dl class="toc">
1.180 wiz 2542: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2543: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2544: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2545: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 2546: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2547: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2548: </dl>
2549: </div>
1.180 wiz 2550: <p>For a number of reasons you may want to build binary packages
2551: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2552: For instance, when you have multiple machines that should run the same software,
2553: it is wasted time if they all build their packages themselves from source.
2554: Or you may want to build a list of packages you want and check them before
2555: deploying onto production system.
2556: There is a way of getting a set of binary packages:
1.174 asau 2557: The bulk build system, or pbulk ("p" stands for "parallel).
2558: This chapter describes how to set it up so that the packages
1.106 rillig 2559: are most likely to be usable later.</p>
1.148 asau 2560: <div class="sect1">
1.106 rillig 2561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2562: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2563: <p>First of all, you have to decide whether you build all packages
2564: or a limited set of them. Full bulk builds usually consume a lot more resources,
2565: both space and time, than builds for some practical sets of packages.
2566: There exists a number of particularly heavy packages that are not actually
2567: interesting to a wide audience.
2568:
2569: For a limited bulk builds you need to make a list of packages you want to build.
2570: Note, that all their dependencies will be built, so you don't need to track them manually.
2571: </p>
2572: <p>During bulk builds various packages are installed and deinstalled
2573: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2574: so make sure that you don't need any package during the builds.
2575: Essentially, you should provide fresh system, either a chroot environment
2576: or something even more restrictive, depending on what the operating system provides,
2577: or dedicate the whole physical machine.
2578: As a useful side effect this makes sure that bulk builds cannot
2579: break anything in your system. There have been numerous cases where
1.106 rillig 2580: certain packages tried to install files outside the
2581: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2582: <code class="filename">/etc</code>.
2583: </p>
1.106 rillig 2584: </div>
1.148 asau 2585: <div class="sect1">
1.106 rillig 2586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2587: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2588: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2589: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2590: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2591: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2592: </ul></div>
1.148 asau 2593: <div class="sect2">
1.116 rillig 2594: <div class="titlepage"><div><div><h3 class="title">
1.180 wiz 2595: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.178 asau 2596: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2597: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2598: Configure network access to fetch distribution files.
2599: Create user with name "pbulk".</p>
2600: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2601: <pre class="screen">
1.181 wiz 2602: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && ftp -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2603: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2604: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178 asau 2605: </pre>
2606: <p>Or any other way that fits (e.g., curl, wget).</p>
2607: <p>Deploy and configure pbulk tools, e.g.:</p>
2608: <pre class="screen">
2609: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2610: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
2611: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2612: </pre>
2613: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2614: <h3 class="title">Note</h3>
2615: <p><code class="filename">mk.conf.frag</code> is a fragment of
2616: <code class="filename">mk.conf</code> that contains settings you want to
2617: apply to packages you build. For instance,</p>
2618: <pre class="programlisting">
2619: PKG_DEVELOPER= yes # perform more checks
2620: X11_TYPE= modular # use pkgsrc X11
2621: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2622: </pre>
2623: </div>
2624: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2625: with your list of packages one per line without empty lines or comments. E.g.:</p>
2626: <pre class="programlisting">
2627: www/firefox
2628: mail/thunderbird
2629: misc/libreoffice4
2630: </pre>
1.179 asau 2631: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2632: and make final amendments, if wanted.</p>
1.178 asau 2633: <p>Start it:</p>
2634: <pre class="screen">
2635: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2636: </pre>
2637: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2638: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2639: </p>
2640: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2641: <h3 class="title">Note</h3>
2642: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2643: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2644: The script is kept small enough for better understanding.</p>
2645: </div>
2646: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2647: <h3 class="title">Note</h3>
2648: <p>The <code class="filename">pbulk.sh</code> script supports running
2649: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2650: </div>
1.106 rillig 2651: </div>
2652: </div>
1.148 asau 2653: <div class="sect1">
1.106 rillig 2654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2655: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2656: <p>A complete bulk build requires lots of disk space. Some of the
2657: disk space can be read-only, some other must be writable. Some can be on
2658: remote filesystems (such as NFS) and some should be local. Some can be
2659: temporary filesystems, others must survive a sudden reboot.</p>
2660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2661: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2662: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2663: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2664: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2665: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2666: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2667: </ul></div>
2668: </div>
2669: <div class="sect1">
2670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2671: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2672: <p>After your pkgsrc bulk-build has completed, you may wish to
2673: create a CD-ROM set of the resulting binary packages to assist
2674: in installing packages on other machines. The
1.189 snj 2675: <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 2676: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2677: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2678: way that keeps all the dependencies for a given package on the same
2679: CD as that package.</p>
1.148 asau 2680: <div class="sect2">
1.75 rillig 2681: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2682: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2683: <p>Complete documentation for cdpack is found in the cdpack(1)
2684: man page. The following short example assumes that the binary
2685: packages are left in
2686: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2687: sufficient disk space exists in <code class="filename">/u2</code> to
2688: hold the ISO 9660 images.</p>
2689: <pre class="screen">
2690: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2691: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2692: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2693: </pre>
2694: <p>If you wish to include a common set of files
2695: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2696: etc.) on each CD in the collection, then you need to create a
2697: directory which contains these files. e.g.</p>
2698: <pre class="screen">
2699: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2700: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2701: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2702: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2703: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2704: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2705: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2706: </pre>
1.75 rillig 2707: <p>Now create the images:</p>
2708: <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 2709: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2710: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2711: in their root directories.</p>
1.75 rillig 2712: </div>
2713: </div>
2714: </div>
1.148 asau 2715: <div class="chapter">
1.75 rillig 2716: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2717: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2718: <div class="toc">
2719: <p><b>Table of Contents</b></p>
1.195 wiz 2720: <dl class="toc">
1.128 wiz 2721: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2722: <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 2723: </dl>
2724: </div>
2725: <p>The files that are installed by pkgsrc are organized in a way that
2726: is similar to what you find in the <code class="filename">/usr</code> directory
2727: of the base system. But some details are different. This is because
2728: pkgsrc initially came from FreeBSD and had adopted its file system
2729: hierarchy. Later it was largely influenced by NetBSD. But no matter
2730: which operating system you are using pkgsrc with, you can expect the
2731: same layout for pkgsrc.</p>
1.91 rillig 2732: <p>There are mainly four root directories for pkgsrc, which are all
2733: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2734: When pkgsrc has been installed as root, the default locations
2735: are:</p>
2736: <pre class="programlisting">
1.100 rillig 2737: LOCALBASE= /usr/pkg
2738: PKG_SYSCONFBASE= /usr/pkg/etc
2739: VARBASE= /var
2740: PKG_DBDIR= /var/db/pkg
1.91 rillig 2741: </pre>
2742: <p>In unprivileged mode (when pkgsrc has been installed as any other
2743: user), the default locations are:</p>
2744: <pre class="programlisting">
1.100 rillig 2745: LOCALBASE= ${HOME}/pkg
2746: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2747: VARBASE= ${HOME}/pkg/var
2748: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 2749: </pre>
2750: <p>What these four directories are for, and what they look like is
2751: explained below.</p>
1.148 asau 2752: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2753: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2754: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2755: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2756: the well-known subdirectories like <code class="filename">bin</code>,
2757: <code class="filename">include</code>, <code class="filename">lib</code>,
2758: <code class="filename">share</code> and
2759: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2760: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2761: <code class="filename">/var</code> in the base system. Some programs (especially
2762: games, network daemons) need write access to it during normal
2763: operation.</p></li>
1.128 wiz 2764: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2765: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2766: 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 2767: itself.</p></li>
2768: </ul></div>
1.148 asau 2769: <div class="sect1">
1.90 rillig 2770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2771: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2772: </h2></div></div></div>
1.90 rillig 2773: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2774: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2775: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2776: <dt><span class="term"><code class="filename">bin</code></span></dt>
2777: <dd><p>Contains executable programs that are intended to be
2778: directly used by the end user.</p></dd>
2779: <dt><span class="term"><code class="filename">emul</code></span></dt>
2780: <dd><p>Contains files for the emulation layers of various other
2781: operating systems, especially for
2782: NetBSD.</p></dd>
2783: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2784: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2785: <dd><p>Contains
2786: the configuration files.</p></dd>
2787: <dt><span class="term"><code class="filename">include</code></span></dt>
2788: <dd><p>Contains headers for the C and C++ programming
2789: languages.</p></dd>
2790: <dt><span class="term"><code class="filename">info</code></span></dt>
2791: <dd><p>Contains GNU info files of various
2792: packages.</p></dd>
2793: <dt><span class="term"><code class="filename">lib</code></span></dt>
2794: <dd><p>Contains shared and static
2795: libraries.</p></dd>
2796: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2797: <dd><p>Contains data files that don't change after
2798: installation. Other data files belong into
2799: <code class="filename">${VARBASE}</code>.</p></dd>
2800: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2801: <dd><p>Contains programs that are not intended to be used by
2802: end users, such as helper programs or network
2803: daemons.</p></dd>
2804: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2805: <dd><p>Contains programs that are intended to be executed as
2806: CGI scripts by a web server.</p></dd>
2807: <dt><span class="term"><code class="filename">man</code> (the usual value of
2808: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2809: <dd><p>Contains brief
2810: documentation in form of manual pages.</p></dd>
2811: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2812: <dd><p>Contains programs that are intended to be used only by
2813: the super-user.</p></dd>
2814: <dt><span class="term"><code class="filename">share</code></span></dt>
2815: <dd><p>Contains platform-independent data files that don't
2816: change after installation.</p></dd>
2817: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2818: <dd><p>Contains documentation files provided by the
2819: packages.</p></dd>
2820: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2821: <dd><p>Contains example files provided by the packages. Among
2822: others, the original configuration files are saved here and copied to
2823: <code class="filename">${PKG_SYSCONFDIR}</code> during
2824: installation.</p></dd>
2825: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2826: <dd><p>Contains the original files for rc.d
2827: scripts.</p></dd>
2828: <dt><span class="term"><code class="filename">var</code> (the usual location of
2829: <code class="filename">${VARBASE}</code>)</span></dt>
2830: <dd><p>Contains files
2831: that may be modified after
2832: installation.</p></dd>
2833: </dl></div>
2834: </div>
1.148 asau 2835: <div class="sect1">
1.90 rillig 2836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2837: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2838: </h2></div></div></div>
1.148 asau 2839: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2840: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2841: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2842: <dd><p>Contains
2843: information about the currently installed
2844: packages.</p></dd>
2845: <dt><span class="term"><code class="filename">games</code></span></dt>
2846: <dd><p>Contains highscore
2847: files.</p></dd>
2848: <dt><span class="term"><code class="filename">log</code></span></dt>
2849: <dd><p>Contains log files.</p></dd>
2850: <dt><span class="term"><code class="filename">run</code></span></dt>
2851: <dd><p>Contains informational files about daemons that are
2852: currently running.</p></dd>
2853: </dl></div>
2854: </div>
2855: </div>
1.148 asau 2856: <div class="chapter">
1.90 rillig 2857: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2858: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2859: <div class="toc">
2860: <p><b>Table of Contents</b></p>
1.195 wiz 2861: <dl class="toc">
1.106 rillig 2862: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194 bsiegert 2863: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2864: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2865: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2866: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2867: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2868: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2869: <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>
2870: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2871: <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
1.128 wiz 2872: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 2873: <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>
2874: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2875: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2876: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2877: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2878: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2879: <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 2880: </dl>
2881: </div>
2882: <p>This section contains hints, tips & tricks on special things in
2883: pkgsrc that we didn't find a better place for in the previous chapters, and
2884: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2885: <div class="sect1">
1.75 rillig 2886: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2887: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2888: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2889: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2890: <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 2891: This is a general purpose list for most issues regarding
2892: pkgsrc, regardless of platform, e.g. soliciting user help
2893: for pkgsrc configuration, unexpected build failures, using
2894: particular packages, upgrading pkgsrc installations,
2895: questions regarding the pkgsrc release branches, etc. General announcements or
2896: proposals for changes that impact the pkgsrc user community,
2897: e.g. major infrastructure changes, new features, package
2898: removals, etc., may also be posted.</p></li>
1.128 wiz 2899: <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 2900: A list where the results of pkgsrc bulk builds are sent and
2901: discussed.</p></li>
1.128 wiz 2902: <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 2903: This list is for those who are interested in getting a
2904: commit message for every change committed to pkgsrc. It is
2905: also available in digest form, meaning one daily message
2906: containing all commit messages for changes to the package
2907: source tree in that 24 hour period.</p></li>
2908: </ul></div>
2909: <p>To subscribe, do:</p>
2910: <pre class="programlisting">
1.100 rillig 2911: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2912: </pre>
2913: <p>Archives for all these mailing lists are available from
1.110 hubertf 2914: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2915: </div>
1.148 asau 2916: <div class="sect1">
1.75 rillig 2917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2918: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2919: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2920: a number of useful utilities for both users and developers of pkgsrc. This
2921: section attempts only to make the reader aware of the utilities and when
2922: they might be useful, and not to duplicate the documentation that comes
2923: with each package.</p>
2924: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.189 snj 2925: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-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 2926: Symlinks for use by buildlink.</p></li></ul></div>
2927: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2928: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2929: <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 2930: Calculates various kinds of checksums (including SHA1).</p></li>
1.189 snj 2931: <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 2932: Compatibility library for pkgsrc tools.</p></li>
1.189 snj 2933: <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 2934: non-BSD systems due to lack of native mtree.</p></li>
1.189 snj 2935: <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 2936: Up-to-date replacement for
1.76 rillig 2937: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2938: systems where pkg_install is not present.</p></li>
2939: </ul></div>
2940: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2941: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2942: <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 2943: Create a binary package from an
1.110 hubertf 2944: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2945: save the old package.</p></li>
1.189 snj 2946: <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 2947: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2948: from multiple locations. It currently supports the following
2949: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.189 snj 2950: <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 2951: the best compiler flags to optimise code for your current
1.128 wiz 2952: CPU and compiler. </p></li>
1.75 rillig 2953: </ul></div>
2954: <p>Utilities for keeping track of installed packages, being up to date,
2955: etc:</p>
1.148 asau 2956: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2957: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173 wiz 2958: update tool similar to apt(1). Download, install, and upgrade
2959: binary packages easily.</p></li>
1.189 snj 2960: <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 2961: packages whose installed versions do not match the latest pkgsrc
2962: entries.</p></li>
1.189 snj 2963: <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 2964: dependency graphs of packages, to aid in choosing a strategy for
2965: updating.</p></li>
1.189 snj 2966: <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
2967: 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>
2968: <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 2969: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.189 snj 2970: <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 2971: does various checks on the complete pkgsrc system.</p></li>
1.189 snj 2972: <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 2973: packages you have installed.</p></li>
2974: </ul></div>
2975: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2976: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2977: <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 2978: making and maintaining patches for a package (includes pkgdiff,
2979: pkgvi, mkpatches, etc.).</p></li>
1.189 snj 2980: <li class="listitem"><p><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 2981: converting to pkgsrc.</p></li>
2982: </ul></div>
2983: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2984: utilities)</p>
1.148 asau 2985: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2986: <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 2987: packages in a chrooted area.</p></li>
1.189 snj 2988: <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 2989: kernel version for chrooted cross builds.</p></li>
2990: </ul></div>
2991: </div>
1.148 asau 2992: <div class="sect1">
1.75 rillig 2993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2994: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 2995: <p>If you want to use pkgsrc as non-root user, you can set some
2996: variables to make pkgsrc work under these conditions. At the very least,
1.128 wiz 2997: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 2998: will turn on unprivileged mode and set multiple related variables to allow
2999: installation of packages as non-root.</p>
3000: <p>In case the defaults are not enough, you may want to tune some other
3001: variables used. For example, if the automatic user/group detection leads
3002: to incorrect values (or not the ones you would like to use), you can change
3003: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3004: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3005: <p>As regards bootstrapping, please note that the
1.110 hubertf 3006: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3007: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3008: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3009: installation targets. These directories can be overridden by the
1.128 wiz 3010: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3011: that allow finer tuning of the tree layout.</p>
3012: </div>
1.148 asau 3013: <div class="sect1">
1.75 rillig 3014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3015: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3016: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3017: enable this feature by adding the option
3018: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3019: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3020: distfile is found, pkgsrc will try to resume it.</p>
3021: <p>You can also
1.168 wiz 3022: use a different program than the platform default program by changing the
1.117 jnemeth 3023: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3024: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3025: by using the value manual. A value of custom disables the system defaults
3026: and dependency tracking for the fetch program. In that case you have to
3027: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3028: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3029: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3030: <p>For example, if you want to use
1.117 jnemeth 3031: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3032: like:</p>
3033: <pre class="programlisting">
1.117 jnemeth 3034: FETCH_USING= wget
1.1 grant 3035: </pre>
1.75 rillig 3036: </div>
1.148 asau 3037: <div class="sect1">
1.75 rillig 3038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3039: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 3040: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3041: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3042: you will have to add the following line into
1.110 hubertf 3043: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3044: <pre class="programlisting">
1.103 wiz 3045: X11_TYPE=modular
1.1 grant 3046: </pre>
1.148 asau 3047: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3048: <h3 class="title">Note</h3>
1.103 wiz 3049: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3050: </p>
1.75 rillig 3051: </div>
3052: </div>
1.148 asau 3053: <div class="sect1">
1.75 rillig 3054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3055: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3056: <p>If you are sitting behind a firewall which does not allow direct
3057: connections to Internet hosts (i.e. non-NAT), you may specify the
3058: relevant proxy hosts. This is done using an environment variable in the
3059: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 3060: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3061: port 80 as the proxy port number. So the proxy environment variables
3062: are:</p>
3063: <pre class="programlisting">
1.100 rillig 3064: ftp_proxy=ftp://orpheus.amdahl.com:80/
3065: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3066: </pre>
1.75 rillig 3067: </div>
1.148 asau 3068: <div class="sect1">
1.75 rillig 3069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3070: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 3071: <p>Some fetch tools are not prepared to support HTTPS by default
3072: (for example, the one in NetBSD 6.0), or the one installed by the
3073: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3074: dependency graph).</p>
3075: <p>Usually you won't notice, because distribution files are
3076: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3077: be often enough if you are following pkgsrc-current. In that case, set
3078: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3079: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3080: with HTTPS support by default. Of course, these tools need to be
3081: installed before you can use them this way.</p>
3082: </div>
3083: <div class="sect1">
3084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3085: <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 3086: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3087: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3088: the first available command from the following list:</p>
1.148 asau 3089: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3090: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3091: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3092: </ul></div>
3093: <p>On a default NetBSD installation, this will be
1.76 rillig 3094: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3095: connections first, and falls back to active connections if the server
3096: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3097: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3098: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3099: <p>Having that option present will prevent
1.76 rillig 3100: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3101: transfers.</p>
3102: </div>
1.148 asau 3103: <div class="sect1">
1.75 rillig 3104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3105: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3106: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3107: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3108: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 3109: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3110: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3111: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3112: resulting list to your machine at work/school and use it there. If you
1.189 snj 3113: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 3114: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3115: URL:</p>
3116: <p>At home:</p>
3117: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3118: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3119: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3120: <p>At work:</p>
3121: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3122: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3123: home.</p>
3124: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3125: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3126: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3127: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3128: directly by running:</p>
1.75 rillig 3129: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3130: <p>If you even decide to ignore
3131: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3132: by running:</p>
3133: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3134: </div>
1.148 asau 3135: <div class="sect1">
1.75 rillig 3136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3137: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 3138: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.189 snj 3139: <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 3140: package, you get the error from make that it doesn't know how to make
1.76 rillig 3141: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3142: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3143: the NetBSD base distribution on your machine. It is recommended to do
3144: that to format man pages.</p>
1.189 snj 3145: <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 3146: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3147: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3148: </div>
1.148 asau 3149: <div class="sect1">
1.75 rillig 3150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3151: <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 3152: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3153: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3154: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3155: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3156: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3157: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3158: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3159: -r</strong></span>).</p>
3160: </div>
1.148 asau 3161: <div class="sect1">
1.75 rillig 3162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3163: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3164: <p>When installing packages as non-root user and using the just-in-time
1.189 snj 3165: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><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 3166: password for each required package installed. To avoid this, the sudo
3167: package can be used, which does password caching over a limited time. To
3168: use it, install sudo (either as binary package or from
1.189 snj 3169: <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 3170: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3171: <span class="emphasis"><em>after</em></span> the definition of the
3172: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3173: <pre class="programlisting">
1.100 rillig 3174: .if exists(${LOCALBASE}/bin/sudo)
3175: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3176: .endif
1.1 grant 3177: </pre>
1.75 rillig 3178: </div>
1.148 asau 3179: <div class="sect1">
1.75 rillig 3180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3181: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3182: <p>As the system administrator, you can choose where configuration files
3183: are installed. The default settings make all these files go into
1.76 rillig 3184: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3185: be suboptimal depending on your expectations (e.g., a read-only,
3186: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3187: configuration of the provided packages).</p>
3188: <p>In order to change the defaults, you can modify the
3189: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3190: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3191: directory; some common examples include <code class="filename">/etc</code> or
3192: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3193: <p>Furthermore, you can change this value on a per-package basis by
3194: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3195: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3196: package you would like to modify, that is, the contents of
3197: <code class="varname">PKGBASE</code>.</p>
3198: <p>Note that after changing these settings, you must rebuild and
3199: reinstall any affected packages.</p>
3200: </div>
1.148 asau 3201: <div class="sect1">
1.75 rillig 3202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3203: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3204: <p>Please be aware that there can often be bugs in third-party software,
3205: and some of these bugs can leave a machine vulnerable to exploitation by
3206: attackers. In an effort to lessen the exposure, the NetBSD packages team
3207: maintains a database of known-exploits to packages which have at one time
3208: been included in pkgsrc. The database can be downloaded automatically, and
3209: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3210: do this, refer to the following two tools (installed as part of the
1.189 snj 3211: <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 3212: <div class="orderedlist"><ol class="orderedlist" type="1">
3213: <li class="listitem">
1.122 reed 3214: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3215: download a list of the security vulnerabilities information. This list
1.132 spz 3216: is kept up to date by the pkgsrc security team, and is distributed
3217: from the NetBSD ftp server:</p>
3218: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.75 rillig 3219: </li>
1.128 wiz 3220: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3221: current machine, checking each known vulnerability. If a
1.75 rillig 3222: vulnerable package is installed, it will be shown by output to stdout,
3223: including a description of the type of vulnerability, and a URL
3224: containing more information.</p></li>
3225: </ol></div>
1.114 jmcneill 3226: <p>Use of these tools is strongly recommended! After
1.128 wiz 3227: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3228: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3229: pkg_install</code></strong>.</p>
1.87 wiz 3230: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3231: 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 3232: check.</p>
1.75 rillig 3233: </div>
1.148 asau 3234: <div class="sect1">
1.75 rillig 3235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3236: <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 3237: <p>When you add your own preferences to the
3238: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3239: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3240: environment variables to the <code class="filename">./configure</code>
1.189 snj 3241: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3242: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3243: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3244: package.</p>
3245: <p>Currently there is no solution to this problem. If you
3246: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3247: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3248: directory and then inspect any <code class="filename">Makefile</code> and
3249: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3250: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3251: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3252: programmers write so bad code that it only works for the
3253: specific combination of <code class="varname">CFLAGS</code> they have
3254: chosen.</p>
3255: </div>
1.148 asau 3256: <div class="sect1">
1.80 rillig 3257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3258: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3259: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3260: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3261: case that occurs often is that people only update pkgsrc in
3262: parts, because of performance reasons. Since pkgsrc is one large
3263: system, not a collection of many small systems, there are
3264: sometimes changes that only work when the whole pkgsrc tree is
3265: updated.</p></li>
1.148 asau 3266: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3267: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3268: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3269: files.</p></li>
1.148 asau 3270: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3271: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3272: verify this.</p></li>
1.148 asau 3273: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3274: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3275: </ol></div>
3276: </div>
1.148 asau 3277: <div class="sect1">
1.88 wiz 3278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3279: <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 3280: <p>You have modified a file from pkgsrc, and someone else has
3281: modified that same file afterwards in the CVS repository. Both changes
3282: are in the same region of the file, so when you updated pkgsrc, the
3283: <code class="literal">cvs</code> command marked the conflicting changes in the
3284: file. Because of these markers, the file is no longer a valid
3285: <code class="filename">Makefile</code>.</p>
3286: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3287: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3288: -dP</strong></span> in that directory to download the current version.</p>
3289: </div>
1.75 rillig 3290: </div>
3291: </div>
1.148 asau 3292: <div class="part">
1.75 rillig 3293: <div class="titlepage"><div><div><h1 class="title">
3294: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3295: <div class="partintro">
1.77 rillig 3296: <div></div>
3297: <p>This part of the book deals with creating and
1.128 wiz 3298: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3299: guide on creating a new package. The remaining chapters are more
3300: like a reference manual for pkgsrc.</p>
1.75 rillig 3301: <div class="toc">
3302: <p><b>Table of Contents</b></p>
1.195 wiz 3303: <dl class="toc">
1.106 rillig 3304: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3305: <dd><dl>
1.106 rillig 3306: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3307: <dd><dl>
1.106 rillig 3308: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3309: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3310: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3311: </dl></dd>
1.106 rillig 3312: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3313: <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>
3314: </dl></dd>
3315: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3316: <dd><dl>
1.128 wiz 3317: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3318: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3319: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3320: <dd><dl>
3321: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3322: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3323: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3324: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3325: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3326: </dl></dd>
3327: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3328: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3329: <dd><dl>
3330: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3331: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3332: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3333: </dl></dd>
1.128 wiz 3334: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3335: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3336: </dl></dd>
1.128 wiz 3337: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3338: <dd><dl>
3339: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3340: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3341: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3342: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3343: <dd><dl>
3344: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3345: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3346: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3347: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3348: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3349: </dl></dd>
3350: </dl></dd>
3351: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3352: <dd><dl>
3353: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 3354: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3355: <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 3356: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3357: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 3358: <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 3359: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 3360: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
3361: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106 rillig 3362: </dl></dd>
3363: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3364: <dd><dl>
3365: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 3366: <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 3367: <dd><dl>
3368: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 3369: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3370: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3371: and
3372: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3373: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3374: </dl></dd>
1.128 wiz 3375: <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 3376: <dd><dl>
1.128 wiz 3377: <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 3378: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3379: </dl></dd>
3380: </dl></dd>
3381: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3382: <dd><dl>
3383: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3384: <dd><dl>
3385: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3386: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3387: </dl></dd>
3388: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3389: <dd><dl>
1.128 wiz 3390: <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 3391: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3392: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3393: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3394: </dl></dd>
3395: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3396: <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>
3397: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3398: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3399: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3400: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3401: <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>
3402: </dl></dd>
3403: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3404: <dd><dl>
3405: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3406: <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 3407: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3408: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3409: </dl></dd>
3410: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3411: <dd><dl>
3412: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3413: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3414: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3415: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3416: <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 3417: <dd><dl>
3418: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3419: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3420: </dl></dd>
1.128 wiz 3421: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3422: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3423: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3424: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3425: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3426: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3427: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3428: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3429: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3430: <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 3431: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3432: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3433: </dl></dd>
3434: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3435: <dd><dl>
3436: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3437: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3438: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3439: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3440: </dl></dd>
3441: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3442: <dd><dl>
3443: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3444: <dd><dl>
3445: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3446: <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 3447: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3448: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3449: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3450: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3451: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3452: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3453: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3454: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3455: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3456: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3457: </dl></dd>
1.128 wiz 3458: <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 3459: <dd><dl>
3460: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3461: <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>
3462: </dl></dd>
1.128 wiz 3463: <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 3464: <dd><dl>
3465: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3466: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3467: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3468: </dl></dd>
3469: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3470: <dd><dl>
3471: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3472: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3473: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 3474: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3475: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 3476: </dl></dd>
1.128 wiz 3477: <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 3478: <dd><dl>
3479: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3480: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3481: <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 3482: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3483: </dl></dd>
1.128 wiz 3484: <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 3485: <dd><dl>
3486: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3487: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3488: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3489: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3490: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3491: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3492: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3493: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3494: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3495: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3496: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3497: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3498: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3499: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3500: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3501: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3502: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3503: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3504: emulation</a></span></dt>
1.106 rillig 3505: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3506: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3507: </dl></dd>
1.106 rillig 3508: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3509: </dl></dd>
1.106 rillig 3510: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3511: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3512: <dd><dl>
1.106 rillig 3513: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3514: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3515: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 3516: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3517: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3518: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3519: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3520: </dl></dd>
3521: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3522: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3523: <dd><dl>
3524: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3525: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3526: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3527: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3528: </dl></dd>
1.75 rillig 3529: </dl>
3530: </div>
1.77 rillig 3531: </div>
1.148 asau 3532: <div class="chapter">
1.77 rillig 3533: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3534: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3535: <div class="toc">
3536: <p><b>Table of Contents</b></p>
1.195 wiz 3537: <dl class="toc">
1.106 rillig 3538: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3539: <dd><dl>
1.106 rillig 3540: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3541: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3542: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3543: </dl></dd>
1.106 rillig 3544: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3545: <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 3546: </dl>
3547: </div>
1.77 rillig 3548: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3549: most likely have a URL from where you can download the source
3550: code. Starting with this URL, creating a package involves only a
3551: few steps.</p>
1.128 wiz 3552: <div class="procedure"><ol class="procedure" type="1">
1.189 snj 3553: <li class="step"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148 asau 3554: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3555: category in which you want to place your package. You can also create a
3556: directory of your own (maybe called <code class="filename">local</code>). In that
3557: category directory, create another directory for your package and change
3558: into it.</p></li>
1.148 asau 3559: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3560: you for a URL. Enter the URL of the distribution file (in most cases a
3561: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3562: of your package are created automatically. The distribution file is
3563: extracted automatically to fill in some details in the
3564: <code class="filename">Makefile</code> that would otherwise have to be done
3565: manually.</p></li>
1.148 asau 3566: <li class="step">
1.91 rillig 3567: <p>Examine the extracted files to determine the dependencies of
3568: your package. Ideally, this is mentioned in some
3569: <code class="filename">README</code> file, but things may differ. For each of
3570: these dependencies, look where it exists in pkgsrc, and if there is a
3571: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3572: line to your package <code class="filename">Makefile</code> which includes that
3573: file just before the last line. If the
1.132 spz 3574: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3575: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3576: <p>If you just need binaries from a package, add a
1.91 rillig 3577: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3578: version of the dependency and where it can be found in pkgsrc. This line
3579: should be placed in the third paragraph. If the dependency is only
3580: needed for building the package, but not when using it, use
3581: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3582: Your package may then look like this:</p>
1.77 rillig 3583: <pre class="programlisting">
1.100 rillig 3584: [...]
1.77 rillig 3585:
1.174 asau 3586: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3587: DEPENDS+= screen-[0-9]*:../../misc/screen
3588: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3589:
1.100 rillig 3590: [...]
1.77 rillig 3591:
1.100 rillig 3592: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3593: .include "../../devel/glib2/buildlink3.mk"
3594: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3595: </pre>
3596: </li>
1.148 asau 3597: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3598: 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 3599: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3600: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3601: -e</strong></span>, which outputs additional
3602: explanations.</p></li>
1.148 asau 3603: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3604: 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 3605: over there, you can hopefully continue here.</p></li>
1.148 asau 3606: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3607: directory from the extracted files. Besides these files, a lot of cache
3608: files and other system information has been saved in the working
3609: directory, which may become wrong after you edited the
3610: <code class="filename">Makefile</code>.</p></li>
1.148 asau 3611: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3612: 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.148 asau 3613: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3614: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3615: everything works.</p></li>
1.148 asau 3616: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3617: contains a list of the files that are installed by the package, is
1.110 hubertf 3618: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3619: >PLIST</strong></span> to generate a probably correct list. Check
3620: the file using your preferred text editor to see if the list of
3621: files looks plausible.</p></li>
1.148 asau 3622: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3623: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3624: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3625: has been registered in the database of installed files, but with an
1.110 hubertf 3626: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3627: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3628: registered with the list of files from
3629: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3630: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3631: package from the set of installed files.</p></li>
1.77 rillig 3632: </ol></div>
1.148 asau 3633: <div class="sect1">
1.91 rillig 3634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3635: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3636: <div class="sect2">
1.91 rillig 3637: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3638: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3639: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3640: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3641: </div>
1.148 asau 3642: <div class="sect2">
1.91 rillig 3643: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 3644: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3645: <p>KDE3 applications should always include
1.91 rillig 3646: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174 asau 3647: settings that are typical of KDE3 packages.</p>
1.91 rillig 3648: </div>
1.148 asau 3649: <div class="sect2">
1.118 imil 3650: <div class="titlepage"><div><div><h3 class="title">
3651: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3652: <p>Python modules and programs packages are easily created using a
3653: set of predefined variables.</p>
3654: <p>
1.171 wiz 3655: If some Python versions are not supported by the software, set the
3656: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3657: that are not supported, e.g.
1.118 imil 3658: </p>
3659: <pre class="programlisting">
1.172 wiz 3660: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.118 imil 3661: </pre>
3662: <p>
3663: If the packaged software is a Python module, include
1.128 wiz 3664: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3665: In this case, the package directory should be called
1.128 wiz 3666: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3667: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3668: </p>
3669: <pre class="programlisting">
3670: DISTNAME= foopymodule-1.2.10
3671: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3672: </pre>
1.171 wiz 3673: <p>If it is an application, include
3674: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3675: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3676: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3677: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3678: For example:
1.118 imil 3679: </p>
3680: <pre class="programlisting">
1.142 wiz 3681: REPLACE_PYTHON= *.py
1.118 imil 3682: </pre>
1.171 wiz 3683: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3684: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3685: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3686: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3687: so pkgsrc will use this framework.
3688: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3689: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3690: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3691: to the name of the script.</p>
3692: <p>Otherwise, if the packaged software is egg-aware, you only need
3693: to include
3694: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3695: <p>Some Python modules have separate distributions for Python-2.x
3696: and Python-3.x support. In pkgsrc this is handled by the
3697: <code class="filename">versioned_dependencies.mk</code> file. Set
3698: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3699: packages that should be depended upon and include
3700: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3701: then the pkgsrc infrastructure will depend on the appropriate package
3702: version. For example:
3703: </p>
3704: <pre class="programlisting">
3705: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3706: </pre>
3707: <p>
3708: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3709: of supported packages.</p>
1.118 imil 3710: </div>
1.91 rillig 3711: </div>
1.148 asau 3712: <div class="sect1">
1.91 rillig 3713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3714: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3715: <div class="sect2">
1.91 rillig 3716: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3717: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3718: <div class="sect3">
1.91 rillig 3719: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3720: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3721: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3722: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3723: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3724: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3725: <pre class="programlisting">
1.100 rillig 3726: <code class="prompt">$</code> mkdir www/nvu
3727: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3728: </pre>
3729: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3730: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3731: <pre class="programlisting">
1.100 rillig 3732: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3733: </pre>
3734: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3735: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3736: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3737: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3738: <code class="varname">COMMENT</code> fields. Then the package
3739: <code class="filename">Makefile</code> looked like that:</p>
3740: <pre class="programlisting">
1.100 rillig 3741: # $NetBSD$
3742: #
1.91 rillig 3743:
1.100 rillig 3744: DISTNAME= nvu-1.0-sources
3745: PKGNAME= nvu-1.0
3746: CATEGORIES= www
3747: MASTER_SITES= http://cvs.nvu.com/download/
3748: EXTRACT_SUFX= .tar.bz2
3749:
3750: MAINTAINER= rillig@NetBSD.org
3751: HOMEPAGE= http://cvs.nvu.com/
3752: COMMENT= Web Authoring System
1.91 rillig 3753:
1.100 rillig 3754: # url2pkg-marker (please do not remove this line.)
3755: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3756: </pre>
3757: <p>Then, I quit the editor and watched pkgsrc downloading a large
3758: source archive:</p>
3759: <pre class="programlisting">
1.100 rillig 3760: url2pkg> Running "make makesum" ...
3761: => Required installed package digest>=20010302: digest-20060826 found
3762: => Fetching nvu-1.0-sources.tar.bz2
3763: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3764: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3765: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3766: url2pkg> Running "make extract" ...
3767: => Required installed package digest>=20010302: digest-20060826 found
3768: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3769: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3770: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3771: ===> Installing dependencies for nvu-1.0
3772: ===> Overriding tools for nvu-1.0
3773: ===> Extracting for nvu-1.0
3774: url2pkg> Adjusting the Makefile.
1.91 rillig 3775:
1.100 rillig 3776: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3777:
1.100 rillig 3778: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3779: </pre>
3780: </div>
1.148 asau 3781: <div class="sect3">
1.91 rillig 3782: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3783: <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 3784: <p>Now that the package has been extracted, let's see what's inside
3785: it. The package has a <code class="filename">README.txt</code>, but that only
3786: says something about mozilla, so it's probably useless for seeing what
3787: dependencies this package has. But since there is a GNU configure script
3788: in the package, let's hope that it will complain about everything it
3789: needs.</p>
3790: <pre class="programlisting">
1.100 rillig 3791: <code class="prompt">$</code> bmake
3792: => Required installed package digest>=20010302: digest-20060826 found
3793: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3794: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3795: ===> Patching for nvu-1.0
3796: ===> Creating toolchain wrappers for nvu-1.0
3797: ===> Configuring for nvu-1.0
3798: [...]
3799: configure: error: Perl 5.004 or higher is required.
3800: [...]
3801: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3802: [...]
1.91 rillig 3803: </pre>
3804: <p>That worked quite well. So I opened the package Makefile in my
3805: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3806: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3807: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3808: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3809: from scratch.</p>
3810: <pre class="programlisting">
1.100 rillig 3811: <code class="prompt">$</code> bmake clean
3812: ===> Cleaning for nvu-1.0
3813: <code class="prompt">$</code> bmake
3814: [...]
3815: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3816: GNU Make. You will not be able to build Mozilla without GNU Make.
3817: [...]
1.91 rillig 3818: </pre>
1.128 wiz 3819: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3820: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3821: <pre class="programlisting">
1.100 rillig 3822: [...]
3823: checking for GTK - version >= 1.2.0... no
3824: *** Could not run GTK test program, checking why...
3825: [...]
1.91 rillig 3826: </pre>
3827: <p>Now to the other dependencies. The first question is: Where is the
3828: GTK package hidden in pkgsrc?</p>
3829: <pre class="programlisting">
1.100 rillig 3830: <code class="prompt">$</code> echo ../../*/gtk*
3831: [many packages ...]
3832: <code class="prompt">$</code> echo ../../*/gtk
3833: ../../x11/gtk
3834: <code class="prompt">$</code> echo ../../*/gtk2
3835: ../../x11/gtk2
3836: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3837: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3838: </pre>
3839: <p>The first try was definitely too broad. The second one had exactly
3840: one result, which is very good. But there is one pitfall with GNOME
3841: packages. Before GNOME 2 had been released, there were already many
3842: GNOME 1 packages in pkgsrc. To be able to continue to use these
3843: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3844: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3845: whether this was the case here, and indeed it was.</p>
3846: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3847: file, adding the dependency is very easy. I just inserted an
3848: <code class="literal">.include</code> line before the last line of the package
3849: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3850: <pre class="programlisting">
1.100 rillig 3851: [...]
3852: .include "../../x11/gtk2/buildlink3.mk"
3853: .include "../../mk/bsd.pkg.mk
1.91 rillig 3854: </pre>
1.110 hubertf 3855: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3856: was:</p>
3857: <pre class="programlisting">
1.100 rillig 3858: [...]
3859: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3860: checking for GTK - version >= 1.2.0... no
3861: *** Could not run GTK test program, checking why...
3862: *** The test program failed to compile or link. See the file config.log for the
3863: *** exact error that occured. This usually means GTK was incorrectly installed
3864: *** or that you have moved GTK since it was installed. In the latter case, you
3865: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3866: configure: error: Test for GTK failed.
3867: [...]
1.91 rillig 3868: </pre>
1.128 wiz 3869: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3870: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3871: told me that this package really wanted to have the GNOME 1 version of
3872: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3873: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3874: So I changed the <code class="literal">x11/gtk2</code> to
3875: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3876: and tried again.</p>
3877: <pre class="programlisting">
1.100 rillig 3878: [...]
1.166 jnemeth 3879: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3880: In file included from xpidl.c:42:
3881: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3882: In file included from xpidl.c:42:
3883: xpidl.h:132: error: parse error before "IDL_ns"
3884: [...]
1.91 rillig 3885: </pre>
3886: <p>The package still does not find all of its dependencies. Now the
3887: question is: Which package provides the
3888: <code class="filename">libIDL/IDL.h</code> header file?</p>
3889: <pre class="programlisting">
1.100 rillig 3890: <code class="prompt">$</code> echo ../../*/*idl*
3891: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3892: <code class="prompt">$</code> echo ../../*/*IDL*
3893: ../../net/libIDL
1.91 rillig 3894: </pre>
3895: <p>Let's take the one from the second try. So I included the
3896: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3897: again. But the error didn't change. After digging through some of the
3898: code, I concluded that the build process of the package was broken and
3899: couldn't have ever worked, but since the Mozilla source tree is quite
3900: large, I didn't want to fix it. So I added the following to the package
3901: <code class="filename">Makefile</code> and tried again:</p>
3902: <pre class="programlisting">
1.100 rillig 3903: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3904: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 3905: </pre>
3906: <p>The latter line is needed because the package expects the library
3907: <code class="filename">libIDL.so</code>, but only
3908: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3909: wrapper to rewrite that on the fly.</p>
3910: <p>The next problem was related to a recent change of the FreeType
1.189 snj 3911: 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>
1.91 rillig 3912: which patch files were relevant for this issue and copied them to the
3913: <code class="filename">patches</code> directory. Then I retried, fixed the
3914: patches so that they applied cleanly and retried again. This time,
3915: everything worked.</p>
3916: </div>
1.148 asau 3917: <div class="sect3">
1.91 rillig 3918: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3919: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3920: <pre class="programlisting">
1.100 rillig 3921: <code class="prompt">$</code> bmake CHECK_FILES=no install
3922: [...]
3923: <code class="prompt">$</code> bmake print-PLIST >PLIST
3924: <code class="prompt">$</code> bmake deinstall
3925: <code class="prompt">$</code> bmake install
1.91 rillig 3926: </pre>
3927: </div>
3928: </div>
3929: </div>
1.77 rillig 3930: </div>
1.148 asau 3931: <div class="chapter">
1.75 rillig 3932: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3933: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3934: <div class="toc">
3935: <p><b>Table of Contents</b></p>
1.195 wiz 3936: <dl class="toc">
1.128 wiz 3937: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3938: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3939: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3940: <dd><dl>
3941: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3942: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3943: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3944: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3945: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3946: </dl></dd>
3947: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3948: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3949: <dd><dl>
3950: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3951: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3952: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3953: </dl></dd>
1.128 wiz 3954: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3955: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 3956: </dl>
3957: </div>
1.87 wiz 3958: <p>Whenever you're preparing a package, there are a number of
3959: files involved which are described in the following
3960: sections.</p>
1.148 asau 3961: <div class="sect1">
1.75 rillig 3962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3963: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 3964: </h2></div></div></div>
1.75 rillig 3965: <p>Building, installation and creation of a binary package are all
1.87 wiz 3966: controlled by the package's <code class="filename">Makefile</code>.
3967: The <code class="filename">Makefile</code> describes various things about
3968: a package, for example from where to get it, how to configure,
3969: build, and install it.</p>
1.76 rillig 3970: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3971: sections that describe the package.</p>
1.75 rillig 3972: <p>In the first section there are the following variables, which
1.87 wiz 3973: should appear exactly in the order given here. The order and
3974: grouping of the variables is mostly historical and has no further
3975: meaning.</p>
1.148 asau 3976: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3977: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3978: distribution file to be downloaded from the package's
3979: website.</p></li>
1.128 wiz 3980: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3981: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3982: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 3983: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3984: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 3985: directory name together with the version number. It must match the
3986: regular expression
3987: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3988: starts with a letter or digit, and contains only letters, digits,
3989: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 3990: <li class="listitem">
1.75 rillig 3991: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 3992: which the package fits in. You can choose any of the top-level
3993: directories of pkgsrc for it.</p>
1.75 rillig 3994: <p>Currently the following values are available for
1.87 wiz 3995: <code class="varname">CATEGORIES</code>. If more than
3996: one is used, they need to be separated by spaces:</p>
1.75 rillig 3997: <pre class="programlisting">
1.100 rillig 3998: archivers cross geography meta-pkgs security
3999: audio databases graphics misc shells
4000: benchmarks devel ham multimedia sysutils
4001: biology editors inputmethod net textproc
4002: cad emulators lang news time
4003: chat finance mail parallel wm
4004: comms fonts math pkgtools www
4005: converters games mbone print x11
4006: </pre>
1.75 rillig 4007: </li>
1.128 wiz 4008: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4009: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4010: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4011: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4012: <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 4013: </ul></div>
4014: <p>The second section contains information about separately
1.87 wiz 4015: downloaded patches, if any.
4016: </p>
1.148 asau 4017: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190 wiz 4018: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87 wiz 4019: Name(s) of additional files that contain distribution patches.
4020: There is no default. pkgsrc will look for them at
4021: <code class="varname">PATCH_SITES</code>.
4022: They will automatically be uncompressed before patching if
4023: the names end with <code class="filename">.gz</code> or
4024: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4025: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4026: Primary location(s) for distribution patch files (see
1.190 wiz 4027: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
4028: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
4029: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
4030: help find the correct files to patch. It defaults to
4031: <span class="command"><strong>-p0</strong></span>.</p></li>
1.75 rillig 4032: </ul></div>
4033: <p>The third section contains the following variables.
1.87 wiz 4034: </p>
1.148 asau 4035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4036: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4037: address of the person who feels responsible for this package,
4038: and who is most likely to look at problems or questions regarding
1.189 snj 4039: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114 jmcneill 4040: Other developers may contact the <code class="varname">MAINTAINER</code>
4041: before making changes to the package, but are not required to
4042: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4043: to yourself. If you really can't maintain the package for future
4044: updates, set it to
1.110 hubertf 4045: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4046: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4047: of <code class="varname">MAINTAINER</code> when you do not want other
4048: developers to update or change the package without contacting
4049: you first. A package Makefile should contain one of
4050: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4051: not both. </p></li>
1.128 wiz 4052: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4053: find more information about the package.</p></li>
1.128 wiz 4054: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4055: description of the package (should not include the package
4056: name).</p></li>
1.75 rillig 4057: </ul></div>
4058: <p>Other variables that affect the build:
1.87 wiz 4059: </p>
1.148 asau 4060: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4061: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4062: interesting distribution files of the package are found. The
4063: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4064: works for most packages.</p>
1.75 rillig 4065: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4066: (most GNU software does, for instance), but extracts itself in
4067: the current directory, you should set
4068: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4069: <p>If a package doesn't create a subdirectory with the
4070: name of <code class="varname">DISTNAME</code> but some different name,
4071: set <code class="varname">WRKSRC</code> to point to the proper name in
4072: <code class="filename">${WRKDIR}</code>, for example
4073: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.189 snj 4074: <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 4075: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4076: taken from the <code class="varname">WRKDIR_BASENAME</code>
4077: variable. By default, its value is
4078: <code class="filename">work</code>. If you want to use the same
4079: pkgsrc tree for building different kinds of binary packages,
4080: you can change the variable according to your needs. Two
4081: other variables handle common cases of setting
4082: <code class="varname">WRKDIR_BASENAME</code> individually. If
4083: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4084: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4085: the host's name is attached to the directory name. If
4086: <code class="varname">OBJMACHINE</code> is defined, the platform name
4087: is attached, which might look like
4088: <code class="filename">work.i386</code> or
4089: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4090: </li></ul></div>
4091: <p>Please pay attention to the following gotchas:</p>
1.148 asau 4092: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4093: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4094: installed in compressed form by the package. For packages using
4095: BSD-style makefiles which honor MANZ, there is
4096: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4097: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4098: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4099: below).</p></li>
1.128 wiz 4100: <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 4101: </ul></div>
4102: </div>
1.148 asau 4103: <div class="sect1">
1.75 rillig 4104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4105: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4106: </h2></div></div></div>
1.76 rillig 4107: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4108: digest, or checksum, of each distfile needed for the package. This
4109: ensures that the distfiles retrieved from the Internet have not been
4110: corrupted during transfer or altered by a malign force to introduce
4111: a security hole. Due to recent rumor about weaknesses of digest
4112: algorithms, all distfiles are protected using both SHA1 and RMD160
4113: message digests, as well as the file size.</p>
1.76 rillig 4114: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4115: checksums for all the patches found in the
1.110 hubertf 4116: <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 4117: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4118: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4119: command.</p>
1.75 rillig 4120: <p>Some packages have different sets of distfiles depending on
1.189 snj 4121: 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 4122: <code class="filename">distinfo</code> file and care should be taken when
4123: upgrading such a package to ensure distfile information is not
4124: lost.</p>
1.75 rillig 4125: </div>
1.148 asau 4126: <div class="sect1">
1.75 rillig 4127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4128: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4129: <p>Many packages still don't work out-of-the box on the various
4130: platforms that are supported by pkgsrc. Therefore, a number of custom
4131: patch files are needed to make the package work. These patch files are
4132: found in the <code class="filename">patches/</code> directory.</p>
4133: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4134: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4135: 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.130 wiz 4136: order</a>.</p>
1.148 asau 4137: <div class="sect2">
1.93 rillig 4138: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4139: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4140: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4141: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4142: problems. (To force patches to apply with fuzz you can set
4143: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4144: should contain only changes for a single file, and no file should be
1.93 rillig 4145: patched by more than one patch file. This helps to keep future
4146: modifications simple.</p>
4147: <p>Each patch file is structured as follows: In the first line,
4148: there is the RCS Id of the patch itself. The second line should be
4149: empty for aesthetic reasons. After that, there should be a comment for
4150: each change that the patch does. There are a number of standard
4151: cases:</p>
1.148 asau 4152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4153: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4154: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4155: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4156: platform and other environment (for example, the compiler) that the
4157: patch is needed for.</p></li>
4158: </ul></div>
1.130 wiz 4159: <p>In all, the patch should be commented so that any
1.93 rillig 4160: developer who knows the code of the application can make some use of
4161: the patch. Special care should be taken for the upstream developers,
4162: since we generally want that they accept our patches, so we have less
4163: work in the future.</p>
4164: </div>
1.148 asau 4165: <div class="sect2">
1.93 rillig 4166: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4167: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4168: <p>One important thing to mention is to pay attention that no RCS
4169: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4170: later checked into the NetBSD CVS tree. Use the
1.189 snj 4171: <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 4172: problems.</p>
1.87 wiz 4173: <p>For even more automation, we recommend using
1.110 hubertf 4174: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4175: whole set of patches. You just have to backup files before you
4176: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4177: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4178: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4179: you upgrade a package this way, you can easily compare the new
4180: set of patches with the previously existing one with
1.130 wiz 4181: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4182: are replaced by new files, so carefully check if you want to take all
4183: the changes.</p>
1.87 wiz 4184: <p>When you have finished a package, remember to generate
1.110 hubertf 4185: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4186: 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 4187: <p>When adding a patch that corrects a problem in the
4188: distfile (rather than e.g. enforcing pkgsrc's view of where
4189: man pages should go), send the patch as a bug report to the
4190: maintainer. This benefits non-pkgsrc users of the package,
4191: and usually makes it possible to remove the patch in future
4192: version.</p>
1.101 rillig 4193: <p>The file names of the patch files are usually of the form
1.130 wiz 4194: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4195: Many packages still use the previous convention
4196: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4197: but new patches should be of the form containing the filename.
1.189 snj 4198: <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.130 wiz 4199: automatically.</p>
1.93 rillig 4200: </div>
1.148 asau 4201: <div class="sect2">
1.93 rillig 4202: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4203: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4204: <p>If you want to share patches between multiple packages
4205: in pkgsrc, e.g. because they use the same distfiles, set
4206: <code class="varname">PATCHDIR</code> to the path where the patch files
4207: can be found, e.g.:</p>
4208: <pre class="programlisting">
1.100 rillig 4209: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4210: </pre>
1.75 rillig 4211: <p>Patch files that are distributed by the author or other
1.87 wiz 4212: maintainers can be listed in
4213: <code class="varname">PATCHFILES</code>.</p>
4214: <p>If it is desired to store any patches that should not be
4215: committed into pkgsrc, they can be kept outside the pkgsrc
4216: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4217: directory tree there is expected to have the same
1.128 wiz 4218: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4219: patches are expected to be stored inside these dirs (also
4220: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4221: example, if you want to keep a private patch for
4222: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4223: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4224: files in the named directory are expected to be patch files,
4225: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4226: applied</em></span>.</p>
1.93 rillig 4227: </div>
1.148 asau 4228: <div class="sect2">
1.85 jmmv 4229: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4230: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4231: <p>When fixing a portability issue in the code do not use
4232: preprocessor magic to check for the current operating system nor
4233: platform. Doing so hurts portability to other platforms because
4234: the OS-specific details are not abstracted appropriately.</p>
4235: <p>The general rule to follow is: instead of checking for the
4236: operating system the application is being built on, check for the
4237: specific <span class="emphasis"><em>features</em></span> you need. For example,
4238: instead of assuming that kqueue is available under NetBSD and
4239: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4240: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4241: yes, this generally involves patching the
1.110 hubertf 4242: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4243: that prevents some OSes from adopting interfaces from other OSes
4244: (e.g. Linux implementing kqueue), something that the above checks
4245: cannot take into account.</p>
4246: <p>Of course, checking for features generally involves more
4247: work on the developer's side, but the resulting changes are
1.87 wiz 4248: cleaner and there are chances they will work on many other
1.85 jmmv 4249: platforms. Not to mention that there are higher chances of being
4250: later integrated into the mainstream sources. Remember:
4251: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4252: <p>Some typical examples:</p>
4253: <div class="table">
1.106 rillig 4254: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4255: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4256: <colgroup>
4257: <col>
4258: <col>
4259: <col>
4260: </colgroup>
4261: <thead><tr>
4262: <th>Where</th>
4263: <th>Incorrect</th>
4264: <th>Correct</th>
4265: </tr></thead>
4266: <tbody>
4267: <tr>
4268: <td>configure script</td>
4269: <td>
1.100 rillig 4270: <pre class="programlisting">
4271: case ${target_os} in
4272: netbsd*) have_kvm=yes ;;
4273: *) have_kvm=no ;;
4274: esac
4275: </pre>
1.85 jmmv 4276: </td>
4277: <td>
1.100 rillig 4278: <pre class="programlisting">
4279: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4280: </pre>
1.85 jmmv 4281: </td>
4282: </tr>
4283: <tr>
4284: <td>C source file</td>
4285: <td>
1.100 rillig 4286: <pre class="programlisting">
4287: #if defined(__NetBSD__)
4288: # include <sys/event.h>
4289: #endif
4290: </pre>
1.85 jmmv 4291: </td>
4292: <td>
1.100 rillig 4293: <pre class="programlisting">
4294: #if defined(HAVE_SYS_EVENT_H)
4295: # include <sys/event.h>
4296: #endif
4297: </pre>
1.85 jmmv 4298: </td>
4299: </tr>
4300: <tr>
4301: <td>C source file</td>
4302: <td>
1.100 rillig 4303: <pre class="programlisting">
4304: int
4305: monitor_file(...)
4306: {
4307: #if defined(__NetBSD__)
4308: int fd = kqueue();
4309: ...
4310: #else
4311: ...
4312: #endif
4313: }
4314: </pre>
1.85 jmmv 4315: </td>
4316: <td>
1.100 rillig 4317: <pre class="programlisting">
4318: int
4319: monitor_file(...)
4320: {
4321: #if defined(HAVE_KQUEUE)
4322: int fd = kqueue();
4323: ...
4324: #else
4325: ...
4326: #endif
4327: }
4328: </pre>
1.85 jmmv 4329: </td>
4330: </tr>
4331: </tbody>
1.91 rillig 4332: </table></div>
1.85 jmmv 4333: </div>
1.91 rillig 4334: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4335: 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
4336: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4337: 2</a>). It summarizes multiple details on how to make
4338: software easier to package; all the suggestions in it were
4339: collected from our experience in pkgsrc work, so they are possibly
4340: helpful when creating patches too.</p>
4341: </div>
1.148 asau 4342: <div class="sect2">
1.85 jmmv 4343: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4344: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4345: <p>Always, always, <span class="strong"><strong>always</strong></span>
4346: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4347: improvements you do to a package to the mainstream developers.
4348: This is the only way to get their attention on portability issues
4349: and to ensure that future versions can be built out-of-the box on
4350: NetBSD. Furthermore, any user that gets newer distfiles will get
4351: the fixes straight from the packaged code.</p>
1.93 rillig 4352: <p>This generally involves cleaning up the patches
4353: (because sometimes the patches that are
1.147 wiz 4354: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4355: appropriate trackers for the projects and working with the
4356: mainstream authors to accept your changes. It is
4357: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4358: the packages in pkgsrc are kept simple and thus further changes
4359: can be done without much hassle.</p>
1.130 wiz 4360: <p>When you have done this, please add a URL to the upstream
4361: bug report to the patch comment.</p>
1.85 jmmv 4362: <p>Support the idea of free software!</p>
4363: </div>
1.75 rillig 4364: </div>
1.148 asau 4365: <div class="sect1">
1.75 rillig 4366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4367: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 4368: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4369: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4370: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4371: any credits where they are due. Please bear in mind that others do not
4372: share your sense of humour (or spelling idiosyncrasies), and that others
4373: will read everything that you write here.</p></dd>
1.76 rillig 4374: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4375: <dd><p>This file governs the files that are installed on your
4376: system: all the binaries, manual pages, etc. There are other
4377: directives which may be entered in this file, to control the
4378: creation and deletion of directories, and the location of
1.110 hubertf 4379: 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 4380: information.</p></dd>
1.75 rillig 4381: </dl></div>
4382: </div>
1.148 asau 4383: <div class="sect1">
1.75 rillig 4384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4385: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 4386: <div class="sect2">
1.78 rillig 4387: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4388: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 4389: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4390: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4391: <dd>
1.189 snj 4392: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 4393: First time after package extraction and before files are
4394: moved in place, the second time after the files to install
4395: are moved in place. This can be used to do any custom
4396: procedures not possible with @exec commands in
1.189 snj 4397: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4398: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><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>.
1.135 wiz 4399: Please note that you can modify variables in it easily by using
4400: <code class="varname">FILES_SUBST</code> in the package's
4401: <code class="filename">Makefile</code>:</p>
4402: <pre class="programlisting">
4403: FILES_SUBST+= SOMEVAR="somevalue"
4404: </pre>
4405: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4406: <code class="filename">INSTALL</code>. By default, substitution is
4407: performed for <code class="varname">PREFIX</code>,
4408: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4409: <code class="varname">VARBASE</code>, and a few others, type
4410: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4411: complete list.</p>
4412: </dd>
1.76 rillig 4413: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4414: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4415: this script's responsibility to clean up any additional messy details
4416: around the package's installation, since all pkg_delete knows is how to
4417: delete the files created in the original distribution.
1.189 snj 4418: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4419: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135 wiz 4420: The same methods to replace variables can be used as for
4421: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4422: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4423: <dd>
4424: <p>This file is displayed after installation of the package.
1.87 wiz 4425: Useful for things like legal notices on almost-free
4426: software and hints for updating config files after
4427: installing modules for apache, PHP etc.
4428: Please note that you can modify variables in it easily by using
4429: <code class="varname">MESSAGE_SUBST</code> in the package's
4430: <code class="filename">Makefile</code>:</p>
1.75 rillig 4431: <pre class="programlisting">
1.100 rillig 4432: MESSAGE_SUBST+= SOMEVAR="somevalue"
4433: </pre>
1.128 wiz 4434: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4435: <code class="filename">MESSAGE</code>. By default, substitution is
4436: performed for <code class="varname">PKGNAME</code>,
4437: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4438: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4439: <code class="varname">X11BASE</code>,
4440: <code class="varname">PKG_SYSCONFDIR</code>,
4441: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4442: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4443: <p>You can display a different or additional files by
4444: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4445: default is <code class="filename">MESSAGE</code>, if the file
4446: exists.</p>
1.75 rillig 4447: </dd>
1.78 rillig 4448: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 4449: <dd>
4450: <p>This file is used by the alternatives framework.
4451: It creates, configures, and destroys generic wrappers used to
4452: run programs with similar interfaces.
4453: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4454: for more information.</p>
4455: <p>Each line of the file contains two filenames, first
4456: the wrapper and then the alternative provided by the package.
4457: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4458: </dd>
1.78 rillig 4459: </dl></div>
4460: </div>
1.148 asau 4461: <div class="sect2">
1.78 rillig 4462: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4463: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4464: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4465: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4466: <dd><p>This file contains arbitrary things that could
4467: also go into a <code class="filename">Makefile</code>, but its purpose is
4468: to be used by more than one package. This file should only be
4469: used when the packages that will use the file are known in
4470: advance. For other purposes it is often better to write a
4471: <code class="filename">*.mk</code> file and give it a good name that
4472: describes what it does.</p></dd>
4473: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4474: <dd><p>This file contains the dependency information
1.110 hubertf 4475: 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 4476: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4477: <dd><p>This file contains workarounds for compiler bugs
4478: and similar things. It is included automatically by the pkgsrc
4479: infrastructure, so you don't need an extra
4480: <code class="literal">.include</code> line for
4481: it.</p></dd>
4482: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4483: <dd><p>This file contains the code for the
1.110 hubertf 4484: 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 4485: selected by the user. If a package has only one or two options,
4486: it is equally acceptable to put the code directly into the
4487: <code class="filename">Makefile</code>.</p></dd>
4488: </dl></div>
4489: </div>
1.148 asau 4490: <div class="sect2">
1.78 rillig 4491: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4492: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4493: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4494: <dt><span class="term"><code class="filename">README*</code></span></dt>
4495: <dd><p>These files do not take place in the creation of
4496: a package and thus are purely informative to the package
4497: developer.</p></dd>
4498: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4499: <dd><p>This file contains things that need to be done
4500: to make the package even
4501: better.</p></dd>
1.75 rillig 4502: </dl></div>
4503: </div>
1.78 rillig 4504: </div>
1.148 asau 4505: <div class="sect1">
1.75 rillig 4506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4507: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4508: </h2></div></div></div>
1.110 hubertf 4509: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4510: unpacked into the directory denoted by
4511: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4512: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4513: directory is also used to keep various timestamp files.
4514: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4515: The default is <code class="filename">${.CURDIR}/work</code>
4516: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4517: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4518: </div>
1.148 asau 4519: <div class="sect1">
1.75 rillig 4520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4521: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4522: </h2></div></div></div>
1.75 rillig 4523: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4524: to configuration or building, you could place these files here and use
1.110 hubertf 4525: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4526: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4527: this. Alternatively, you could simply diff the file against
4528: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4529: the creation of this file.</p>
4530: <p>If you want to share files in this way with other
4531: packages, set the <code class="varname">FILESDIR</code> variable to point
4532: to the other package's <code class="filename">files</code> directory,
4533: e.g.:</p>
4534: <pre class="programlisting">
1.100 rillig 4535: FILESDIR=${.CURDIR}/../xemacs/files
4536: </pre>
1.75 rillig 4537: </div>
4538: </div>
1.148 asau 4539: <div class="chapter">
1.75 rillig 4540: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4541: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4542: <div class="toc">
4543: <p><b>Table of Contents</b></p>
1.195 wiz 4544: <dl class="toc">
1.106 rillig 4545: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4546: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4547: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4548: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4549: <dd><dl>
4550: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4551: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4552: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4553: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4554: <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 4555: </dl></dd>
4556: </dl>
4557: </div>
1.76 rillig 4558: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4559: each of which forms a well-defined part of the pkgsrc system. Using
1.189 snj 4560: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75 rillig 4561: like pkgsrc requires some discipline to keep the code correct and
4562: understandable.</p>
1.76 rillig 4563: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4564: programming are variables (which are actually macros) and shell
4565: commands. Among these shell commands may even be more complex ones
1.189 snj 4566: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75 rillig 4567: as intended it is necessary to quote all variables correctly when they
4568: are used.</p>
4569: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4570: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4571: with them.</p>
1.148 asau 4572: <div class="sect1">
1.75 rillig 4573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4574: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4575: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4576: <p>When you are creating a file as a
4577: target of a rule, always write the data to a temporary file first
4578: and finally rename that file. Otherwise there might occur an error
4579: in the middle of generating the file, and when the user runs
1.189 snj 4580: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><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 4581: regenerated properly. Example:</p>
4582: <pre class="programlisting">
1.100 rillig 4583: wrong:
4584: @echo "line 1" > ${.TARGET}
4585: @echo "line 2" >> ${.TARGET}
4586: @false
4587:
4588: correct:
4589: @echo "line 1" > ${.TARGET}.tmp
4590: @echo "line 2" >> ${.TARGET}.tmp
4591: @false
4592: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4593: </pre>
1.110 hubertf 4594: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4595: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4596: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4597: correct</strong></span> gives an error message twice, as expected.</p>
1.189 snj 4598: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4599: <code class="literal">${.TARGET}</code> in case of error, but this only
4600: happens when it is interrupted, for example by pressing
4601: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.189 snj 4602: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4603: </li></ul></div>
4604: </div>
1.148 asau 4605: <div class="sect1">
1.97 rillig 4606: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4607: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4608: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4609: can be processed using the five operators ``='', ``+='', ``?='',
1.189 snj 4610: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4611: page.</p>
4612: <p>When a variable's value is parsed from a
1.76 rillig 4613: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4614: backslash character ``\'' are handled specially. If a backslash is
4615: followed by a newline, any whitespace immediately in front of the
4616: backslash, the backslash, the newline, and any whitespace
4617: immediately behind the newline are replaced with a single space. A
4618: backslash character and an immediately following hash character are
4619: replaced with a single hash character. Otherwise, the backslash is
4620: passed as is. In a variable assignment, any hash character that is
4621: not preceded by a backslash starts a comment that continues upto the
4622: end of the logical line.</p>
4623: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4624: the only way to create a variable consisting of a single backslash
4625: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4626: <p>So far for defining variables. The other thing you can do with
4627: variables is evaluating them. A variable is evaluated when it is
4628: part of the right side of the ``:='' or the ``!='' operator, or
4629: directly before executing a shell command which the variable is part
1.189 snj 4630: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75 rillig 4631: is, variables are not evaluated until there's no other way. The
4632: ``modifiers'' mentioned in the man page also evaluate the
4633: variable.</p>
4634: <p>Some of the modifiers split the string into words and then
4635: operate on the words, others operate on the string as a whole. When
4636: a string is split into words, it is split as you would expect
1.189 snj 4637: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.126 jakllsch 4638: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4639: loop does not follow the shell quoting rules but splits at sequences
4640: of whitespace.</p>
4641: <p>There are several types of variables that should be handled
4642: differently. Strings and two types of lists.</p>
1.148 asau 4643: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4644: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4645: characters. Nevertheless, you should restrict yourself to only
4646: using printable characters. Examples are
4647: <code class="varname">PREFIX</code> and
4648: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4649: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4650: are never exported to any shell command. Their elements are
4651: separated by whitespace. Therefore, the elements themselves cannot
4652: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4653: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4654: Examples are <code class="varname">DEPENDS</code> and
4655: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4656: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4657: may be exported to a shell command. Their elements can contain any
4658: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4659: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4660: <code class="varname">DISTFILES</code> and
4661: <code class="varname">MASTER_SITES</code>.</p></li>
4662: </ul></div>
1.148 asau 4663: <div class="sect2">
1.75 rillig 4664: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4665: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4666: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4667: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4668: are reserved for use by the pkgsrc infrastructure. They shall
4669: not be used by package
1.76 rillig 4670: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4671: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4672: lowercase variable names for the iteration
4673: variables.</p></li>
1.128 wiz 4674: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4675: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4676: <code class="varname">DISTFILES</code>.</p></li>
4677: </ul></div>
4678: </div>
4679: </div>
1.148 asau 4680: <div class="sect1">
1.75 rillig 4681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4682: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4683: <p>This section presents you with some code snippets you should
4684: use in your own code. If you don't find anything appropriate here,
4685: you should test your code and add it here.</p>
1.148 asau 4686: <div class="sect2">
1.75 rillig 4687: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4688: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4689: <pre class="programlisting">
1.100 rillig 4690: STRING= foo * bar `date`
4691: INT_LIST= # empty
4692: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4693: EXT_LIST= # empty
4694: ANOTHER_EXT_LIST= a=b c=d
4695:
4696: INT_LIST+= ${STRING} # 1
4697: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4698: EXT_LIST+= ${STRING:Q} # 3
4699: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4700: </pre>
1.75 rillig 4701: <p>When you add a string to an external list (example 3), it
4702: must be quoted. In all other cases, you must not add a quoting
4703: level. You must not merge internal and external lists, unless you
4704: are sure that all entries are correctly interpreted in both
4705: lists.</p>
4706: </div>
1.148 asau 4707: <div class="sect2">
1.75 rillig 4708: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4709: <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 4710: <pre class="programlisting">
1.100 rillig 4711: EXT_LIST= # empty
4712: .for i in ${INT_LIST}
4713: EXT_LIST+= ${i:Q}""
4714: .endfor
1.1 grant 4715: </pre>
1.75 rillig 4716: <p>This code converts the internal list
4717: <code class="varname">INT_LIST</code> into the external list
4718: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4719: are unquoted they must be quoted here. The reason for appending
4720: <code class="varname">""</code> is explained below.</p>
4721: </div>
1.148 asau 4722: <div class="sect2">
1.75 rillig 4723: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4724: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4725: <p>Sometimes you may want to print an arbitrary string. There
4726: are many ways to get it wrong and only few that can handle every
4727: nastiness.</p>
1.75 rillig 4728: <pre class="programlisting">
1.100 rillig 4729: STRING= foo bar < > * `date` $$HOME ' "
4730: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4731:
1.100 rillig 4732: all:
4733: echo ${STRING} # 1
4734: echo "${STRING}" # 2
4735: echo "${STRING:Q}" # 3
4736: echo ${STRING:Q} # 4
4737: echo x${STRING:Q} | sed 1s,.,, # 5
4738: printf "%s\\n" ${STRING:Q}"" # 6
4739: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4740: </pre>
1.75 rillig 4741: <p>Example 1 leads to a syntax error in the shell, as the
4742: characters are just copied.</p>
4743: <p>Example 2 leads to a syntax error too, and if you leave out
4744: the last " character from <code class="varname">${STRING}</code>,
1.189 snj 4745: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75 rillig 4746: variable would be evaluated, too.</p>
4747: <p>Example 3 outputs each space character preceded by a
4748: backslash (or not), depending on the implementation of the
1.189 snj 4749: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75 rillig 4750: <p>Example 4 handles correctly every string that does not start
4751: with a dash. In that case, the result depends on the
1.189 snj 4752: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75 rillig 4753: guarantee that your input does not start with a dash, this form is
4754: appropriate.</p>
4755: <p>Example 5 handles even the case of a leading dash
4756: correctly.</p>
1.79 rillig 4757: <p>Example 6 also works with every string and is the
4758: light-weight solution, since it does not involve a pipe, which has
4759: its own problems.</p>
1.75 rillig 4760: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4761: because the quoting has already been done when adding elements to
4762: the list.</p>
4763: <p>As internal lists shall not be passed to the shell, there is
4764: no example for it.</p>
4765: </div>
1.148 asau 4766: <div class="sect2">
1.75 rillig 4767: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4768: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4769: <p>There are many possible sources of wrongly quoted variables.
4770: This section lists some of the commonly known ones.</p>
1.148 asau 4771: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4772: <li class="listitem">
1.75 rillig 4773: <p>Whenever you use the value of a list, think
4774: about what happens to leading or trailing whitespace. If the
4775: list is a well-formed shell expression, you can apply the
4776: <code class="varname">:M*</code> modifier to strip leading and trailing
4777: whitespace from each word. The <code class="varname">:M</code> operator
4778: first splits its argument according to the rules of the shell,
4779: and then creates a new list consisting of all words that match
4780: the shell glob expression <code class="varname">*</code>, that is: all.
4781: One class of situations where this is needed is when adding a
4782: variable like <code class="varname">CPPFLAGS</code> to
4783: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4784: invokes other configure scripts, it strips the leading and
4785: trailing whitespace from the variable and then passes it to the
4786: other configure scripts. But these configure scripts expect the
4787: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4788: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4789: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4790: here is how we do it:</p>
4791: <pre class="programlisting">
1.100 rillig 4792: CPPFLAGS= # empty
4793: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4794: CPPFLAGS+= ${MY_CPPFLAGS}
4795:
4796: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4797:
4798: all:
4799: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4800: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4801: </pre>
1.75 rillig 4802: </li>
1.128 wiz 4803: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 4804: <code class="varname">${PREFIX}</code> is a properly quoted shell
4805: expression, but there is the C compiler after it, which also
4806: expects a properly quoted string (this time in C syntax). The
4807: version above is therefore only correct if
4808: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4809: or double quotes. If you want to allow these, you have to add
4810: another layer of quoting to each variable that is used as a C
4811: string literal. You cannot use the <code class="varname">:Q</code>
4812: operator for it, as this operator only works for the
4813: shell.</p></li>
1.128 wiz 4814: <li class="listitem">
1.75 rillig 4815: <p>Whenever a variable can be empty, the
4816: <code class="varname">:Q</code> operator can have surprising results. Here
4817: are two completely different cases which can be solved with the
4818: same trick.</p>
4819: <pre class="programlisting">
1.100 rillig 4820: EMPTY= # empty
4821: empty_test:
4822: for i in a ${EMPTY:Q} c; do \
4823: echo "$$i"; \
4824: done
4825:
4826: for_test:
4827: .for i in a:\ a:\test.txt
4828: echo ${i:Q}
4829: echo "foo"
4830: .endfor
1.1 grant 4831: </pre>
1.75 rillig 4832: <p>The first example will only print two of the three lines
4833: we might have expected. This is because
4834: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4835: the shell cannot see. The workaround is to write
4836: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4837: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4838: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4839: <p>The second example will only print three lines instead of
4840: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4841: This is because the backslash of the value
4842: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.189 snj 4843: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
4844: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75 rillig 4845: <code class="varname">${i:Q}""</code>.</p>
4846: </li>
4847: </ul></div>
4848: </div>
1.148 asau 4849: <div class="sect2">
1.75 rillig 4850: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4851: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 4852: <p>The pkgsrc bmake program does not handle the following
4853: assignment correctly. In case <code class="varname">_othervar_</code>
4854: contains a ``-'' character, one of the closing braces is included
4855: in <code class="varname">${VAR}</code> after this code executes.</p>
4856: <pre class="programlisting">
1.100 rillig 4857: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 4858: </pre>
1.75 rillig 4859: <p>For a more complex code snippet and a workaround, see the
1.189 snj 4860: 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 4861: <code class="varname">bug1</code>.</p>
4862: </div>
4863: </div>
4864: </div>
1.148 asau 4865: <div class="chapter">
1.75 rillig 4866: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4867: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4868: <div class="toc">
4869: <p><b>Table of Contents</b></p>
1.195 wiz 4870: <dl class="toc">
1.106 rillig 4871: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4872: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4873: <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 4874: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4875: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4876: <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 4877: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 4878: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4879: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75 rillig 4880: </dl>
4881: </div>
1.87 wiz 4882: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4883: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4884: the package (relative to the <code class="filename">${PREFIX}</code>
4885: directory it's been installed in) plus some additional statements
1.189 snj 4886: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 4887: This chapter addresses some issues that need attention when
4888: dealing with the <code class="filename">PLIST</code> file (or files, see
4889: below!).</p>
1.148 asau 4890: <div class="sect1">
1.75 rillig 4891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4892: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4893: <p>Be sure to add a RCS ID line as the first thing in any
4894: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4895: <pre class="programlisting">
1.100 rillig 4896: @comment $NetBSD$
1.87 wiz 4897: </pre>
1.75 rillig 4898: </div>
1.148 asau 4899: <div class="sect1">
1.75 rillig 4900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4901: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4902: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4903: to output a PLIST that matches any new files since the package
1.110 hubertf 4904: 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 4905: more information on this target.</p>
1.75 rillig 4906: </div>
1.148 asau 4907: <div class="sect1">
1.75 rillig 4908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 4909: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4910: </h2></div></div></div>
1.87 wiz 4911: <p>If you have used any of the *-dirs packages, as explained in
1.197 wiz 4912: <a class="xref" href="#faq.common-dirs" title="13.9. Sharing directories between packages">Section 13.9, “Sharing directories between packages”</a>, you may have noticed that
1.110 hubertf 4913: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 4914: <code class="varname">@comment</code>s instead of real
4915: <code class="varname">@dirrm</code> lines. You can also do this for
4916: specific directories and files, so that the results of that
4917: command are very close to reality. This helps <span class="emphasis"><em>a
4918: lot</em></span> during the update of packages.</p>
4919: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4920: of AWK patterns and actions that are used to filter the output of
4921: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4922: scripting you like to it, but be careful with quoting.</p>
4923: <p>For example, to get all files inside the
4924: <code class="filename">libdata/foo</code> directory removed from the
4925: resulting PLIST:</p>
4926: <pre class="programlisting">
1.100 rillig 4927: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 4928: </pre>
4929: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4930: to a specific (shared) directory converted to
4931: <code class="varname">@comment</code>s:</p>
1.75 rillig 4932: <pre class="programlisting">
1.100 rillig 4933: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 4934: </pre>
1.75 rillig 4935: </div>
1.148 asau 4936: <div class="sect1">
1.75 rillig 4937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4938: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4939: <p>A number of variables are substituted automatically in
4940: PLISTs when a package is installed on a system. This includes the
4941: following variables:</p>
1.148 asau 4942: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4943: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4944: <dd>
4945: <p>Some packages like emacs and perl embed information
1.87 wiz 4946: about which architecture they were built on into the
4947: pathnames where they install their files. To handle this
4948: case, PLIST will be preprocessed before actually used, and
4949: the symbol
1.128 wiz 4950: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4951: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4952: same is done if the string
4953: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4954: PLIST somewhere - use this on packages that have GNU
4955: autoconf-created configure scripts.</p>
1.148 asau 4956: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4957: <h3 class="title">Legacy note</h3>
4958: <p>There used to be a symbol
1.128 wiz 4959: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4960: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4961: -m</strong></span>, but that's no longer supported and has
4962: been removed.</p>
1.75 rillig 4963: </div>
4964: </dd>
4965: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4966: <dd>
4967: <p>Some packages want to embed the OS name and version
1.87 wiz 4968: into some paths. To do this, use these variables in the
4969: <code class="filename">PLIST</code>:
4970: </p>
1.148 asau 4971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4972: <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>
4973: <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>
4974: <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 4975: </ul></div>
4976: </dd>
4977: </dl></div>
1.87 wiz 4978: <p>For a complete list of values which are replaced by
4979: default, please look in <code class="filename">bsd.pkg.mk</code> (and
4980: search for <code class="varname">PLIST_SUBST</code>).</p>
4981: <p>If you want to change other variables not listed above, you
4982: can add variables and their expansions to this variable in the
1.110 hubertf 4983: 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 4984: <pre class="programlisting">
1.100 rillig 4985: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 4986: </pre>
1.128 wiz 4987: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4988: in the <code class="filename">PLIST</code> with
1.128 wiz 4989: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4990: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4991: the common case of conditionally including some
4992: <code class="filename">PLIST</code> entries. It can be done by adding
4993: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 4994: setting the corresponding <code class="varname">PLIST.foo</code> variable
4995: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 4996: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 4997: in the <code class="filename">PLIST</code> with either
1.128 wiz 4998: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4999: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5000: For example, in <code class="filename">Makefile</code>:</p>
5001: <pre class="programlisting">
5002: PLIST_VARS+= foo
5003: .if <em class="replaceable"><code>condition</code></em>
5004: PLIST.foo= yes
5005: .else
5006: </pre>
5007: <p>And then in <code class="filename">PLIST</code>:</p>
5008: <pre class="programlisting">
5009: @comment $NetBSD$
5010: bin/bar
5011: man/man1/bar.1
5012: ${PLIST.foo}bin/foo
5013: ${PLIST.foo}man/man1/foo.1
5014: ${PLIST.foo}share/bar/foo.data
5015: ${PLIST.foo}@dirrm share/bar
5016: </pre>
1.75 rillig 5017: </div>
1.148 asau 5018: <div class="sect1">
1.75 rillig 5019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5020: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5021: <p>Man pages should be installed in compressed form if
1.87 wiz 5022: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5023: and uncompressed otherwise. To handle this in the
1.128 wiz 5024: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5025: appended/removed automatically for man pages according to
5026: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5027: or not, see above for details. This modification of the
5028: <code class="filename">PLIST</code> file is done on a copy of it, not
5029: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5030: </div>
1.148 asau 5031: <div class="sect1">
1.75 rillig 5032: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5033: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5034: </h2></div></div></div>
1.76 rillig 5035: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5036: in generating the binary package, set the variable
5037: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.189 snj 5038: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 5039: important. The default for <code class="varname">PLIST_SRC</code> is
5040: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5041: </div>
1.148 asau 5042: <div class="sect1">
1.75 rillig 5043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5044: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5045: <p>Some packages decide to install a different set of files based on
1.87 wiz 5046: the operating system being used. These differences can be
5047: automatically handled by using the following files:</p>
1.148 asau 5048: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5049: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5050: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5051: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5052: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5053: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5054: </ul></div>
5055: </div>
1.148 asau 5056: <div class="sect1">
1.75 rillig 5057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197 wiz 5058: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
5059: <p>Some packages decide to generate hard-to-guess file names
5060: during installation that are hard to wire down.</p>
5061: <p>In such cases, you can set the
5062: <code class="varname">GENERATE_PLIST</code> variable to shell code
5063: terminated (with a semicolon) that will output PLIST entries which
5064: will be appended to the PLIST</p>
5065: <p>You can find one example in editors/xemacs:</p>
5066: <pre class="programlisting">
5067: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
5068: </pre>
5069: <p>which will append something like
5070: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
5071: <code class="filename">PLIST</code>.
5072: </p>
5073: </div>
5074: <div class="sect1">
5075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5076: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5077: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5078: multiple (and unrelated) packages install files. These
1.125 wiz 5079: directories were problematic because you had to add special
5080: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5081: centralized package handle them.</p>
1.125 wiz 5082: <p>In pkgsrc, it is now easy: Each package should create
5083: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5084: will remove any directories left empty after uninstalling a
5085: package.</p>
5086: <p>If a package needs an empty directory to work, create
5087: the directory during installation as usual, and also add an
5088: entry to the PLIST:
5089: </p>
1.87 wiz 5090: <pre class="programlisting">
1.125 wiz 5091: @pkgdir path/to/empty/directory
1.87 wiz 5092: </pre>
1.125 wiz 5093: <p>
1.197 wiz 5094: or take a look at <code class="varname">MAKE_DIRS</code> and
5095: <code class="varname">OWN_DIRS</code>.
1.125 wiz 5096: </p>
1.75 rillig 5097: </div>
5098: </div>
1.148 asau 5099: <div class="chapter">
1.75 rillig 5100: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5101: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5102: <div class="toc">
5103: <p><b>Table of Contents</b></p>
1.195 wiz 5104: <dl class="toc">
1.106 rillig 5105: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5106: <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 5107: <dd><dl>
1.106 rillig 5108: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5109: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5110: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5111: and
5112: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5113: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5114: </dl></dd>
1.128 wiz 5115: <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 5116: <dd><dl>
1.128 wiz 5117: <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 5118: <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 5119: </dl></dd>
5120: </dl>
5121: </div>
5122: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5123: are seen by a package's configure and build processes. This is implemented
5124: in a two step process:</p>
1.128 wiz 5125: <div class="orderedlist"><ol class="orderedlist" type="1">
5126: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5127: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5128: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5129: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5130: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5131: <code class="option">-L${LOCALBASE}/lib</code> into references to
5132: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5133: native compiler on some operating systems look like GCC, so that
5134: packages that expect GCC won't require modifications to build with
5135: those native compilers.</p></li>
1.75 rillig 5136: </ol></div>
5137: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5138: package may be built consistently despite what other software may be
5139: installed. Please note that the normal system header and library paths,
5140: e.g. <code class="filename">/usr/include</code>,
5141: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5142: designed to insulate the package build from non-system-supplied
5143: software.</p>
1.148 asau 5144: <div class="sect1">
1.75 rillig 5145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5146: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5147: <p>The process of converting packages to use the buildlink3
1.128 wiz 5148: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5149: The things to keep in mind are:</p>
1.128 wiz 5150: <div class="orderedlist"><ol class="orderedlist" type="1">
5151: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5152: instead of the actual toolchain. Some packages are tricky,
5153: and the only way to know for sure is the check
5154: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5155: wrappers are being invoked.</p></li>
1.128 wiz 5156: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5157: the package Makefile, e.g. Java VMs, standalone shells,
5158: etc., because the code to symlink files into
5159: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5160: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5161: </p></li>
1.128 wiz 5162: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5163: <code class="filename">buildlink3.mk</code> files that you list in a
5164: package's Makefile are added as dependencies for that package.
5165: </p></li>
1.75 rillig 5166: </ol></div>
1.87 wiz 5167: <p>If a dependency on a particular package is required for its libraries and
5168: headers, then we replace:</p>
1.75 rillig 5169: <pre class="programlisting">
1.100 rillig 5170: DEPENDS+= foo>=1.1.0:../../category/foo
5171: </pre>
1.75 rillig 5172: <p>with</p>
5173: <pre class="programlisting">
1.100 rillig 5174: .include "../../category/foo/buildlink3.mk"
5175: </pre>
1.75 rillig 5176: <p>The buildlink3.mk files usually define the required dependencies.
5177: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5178: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5179: <pre class="programlisting">
1.100 rillig 5180: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5181: .include "../../category/foo/buildlink3.mk"
5182: </pre>
1.76 rillig 5183: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5184: files in <code class="filename">pkgsrc/mk</code>
5185: that handle special package issues:</p>
1.148 asau 5186: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5187: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5188: the native or a pkgsrc Berkeley DB implementation based on
5189: the values of <code class="varname">BDB_ACCEPTED</code> and
5190: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5191: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5192: comes with neither Curses nor NCurses, this will take care
1.189 snj 5193: 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 5194: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5195: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5196: adding a dependency on Heimdal or MIT-krb5 for packages that
5197: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5198: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5199: system-provided Motif installation or adds a dependency on
1.189 snj 5200: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</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 5201: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.151 obache 5202: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5203: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5204: which Motif version will be used.</p></li>
1.161 ryoon 5205: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 5206: system-provided GNU readline or editline (libedit) installation,
1.189 snj 5207: or adds a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
5208: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.161 ryoon 5209: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5210: If your package really needs GNU readline library, its Makefile
5211: should include <code class="filename">devel/readline/buildlink3.mk</code>
5212: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 5213: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5214: variables that may be used by packages that use the
5215: Open Sound System (OSS) API.</p></li>
1.128 wiz 5216: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5217: any of the Postgres versions in the variable
5218: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5219: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5220: the file for more information.</p></li>
1.128 wiz 5221: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5222: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.189 snj 5223: 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 5224: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5225: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5226: library.</p></li>
1.75 rillig 5227: </ul></div>
1.76 rillig 5228: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5229: files provide a more complete
5230: description of how to use them properly.</p>
1.75 rillig 5231: </div>
1.148 asau 5232: <div class="sect1">
1.75 rillig 5233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5234: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5235: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5236: included by Makefiles to indicate the need to compile and link
5237: against header files and libraries provided by the package. A
5238: <code class="filename">buildlink3.mk</code> file should always provide
5239: enough information to add the correct type of dependency
5240: relationship and include any other
5241: <code class="filename">buildlink3.mk</code> files that it needs to find
5242: headers and libraries that it needs in turn.</p>
5243: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.189 snj 5244: 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 5245: package is highly recommended. For most packages, the following
5246: command will generate a good starting point for
5247: <code class="filename">buildlink3.mk</code> files:</p>
5248: <pre class="screen">
5249: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5250: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5251: </pre>
1.148 asau 5252: <div class="sect2">
1.75 rillig 5253: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5254: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5255: <p>The following real-life example
1.87 wiz 5256: <code class="filename">buildlink3.mk</code> is taken
5257: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5258: <pre class="programlisting">
1.120 snj 5259: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5260:
1.120 snj 5261: BUILDLINK_TREE+= tiff
1.1 grant 5262:
1.120 snj 5263: .if !defined(TIFF_BUILDLINK3_MK)
5264: TIFF_BUILDLINK3_MK:=
1.87 wiz 5265:
1.120 snj 5266: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5267: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5268: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5269:
1.100 rillig 5270: .include "../../devel/zlib/buildlink3.mk"
5271: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5272: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5273:
1.120 snj 5274: BUILDLINK_TREE+= -tiff
1.100 rillig 5275: </pre>
1.87 wiz 5276: <p>The header and footer manipulate
1.120 snj 5277: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5278: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5279: the dependency tree.</p>
5280: <p>The main section is protected from multiple inclusion
1.87 wiz 5281: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5282: added. Several important variables are set in the section:</p>
1.148 asau 5283: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5284: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5285: is the actual dependency recorded in the installed
5286: package; this should always be set using
1.110 hubertf 5287: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5288: we're appending to any pre-existing list of values. This
5289: variable should be set to the first version of the
1.133 wiz 5290: package that had an backwards-incompatible API change.
1.87 wiz 5291: </p></li>
1.128 wiz 5292: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5293: is the location of the <em class="replaceable"><code>pkg</code></em>
5294: pkgsrc directory.</p></li>
1.128 wiz 5295: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5296: (not shown above) controls whether we use
5297: <code class="varname">BUILD_DEPENDS</code> or
5298: <code class="varname">DEPENDS</code> to add the dependency on
5299: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5300: selected by setting
5301: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5302: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5303: used.</p></li>
1.128 wiz 5304: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5305: and
5306: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5307: (not shown above) are lists of subdirectories of
1.76 rillig 5308: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5309: to add to the header and library search paths. These
1.128 wiz 5310: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5311: respectively.</p></li>
1.128 wiz 5312: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5313: (not shown above) is the list of preprocessor flags to add
5314: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5315: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5316: should be avoided and instead be handled using
5317: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5318: above.</p></li>
1.75 rillig 5319: </ul></div>
1.87 wiz 5320: <p>The following variables are all optionally defined within
5321: this second section (protected against multiple inclusion) and
5322: control which package files are symlinked into
5323: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5324: transformed during the symlinking:</p>
1.148 asau 5325: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5326: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5327: (not shown above) is a shell glob pattern relative to
1.76 rillig 5328: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5329: to be symlinked into
1.76 rillig 5330: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5331: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5332: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5333: (not shown above) is a shell pipeline that
5334: outputs to stdout a list of files relative to
5335: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5336: The resulting files are to be symlinked
5337: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5338: this takes the <code class="filename">+CONTENTS</code> of a
5339: <em class="replaceable"><code>pkg</code></em> and filters it through
5340: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5341: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5342: (not shown above) is a filter command that filters
1.76 rillig 5343: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5344: relative to
1.76 rillig 5345: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194 bsiegert 5346: on stdout. By default,
1.75 rillig 5347: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5348: outputs the contents of the <code class="filename">include</code>
5349: and <code class="filename">lib</code> directories in the package
1.194 bsiegert 5350: <code class="filename">+CONTENTS</code>.</p></li>
1.128 wiz 5351: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5352: (not shown above) is a list of sed arguments used to
5353: transform the name of the source filename into a
1.110 hubertf 5354: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5355: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5356: </ul></div>
1.120 snj 5357: <p>This section can additionally include any
1.87 wiz 5358: <code class="filename">buildlink3.mk</code> needed for
5359: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5360: Including these <code class="filename">buildlink3.mk</code> files
5361: means that the headers and libraries for these
5362: dependencies are also symlinked into
5363: <code class="filename">${BUILDLINK_DIR}</code>
5364: whenever the <em class="replaceable"><code>pkg</code></em>
5365: <code class="filename">buildlink3.mk</code>
1.120 snj 5366: file is included. Dependencies are only added for directly
5367: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 5368: <p>When providing a <code class="filename">buildlink3.mk</code> and
5369: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 5370: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 5371: header files are automatically exposed when the package is
5372: use.</p>
5373: <p>In particular, if only an executable
5374: (<code class="filename">bin/foo</code>) is linked against a library, that
5375: library does not need to be propagated in the
5376: <code class="filename">buildlink3.mk</code> file.</p>
5377: <p>The following steps should help you decide if a
5378: <code class="filename">buildlink3.mk</code> file needs to be included:
5379: </p>
5380: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5381: <li class="listitem"><p>Look at the installed header files: What
5382: headers do they include? The packages providing these files
5383: must be buildlinked.</p></li>
1.155 wiz 5384: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5385: libraries and look against what other libraries they link.
5386: Some of the packages providing these probably need to be
5387: buildlinked; however, it's not automatic, since e.g. GTK on
5388: some systems pulls in the X libraries, so they will show up in
5389: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 5390: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 5391: used as a hint.</p></li>
1.153 wiz 5392: </ul></div>
5393: <p>
5394: </p>
1.75 rillig 5395: </div>
1.148 asau 5396: <div class="sect2">
1.75 rillig 5397: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5398: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5399: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5400: and
5401: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5402: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5403: <p>These two variables differ in that one describes source
5404: compatibility (API) and the other binary compatibility (ABI).
5405: The difference is that a change in the API breaks compilation of
5406: programs while changes in the ABI stop compiled programs from
5407: running.</p>
5408: <p>Changes to the
1.134 wiz 5409: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5410: variable in a <code class="filename">buildlink3.mk</code> file happen
5411: very rarely. One possible reason is that all packages depending
5412: on this already need a newer version. In case it is bumped see
5413: the description below.</p>
5414: <p>The most common example of an ABI change is that the major
5415: version of a shared library is increased. In this case,
5416: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5417: should be adjusted to require at least the new package version.
5418: Then the packages that depend on this package need their
5419: <code class="varname">PKGREVISION</code>s increased and, if they have
5420: <code class="filename">buildlink3.mk</code> files, their
5421: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5422: adjusted, too. This is needed so pkgsrc will require the correct
5423: package dependency and not settle for an older one when building
5424: the source.</p>
1.110 hubertf 5425: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5426: more information about dependencies on other packages,
5427: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5428: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5429: <p>Please take careful consideration before adjusting
5430: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5431: or
5432: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5433: as we don't want to cause unneeded package deletions and
5434: rebuilds. In many cases, new versions of packages work just
5435: fine with older dependencies.</p>
5436: <p>Also it is not needed to set
1.133 wiz 5437: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5438: when it is identical to
1.87 wiz 5439: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5440: </div>
5441: </div>
1.148 asau 5442: <div class="sect1">
1.75 rillig 5443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5444: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5445: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5446: coincide with headers and libraries present in the base system.
1.76 rillig 5447: Aside from a <code class="filename">buildlink3.mk</code> file, these
5448: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5449: file that includes the necessary checks to decide whether using
5450: the built-in software or the pkgsrc software is
1.87 wiz 5451: appropriate.</p>
5452: <p>The only requirements of a builtin.mk file for
5453: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5454: <div class="orderedlist"><ol class="orderedlist" type="1">
5455: <li class="listitem"><p>It should set
1.87 wiz 5456: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5457: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5458: after it is included.</p></li>
1.128 wiz 5459: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5460: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5461: which is already set before the
5462: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5463: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5464: is <span class="emphasis"><em>very</em></span> important and takes careful
5465: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5466: </ol></div>
1.148 asau 5467: <div class="sect2">
1.75 rillig 5468: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5469: <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 5470: <p>The following is the recommended template for builtin.mk
1.87 wiz 5471: files:</p>
1.75 rillig 5472: <pre class="programlisting">
1.100 rillig 5473: .if !defined(IS_BUILTIN.foo)
5474: #
5475: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5476: # genuinely exists in the system or not.
5477: #
5478: IS_BUILTIN.foo?= no
5479:
5480: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5481: # version can be determined.
5482: #
5483: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5484: BUILTIN_PKG.foo?= foo-1.0
5485: . endif
5486: .endif # IS_BUILTIN.foo
5487:
5488: .if !defined(USE_BUILTIN.foo)
5489: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5490: . if defined(BUILTIN_PKG.foo)
5491: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5492: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5493: USE_BUILTIN.foo!= \
5494: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5495: && ${ECHO} "yes" || ${ECHO} "no"
5496: . endif
5497: . endfor
5498: . endif
5499: .endif # USE_BUILTIN.foo
5500:
5501: CHECK_BUILTIN.foo?= no
5502: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5503: #
5504: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5505: # "yes" or "no".
5506: #
5507: .endif # CHECK_BUILTIN.foo
5508: </pre>
1.87 wiz 5509: <p>The first section sets
5510: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5511: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5512: in the base system. This should not be a base system software
5513: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5514: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5515: included as part of the base system. This variable is only
5516: used internally within the <code class="filename">builtin.mk</code>
5517: file.</p>
5518: <p>The second section sets
5519: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5520: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5521: system if it exists (if
5522: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5523: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5524: within the <code class="filename">builtin.mk</code> file.</p>
5525: <p>The third section sets
5526: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5527: and is <span class="emphasis"><em>required</em></span> in all
5528: <code class="filename">builtin.mk</code> files. The code in this
5529: section must make the determination whether the built-in
5530: software is adequate to satisfy the dependencies listed in
5531: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5532: This is typically done by comparing
5533: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5534: against each of the dependencies in
5535: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5536: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5537: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5538: end of the <code class="filename">builtin.mk</code> file. Note that
5539: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5540: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5541: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5542: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5543: that the built-in version of the software is similar enough to
5544: be used as a replacement.</p>
5545: <p>The last section is guarded by
5546: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5547: and includes code that uses the value of
5548: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5549: set in the previous section. This typically includes, e.g.,
5550: adding additional dependency restrictions and listing additional
5551: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5552: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5553: </div>
1.148 asau 5554: <div class="sect2">
1.75 rillig 5555: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5556: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5557: <p>When building packages, it's possible to choose whether to set
5558: a global preference for using either the built-in (native)
5559: version or the pkgsrc version of software to satisfy a
5560: dependency. This is controlled by setting
5561: <code class="varname">PREFER_PKGSRC</code> and
5562: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5563: 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 5564: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5565: use the pkgsrc versions of software, while
5566: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5567: built-in versions. Preferences are determined by the most
5568: specific instance of the package in either
5569: <code class="varname">PREFER_PKGSRC</code> or
5570: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5571: in neither or in both variables, then
5572: <code class="varname">PREFER_PKGSRC</code> has precedence over
5573: <code class="varname">PREFER_NATIVE</code>. For example, to require
5574: using pkgsrc versions of software for all but the most basic
5575: bits on a NetBSD system, you can set:</p>
5576: <pre class="programlisting">
1.100 rillig 5577: PREFER_PKGSRC= yes
5578: PREFER_NATIVE= getopt skey tcp_wrappers
5579: </pre>
1.87 wiz 5580: <p>A package <span class="emphasis"><em>must</em></span> have a
5581: <code class="filename">builtin.mk</code>
5582: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5583: otherwise it is simply ignored in that list.</p>
1.75 rillig 5584: </div>
5585: </div>
5586: </div>
1.148 asau 5587: <div class="chapter">
1.75 rillig 5588: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5589: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5590: <div class="toc">
5591: <p><b>Table of Contents</b></p>
1.195 wiz 5592: <dl class="toc">
1.106 rillig 5593: <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 5594: <dd><dl>
1.106 rillig 5595: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5596: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5597: </dl></dd>
1.106 rillig 5598: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5599: <dd><dl>
1.128 wiz 5600: <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 5601: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5602: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5603: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5604: </dl></dd>
5605: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5606: <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>
5607: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5608: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5609: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5610: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5611: <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 5612: </dl>
5613: </div>
5614: <p>This chapter describes the framework known as
5615: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5616: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5617: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5618: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5619: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5620: provided that packages are correctly designed.</p></li>
1.128 wiz 5621: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5622: <li class="listitem"><p>Registration of system users and groups.</p></li>
5623: <li class="listitem"><p>Registration of system shells.</p></li>
5624: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5625: </ul></div>
5626: <p>The following sections inspect each of the above points in detail.</p>
5627: <p>You may be thinking that many of the things described here could be
5628: easily done with simple code in the package's post-installation target
5629: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5630: as the code in them is only executed when building from source. Machines
5631: using binary packages could not benefit from it at all (as the code itself
5632: could be unavailable). Therefore, the only way to achieve any of the items
5633: described above is by means of the installation scripts, which are
5634: automatically generated by pkginstall.</p>
1.148 asau 5635: <div class="sect1">
1.75 rillig 5636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5637: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5638: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5639: of files and directories that belong to a package. The names used in it
1.76 rillig 5640: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5641: which means that it cannot register files outside this directory (absolute
5642: path names are not allowed). Despite this restriction, some packages need
5643: to install files outside this location; e.g., under
1.76 rillig 5644: <code class="filename">${VARBASE}</code> or
1.87 wiz 5645: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5646: is to create such files during installation time by using
5647: installation scripts.</p>
5648: <p>The generic installation scripts are shell scripts that can
5649: contain arbitrary code. The list of scripts to execute is taken from
5650: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5651: <code class="filename">INSTALL</code>. A similar variable exists for package
5652: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5653: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5654: commands, so they have the potential to create and manage files
5655: anywhere in the file system.</p>
5656: <p>Using these general installation files is not recommended, but
5657: may be needed in some special cases. One reason for avoiding them is
5658: that the user has to trust the packager that there is no unwanted or
5659: simply erroneous code included in the installation script. Also,
5660: previously there were many similar scripts for the same functionality,
5661: and fixing a common error involved finding and changing all of
5662: them.</p>
5663: <p>The pkginstall framework offers another, standardized way. It
5664: provides generic scripts to abstract the manipulation of such files
5665: and directories based on variables set in the package's
5666: <code class="filename">Makefile</code>. The rest of this section describes
5667: these variables.</p>
1.148 asau 5668: <div class="sect2">
1.75 rillig 5669: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5670: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5671: <p>The following variables can be set to request the creation of
5672: directories anywhere in the file system:</p>
1.148 asau 5673: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5674: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5675: contain a list of directories that should be created and should attempt
5676: to be destroyed by the installation scripts. The difference between
5677: the two is that the latter prompts the administrator to remove any
5678: directories that may be left after deinstallation (because they were
5679: not empty), while the former does not.</p></li>
1.128 wiz 5680: <li class="listitem">
1.75 rillig 5681: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5682: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5683: which directories should be created and should attempt to be destroyed
5684: by the installation scripts. Each tuple holds the following values,
5685: separated by spaces: the directory name, its owner, its group and its
5686: numerical mode. For example:</p>
5687: <pre class="programlisting">
1.100 rillig 5688: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5689: </pre>
1.75 rillig 5690: <p>The difference between the two is exactly the same as their
5691: non-<code class="varname">PERMS</code> counterparts.</p>
5692: </li>
5693: </ul></div>
5694: </div>
1.148 asau 5695: <div class="sect2">
1.75 rillig 5696: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5697: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5698: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5699: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5700: To overcome this problem, the only solution is to extract the file in the
5701: known place (i.e., inside the installation prefix) and copy it to the
5702: appropriate location during installation (done by the installation scripts
5703: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5704: file</em></span> in the following paragraphs, which describe the variables
5705: that can be used to automatically and consistently handle files outside the
5706: installation prefix:</p>
1.148 asau 5707: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5708: <li class="listitem">
1.75 rillig 5709: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5710: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5711: During installation time, the master file is copied to the target one
5712: if and only if the latter does not exist. Upon deinstallation, the
5713: target file is removed provided that it was not modified by the
5714: installation.</p>
5715: <p>The difference between the two is that the latter prompts the
5716: administrator to remove any files that may be left after
5717: deinstallation (because they were not empty), while the former does
5718: not.</p>
5719: </li>
1.128 wiz 5720: <li class="listitem">
1.75 rillig 5721: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5722: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5723: files as well as their target locations. For each of them, it also
5724: specifies their owner, their group and their numeric permissions, in
5725: this order. For example:</p>
5726: <pre class="programlisting">
1.137 wiz 5727: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5728: </pre>
1.75 rillig 5729: <p>The difference between the two is exactly the same as their
5730: non-<code class="varname">PERMS</code> counterparts.</p>
5731: </li>
5732: </ul></div>
5733: </div>
5734: </div>
1.148 asau 5735: <div class="sect1">
1.75 rillig 5736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5737: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5738: <p>Configuration files are special in the sense that they are installed
5739: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5740: need special treatment during installation (most of which is automated by
5741: pkginstall). The main concept you must bear in mind is that files marked
5742: as configuration files are automatically copied to the right place (somewhere
5743: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5744: and only if</em></span> they didn't exist before. Similarly, they will not
5745: be removed if they have local modifications. This ensures that
5746: administrators never lose any custom changes they may have made.</p>
1.148 asau 5747: <div class="sect2">
1.75 rillig 5748: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5749: <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 5750: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5751: specifies where configuration files shall be installed. Its contents are
5752: set based upon the following variables:</p>
1.148 asau 5753: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5754: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5755: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5756: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5757: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5758: Packages must not use it directly.</p></li>
1.128 wiz 5759: <li class="listitem">
1.75 rillig 5760: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5761: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5762: for the package being built shall be installed. The definition of this
5763: variable only makes sense in the package's
1.76 rillig 5764: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5765: <p>As an example, consider the Apache package,
1.189 snj 5766: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.75 rillig 5767: configuration files under the
1.76 rillig 5768: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5769: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5770: Makefile.</p>
5771: </li>
1.128 wiz 5772: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5773: variable that holds this package's configuration directory (if
5774: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5775: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5776: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5777: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5778: directory where the configuration files for the package identified by
5779: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5780: </ul></div>
5781: <p>Based on the above variables, pkginstall determines the value of
5782: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5783: variable that can be used within a package to refer to its configuration
5784: directory. The algorithm used to set its value is basically the
5785: following:</p>
1.128 wiz 5786: <div class="orderedlist"><ol class="orderedlist" type="1">
5787: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5788: its value is used.</p></li>
1.128 wiz 5789: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5790: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5791: <code class="filename">Makefile</code>, the resulting value is
5792: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5793: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5794: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5795: </ol></div>
1.76 rillig 5796: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5797: 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
5798: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5799: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5800: </div>
1.148 asau 5801: <div class="sect2">
1.75 rillig 5802: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5803: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5804: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5805: known place, you need to teach each package where it shall install its
5806: files. In some cases you will have to patch the package Makefiles to
5807: achieve it. If you are lucky, though, it may be as easy as passing an
5808: extra flag to the configuration script; this is the case of GNU Autoconf-
5809: generated files:</p>
5810: <pre class="programlisting">
1.100 rillig 5811: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5812: </pre>
1.75 rillig 5813: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5814: for</em></span> its configuration files, not where they will be originally
5815: installed (although the difference is never explicit,
5816: unfortunately).</p>
5817: </div>
1.148 asau 5818: <div class="sect2">
1.75 rillig 5819: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5820: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5821: <p>As said before, pkginstall automatically handles configuration files.
5822: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5823: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5824: directly</strong></span>. Bad news is that many software installation scripts
5825: will, out of the box, mess with the contents of that directory. So what is
5826: the correct procedure to fix this issue?</p>
5827: <p>You must teach the package (usually by manually patching it) to
5828: install any configuration files under the examples hierarchy,
1.76 rillig 5829: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5830: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5831: has the original copies available.</p>
5832: <p>Once the required configuration files are in place (i.e., under the
5833: examples hierarchy), the pkginstall framework can use them as master copies
5834: during the package installation to update what is in
1.76 rillig 5835: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5836: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5837: 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 5838: about their syntax and their purpose. Here is an example, taken from the
1.189 snj 5839: <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 5840: <pre class="programlisting">
1.100 rillig 5841: EGDIR= ${PREFIX}/share/doc/mutt/samples
5842: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5843: </pre>
1.75 rillig 5844: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5845: package and has no meaning outside it.</p>
5846: </div>
1.148 asau 5847: <div class="sect2">
1.75 rillig 5848: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5849: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5850: <p>The automatic copying of config files can be toggled by setting the
5851: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5852: installation.</p>
5853: </div>
5854: </div>
1.148 asau 5855: <div class="sect1">
1.75 rillig 5856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5857: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5858: <p>System startup scripts are special files because they must be
5859: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5860: 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 5861: can be used. However, pkginstall provides a special mechanism to handle
5862: these files.</p>
5863: <p>In order to provide system startup scripts, the package has
5864: to:</p>
1.128 wiz 5865: <div class="orderedlist"><ol class="orderedlist" type="1">
5866: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5867: the <code class="literal">.sh</code> suffix appended. Considering the
1.189 snj 5868: <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 5869: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5870: <li class="listitem">
1.75 rillig 5871: <p>Tell pkginstall to handle it, appending the name of the script,
5872: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5873: Continuing the previous example:</p>
5874: <pre class="programlisting">
1.100 rillig 5875: RCD_SCRIPTS+= cupsd
1.1 grant 5876: </pre>
1.75 rillig 5877: </li>
5878: </ol></div>
5879: <p>Once this is done, pkginstall will do the following steps for each
5880: script in an automated fashion:</p>
1.128 wiz 5881: <div class="orderedlist"><ol class="orderedlist" type="1">
5882: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5883: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5884: variable.</p></li>
1.128 wiz 5885: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5886: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5887: that this master file must be explicitly registered in the
1.76 rillig 5888: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5889: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5890: from the examples hierarchy into the system-wide startup scripts
5891: directory.</p></li>
5892: </ol></div>
1.148 asau 5893: <div class="sect2">
1.75 rillig 5894: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5895: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5896: <p>The automatic copying of config files can be toggled by setting the
5897: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5898: installation. Note that the scripts will be always copied inside the
1.76 rillig 5899: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5900: matter what the value of this variable is.</p>
5901: </div>
5902: </div>
1.148 asau 5903: <div class="sect1">
1.75 rillig 5904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5905: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5906: <p>If a package needs to create special users and/or groups during
5907: installation, it can do so by using the pkginstall framework.</p>
5908: <p>Users can be created by adding entries to the
5909: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5910: syntax:</p>
5911: <pre class="programlisting">
1.100 rillig 5912: user:group
1.1 grant 5913: </pre>
1.87 wiz 5914: <p>Further specification of user details may be done by setting
5915: per-user variables.
5916: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5917: numeric UID for the user.
5918: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5919: user's description or comment.
5920: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5921: user's home directory, and defaults to
5922: <code class="filename">/nonexistent</code> if not specified.
5923: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5924: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5925: not specified.</p>
1.75 rillig 5926: <p>Similarly, groups can be created by adding entries to the
5927: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5928: <pre class="programlisting">
1.100 rillig 5929: group
1.1 grant 5930: </pre>
1.93 rillig 5931: <p>The numeric GID of the group may be set by defining
1.75 rillig 5932: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5933: <p>If a package needs to create the users and groups at an earlier
5934: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5935: either <code class="literal">configure</code> or <code class="literal">build</code> to
5936: indicate the phase before which the users and groups are created. In
5937: this case, the numeric UIDs and GIDs of the created users and groups
5938: are automatically hardcoded into the final installation scripts.</p>
5939: </div>
1.148 asau 5940: <div class="sect1">
1.75 rillig 5941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5942: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5943: <p>Packages that install system shells should register them in the shell
1.76 rillig 5944: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5945: administrator. This must be done from the installation scripts to keep
5946: binary packages working on any system. pkginstall provides an easy way to
5947: accomplish this task.</p>
5948: <p>When a package provides a shell interpreter, it has to set the
5949: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5950: add some hooks to the installation scripts to handle it. Consider the
1.189 snj 5951: 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 5952: <pre class="programlisting">
1.100 rillig 5953: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5954: </pre>
1.148 asau 5955: <div class="sect2">
1.75 rillig 5956: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5957: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5958: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5959: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5960: environment variable to <code class="literal">NO</code>.</p>
5961: </div>
5962: </div>
1.148 asau 5963: <div class="sect1">
1.75 rillig 5964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5965: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5966: <p>Packages that install X11 fonts should update the database files
5967: that index the fonts within each fonts directory. This can easily be
5968: accomplished within the pkginstall framework.</p>
5969: <p>When a package installs X11 fonts, it must list the directories in
5970: which fonts are installed in the
5971: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5972: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5973: <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 5974: installation scripts to run the appropriate commands to update the fonts
5975: database files within each of those directories. For convenience, if the
5976: directory path is relative, it is taken to be relative to the package's
1.189 snj 5977: 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 5978: <pre class="programlisting">
1.175 wiz 5979: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5980: </pre>
1.148 asau 5981: <div class="sect2">
1.75 rillig 5982: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5983: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5984: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5985: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5986: environment variable to <code class="literal">NO</code>.</p>
5987: </div>
5988: </div>
5989: </div>
1.148 asau 5990: <div class="chapter">
1.75 rillig 5991: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5992: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 5993: <div class="toc">
5994: <p><b>Table of Contents</b></p>
1.195 wiz 5995: <dl class="toc">
1.106 rillig 5996: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 5997: <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 5998: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 5999: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6000: </dl>
6001: </div>
6002: <p>Many packages have the ability to be built to support different
1.76 rillig 6003: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6004: in pkgsrc that provides generic handling of those options that
6005: determine different ways in which the packages can be built. It's
6006: possible for the user to specify exactly which sets of options will be
6007: built into a package or to allow a set of global default options
6008: apply.</p>
1.107 rillig 6009: <p>There are two broad classes of behaviors that one might want to
6010: control via options. One is whether some particular feature is
6011: enabled in a program that will be built anyway, often by including or
6012: not including a dependency on some other package. The other is
6013: whether or not an additional program will be built as part of the
6014: package. Generally, it is better to make a split package for such
6015: additional programs instead of using options, because it enables
6016: binary packages to be built which can then be added separately. For
6017: example, the foo package might have minimal dependencies (those
6018: packages without which foo doesn't make sense), and then the foo-gfoo
6019: package might include the GTK frontend program gfoo. This is better
6020: than including a gtk option to foo that adds gfoo, because either that
6021: option is default, in which case binary users can't get foo without
6022: gfoo, or not default, in which case they can't get gfoo. With split
6023: packages, they can install foo without having GTK, and later decide to
6024: install gfoo (pulling in GTK at that time). This is an advantage to
6025: source users too, avoiding the need for rebuilds.</p>
6026: <p>Plugins with widely varying dependencies should usually be split
6027: instead of options.</p>
6028: <p>It is often more work to maintain split packages, especially if
6029: the upstream package does not support this. The decision of split
6030: vs. option should be made based on the likelihood that users will want
6031: or object to the various pieces, the size of the dependencies that are
6032: included, and the amount of work.</p>
6033: <p>A further consideration is licensing. Non-free parts, or parts
6034: that depend on non-free dependencies (especially plugins) should
6035: almost always be split if feasible.</p>
1.148 asau 6036: <div class="sect1">
1.75 rillig 6037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6038: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6039: <p>Global default options are listed in
6040: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6041: that should be built into every package if that option is supported.
1.110 hubertf 6042: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6043: </div>
1.148 asau 6044: <div class="sect1">
1.75 rillig 6045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6046: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6047: </h2></div></div></div>
1.75 rillig 6048: <p>The following example shows how
1.76 rillig 6049: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6050: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6051: <code class="filename">Makefile</code>, or in a file,
6052: e.g. <code class="filename">options.mk</code>, that is included by the
6053: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6054: <pre class="programlisting">
1.100 rillig 6055: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6056: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6057: PKG_OPTIONS_OPTIONAL_GROUPS= database
6058: PKG_OPTIONS_GROUP.database= mysql pgsql
6059: PKG_SUGGESTED_OPTIONS= wibble-foo
6060: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6061: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6062:
6063: .include "../../mk/bsd.prefs.mk"
6064:
6065: # this package was previously named wibble2
6066: .if defined(PKG_OPTIONS.wibble2)
6067: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6068: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6069: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6070: .endif
6071:
6072: .include "../../mk/bsd.options.mk"
6073:
6074: # Package-specific option-handling
6075:
6076: ###
6077: ### FOO support
6078: ###
6079: .if !empty(PKG_OPTIONS:Mwibble-foo)
6080: CONFIGURE_ARGS+= --enable-foo
6081: .endif
6082:
6083: ###
6084: ### LDAP support
6085: ###
6086: .if !empty(PKG_OPTIONS:Mldap)
6087: . include "../../databases/openldap-client/buildlink3.mk"
6088: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6089: .endif
6090:
6091: ###
6092: ### database support
6093: ###
6094: .if !empty(PKG_OPTIONS:Mmysql)
6095: . include "../../mk/mysql.buildlink3.mk"
6096: .endif
6097: .if !empty(PKG_OPTIONS:Mpgsql)
6098: . include "../../mk/pgsql.buildlink3.mk"
6099: .endif
1.75 rillig 6100: </pre>
6101: <p>The first section contains the information about which build
6102: options are supported by the package, and any default options settings
6103: if needed.</p>
1.128 wiz 6104: <div class="orderedlist"><ol class="orderedlist" type="1">
6105: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.189 snj 6106: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75 rillig 6107: options. It should be set to
1.78 rillig 6108: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6109: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6110: at the point where the options are processed.</p></li>
1.128 wiz 6111: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6112: build options supported by the package.</p></li>
1.128 wiz 6113: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6114: list of names of groups of mutually exclusive options. The options in
6115: each group are listed in
6116: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6117: The most specific setting of any option from the group takes
6118: precedence over all other options in the group. Options from the
6119: groups will be automatically added to
6120: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6121: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6122: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6123: packages will fail if no option from the group is
6124: selected.</p></li>
1.128 wiz 6125: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6126: of names of sets of options. At least one option from each set must
6127: be selected. The options in each set are listed in
6128: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6129: Options from the sets will be automatically added to
6130: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6131: fail if no option from the set is selected.</p></li>
1.128 wiz 6132: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6133: build options which are enabled by default.</p></li>
1.128 wiz 6134: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6135: of
1.128 wiz 6136: <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 6137: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6138: their option counterparts. Pairs should be added with
1.128 wiz 6139: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6140: warning will be issued if the user uses a legacy
6141: variable.</p></li>
1.128 wiz 6142: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6143: of
1.128 wiz 6144: <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 6145: pairs that map options that have been renamed to their new
1.128 wiz 6146: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6147: the listing of global legacy options. A warning will be issued if
6148: the user uses a legacy option.</p></li>
1.128 wiz 6149: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6150: options implied by deprecated variables used. This can be used for
6151: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6152: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6153: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6154: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6155: a list of warnings about deprecated variables or options used, and
6156: what to use instead.</p></li>
6157: </ol></div>
6158: <p>A package should never modify
6159: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6160: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6161: To suggest a default set of options, use
6162: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6163: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6164: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6165: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6166: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6167: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6168: happen with platform-specific options if none of them is supported on
6169: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6170: empty list and the package is otherwise treated as not using the
6171: options framework.</p>
1.76 rillig 6172: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6173: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6174: build options, properly filtered to remove unsupported and duplicate
6175: options.</p>
6176: <p>The remaining sections contain the logic that is specific to
6177: each option. The correct way to check for an option is to check
6178: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6179: <pre class="programlisting">
1.100 rillig 6180: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6181: </pre>
6182: </div>
1.148 asau 6183: <div class="sect1">
1.75 rillig 6184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6185: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6186: <p>Options that enable similar features in different packages (like
6187: optional support for a library) should use a common name in all
6188: packages that support it (like the name of the library). If another
6189: package already has an option with the same meaning, use the same
6190: name.</p>
6191: <p>Options that enable features specific to one package, where it's
6192: unlikely that another (unrelated) package has the same (or a similar)
6193: optional feature, should use a name prefixed with
6194: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6195: <p>If a group of related packages share an optional feature
6196: specific to that group, prefix it with the name of the
1.128 wiz 6197: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6198: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6199: <p>For new options, add a line to
1.76 rillig 6200: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6201: fields, separated by tab. The first field is the option name, the
6202: second its description. The description should be a whole sentence
6203: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6204: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6205: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6206: </div>
1.148 asau 6207: <div class="sect1">
1.107 rillig 6208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6209: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6210: <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 6211: different dependencies based on the options with which the package was
6212: built. For querying these options, the file
6213: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6214: typical example looks like this:</p>
6215: <pre class="programlisting">
6216: pkgbase := libpurple
6217: .include "../../mk/pkg-build-options.mk"
6218:
6219: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6220: ...
6221: .endif
6222: </pre>
6223: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6224: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6225: options of the libpurple package, which can then be queried like
6226: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6227: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6228: details.</p>
6229: </div>
1.75 rillig 6230: </div>
1.148 asau 6231: <div class="chapter">
1.75 rillig 6232: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6233: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6234: <div class="toc">
6235: <p><b>Table of Contents</b></p>
1.195 wiz 6236: <dl class="toc">
1.106 rillig 6237: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6238: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6239: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6240: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6241: <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 6242: <dd><dl>
6243: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6244: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6245: </dl></dd>
1.128 wiz 6246: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6247: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6248: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6249: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6250: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6251: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6252: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6253: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6254: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6255: <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 6256: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6257: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6258: </dl>
6259: </div>
1.148 asau 6260: <div class="sect1">
1.75 rillig 6261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6262: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6263: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6264: built. Building a package is separated into different
6265: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6266: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6267: described in the following sections. Each phase is split into
1.87 wiz 6268: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6269: containing phase, prefixed by one of <code class="varname">pre-</code>,
6270: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6271: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6272: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6273: <p>Never override the regular targets (like
6274: <code class="varname">fetch</code>), if you have to, override the
6275: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6276: <p>The basic steps for building a program are always the same. First
1.87 wiz 6277: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6278: the local system and then extracted. After any pkgsrc-specific patches
6279: to compile properly are applied, the software can be configured, then
6280: built (usually by compiling), and finally the generated binaries, etc.
6281: can be put into place on the system.</p>
1.97 rillig 6282: <p>To get more details about what is happening at each step,
6283: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6284: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6285: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6286: </div>
1.148 asau 6287: <div class="sect1">
1.75 rillig 6288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6289: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6290: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6291: the next section, here's a brief discussion on where programs are
6292: installed, and which variables influence this.</p>
1.75 rillig 6293: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6294: where all files of the final program shall be installed. It is
6295: usually set to <code class="varname">LOCALBASE</code>
6296: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6297: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6298: <code class="varname">PREFIX</code> needs to be put
6299: into the various places in the program's source where paths to
1.110 hubertf 6300: 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 6301: <p>When choosing which of these variables to use,
1.87 wiz 6302: follow the following rules:</p>
1.148 asau 6303: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6304: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6305: where the current pkg will be installed. When referring to a
6306: pkg's own installation path, use
1.128 wiz 6307: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6308: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6309: are installed. If you need to construct a -I or -L argument
6310: to the compiler to find includes and libraries installed by
1.128 wiz 6311: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6312: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6313: installed all packages in <code class="filename">/usr/local</code>. As
6314: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6315: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6316: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6317: distribution (from xsrc, etc.) is installed. When looking for
6318: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6319: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6320: <li class="listitem">
1.88 wiz 6321: <p>X11-based packages are special in that they may be
6322: installed in either <code class="varname">X11BASE</code> or
6323: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6324: <p>Usually, X11 packages should be installed under
1.88 wiz 6325: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6326: will need to include
6327: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6328: request the presence of X11 and to get the right compilation
6329: flags.</p>
1.75 rillig 6330: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6331: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6332: files. These packages are special and they must be placed under
6333: <code class="varname">X11BASE</code>. To accomplish this, set either
6334: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6335: your package.</p>
1.75 rillig 6336: <p>Some notes: If you need
1.87 wiz 6337: to find includes or libraries installed by a pkg that has
6338: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6339: its pkg <code class="filename">Makefile</code>, you need to look in
6340: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6341: <code class="filename">${LOCALBASE}</code>. To force installation of
6342: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.189 snj 6343: <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 6344: is enabled by default.</p>
1.75 rillig 6345: </li>
1.128 wiz 6346: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6347: the installed location of an X11
6348: package. <code class="varname">X11PREFIX</code> will be set to
6349: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6350: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6351: installed.</p></li>
1.128 wiz 6352: <li class="listitem">
1.88 wiz 6353: <p>If xpkgwedge is installed, it is possible to have some
6354: packages installed in <code class="varname">X11BASE</code> and some in
6355: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6356: installed package, the <code class="varname">EVAL_PREFIX</code>
6357: definition can be used. It takes pairs in the format
1.189 snj 6358: <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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 6359: variable <code class="varname">DIRNAME</code> will be set to the prefix
6360: of the installed package <package>, or
1.128 wiz 6361: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6362: installed.</p>
1.75 rillig 6363: <p>This is best illustrated by example.</p>
6364: <p>The following lines are taken from
1.87 wiz 6365: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6366: <pre class="programlisting">
1.100 rillig 6367: EVAL_PREFIX+= GTKDIR=gtk+
6368: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6369: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6370: CONFIGURE_ARGS+= --enable-multibyte
6371: </pre>
1.88 wiz 6372: <p>Specific defaults can be defined for the packages
6373: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6374: definition of the form:</p>
1.75 rillig 6375: <pre class="programlisting">
1.100 rillig 6376: GTKDIR_DEFAULT= ${LOCALBASE}
6377: </pre>
1.75 rillig 6378: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6379: to the first definition in
6380: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6381: </li>
1.128 wiz 6382: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.189 snj 6383: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 6384: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6385: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6386: </ul></div>
6387: </div>
1.148 asau 6388: <div class="sect1">
1.75 rillig 6389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6390: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6391: <p>When building a package, various directories are used to store
1.87 wiz 6392: source files, temporary files, pkgsrc-internal files, and so on. These
6393: directories are explained here.</p>
1.75 rillig 6394: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6395: are two common base directories for these relative directories:
6396: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6397: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6398: inside the package itself.</p>
1.148 asau 6399: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6400: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6401: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6402: root directory. Generally, you don't need
6403: it.</p></dd>
1.97 rillig 6404: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6405: <dd><p>This is an absolute pathname that points to the
6406: current package.</p></dd>
1.75 rillig 6407: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6408: <dd><p>This is a pathname relative to
1.87 wiz 6409: <code class="varname">PKGSRCDIR</code> that points to the current
6410: package.</p></dd>
1.75 rillig 6411: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6412: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6413: where all work takes place. The distfiles are extracted to this
1.87 wiz 6414: directory. It also contains temporary directories and log files used by
6415: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6416: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6417: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6418: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6419: where the distfiles are extracted. It is usually a direct subdirectory
6420: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6421: that isn't hidden. This variable may be changed by a package
6422: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6423: </dl></div>
1.114 jmcneill 6424: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6425: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6426: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6427: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6428: If users would like to have their pkgsrc trees behave in a
6429: read-only manner, then the value of
6430: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6431: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6432: </div>
1.148 asau 6433: <div class="sect1">
1.75 rillig 6434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6435: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6436: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6437: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6438: phase. This will automatically run all phases that are required for this
6439: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6440: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6441: the package will be built, but not installed.</p>
1.75 rillig 6442: </div>
1.148 asau 6443: <div class="sect1">
1.75 rillig 6444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6445: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6446: <p>The first step in building a package is to fetch the
1.88 wiz 6447: distribution files (distfiles) from the sites that are providing
6448: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6449: phase.</p>
1.148 asau 6450: <div class="sect2">
1.81 rillig 6451: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6452: <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 6453: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6454: defines all URLs from where the distfile, whose name is
6455: derived from the <code class="varname">DISTNAME</code> variable, is
6456: fetched. The more complicated cases are described
6457: below.</p>
6458: <p>The variable <code class="varname">DISTFILES</code> specifies
6459: the list of distfiles that have to be fetched. Its value
1.174 asau 6460: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6461: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 6462: so that most packages don't need to define it at all.
6463: <code class="varname">EXTRACT_SUFX</code> is
6464: <code class="literal">.tar.gz</code> by default, but can be changed
6465: freely. Note that if your package requires additional
6466: distfiles to the default one, you cannot just append the
6467: additional filenames using the <code class="literal">+=</code>
6468: operator, but you have write for example:</p>
1.81 rillig 6469: <pre class="programlisting">
1.174 asau 6470: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 6471: </pre>
1.88 wiz 6472: <p>Each distfile is fetched from a list of sites, usually
6473: <code class="varname">MASTER_SITES</code>. If the package has multiple
6474: <code class="varname">DISTFILES</code> or multiple
6475: <code class="varname">PATCHFILES</code> from different sites, you can
6476: set
6477: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6478: to the list of URLs where the file
6479: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6480: (including the suffix) can be found.</p>
6481: <pre class="programlisting">
1.100 rillig 6482: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6483: DISTFILES+= foo-file.tar.gz
6484: SITES.foo-file.tar.gz= \
6485: http://www.somewhere.com/somehow/ \
6486: http://www.somewhereelse.com/mirror/somehow/
6487: </pre>
1.81 rillig 6488: <p>When actually fetching the distfiles, each item from
1.88 wiz 6489: <code class="varname">MASTER_SITES</code> or
6490: <code class="varname">SITES.*</code> gets the name of each distfile
6491: appended to it, without an intermediate slash. Therefore,
6492: all site values have to end with a slash or other separator
6493: character. This allows for example to set
6494: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6495: that gets the name of the distfile as a parameter. In this
6496: case, the definition would look like:</p>
1.81 rillig 6497: <pre class="programlisting">
1.100 rillig 6498: MASTER_SITES= http://www.example.com/download.cgi?file=
6499: </pre>
1.125 wiz 6500: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 6501: In that case the URL is taken as is, fetched and the result
6502: stored under the name of the distfile. You can use this style
6503: for the case when the download URL style does not match the
6504: above common case. For example, if permanent download URL is a
6505: redirector to the real download URL, or the download file name
6506: is offered by an HTTP Content-Disposition header. In the
6507: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6508: created instead of the default
6509: <code class="filename">v1.0.0.tar.gz</code>.</p>
6510: <pre class="programlisting">
6511: DISTNAME= foo-1.0.0
6512: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6513: </pre>
1.81 rillig 6514: <p>There are some predefined values for
1.88 wiz 6515: <code class="varname">MASTER_SITES</code>, which can be used in
6516: packages. The names of the variables should speak for
6517: themselves.</p>
6518: <pre class="programlisting">
1.100 rillig 6519: ${MASTER_SITE_APACHE}
6520: ${MASTER_SITE_BACKUP}
6521: ${MASTER_SITE_CYGWIN}
6522: ${MASTER_SITE_DEBIAN}
6523: ${MASTER_SITE_FREEBSD}
6524: ${MASTER_SITE_FREEBSD_LOCAL}
6525: ${MASTER_SITE_GENTOO}
6526: ${MASTER_SITE_GNOME}
6527: ${MASTER_SITE_GNU}
6528: ${MASTER_SITE_GNUSTEP}
1.174 asau 6529: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 6530: ${MASTER_SITE_IFARCHIVE}
6531: ${MASTER_SITE_KDE}
6532: ${MASTER_SITE_MOZILLA}
1.174 asau 6533: ${MASTER_SITE_MOZILLA_ALL}
6534: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 6535: ${MASTER_SITE_MYSQL}
1.174 asau 6536: ${MASTER_SITE_NETLIB}
1.100 rillig 6537: ${MASTER_SITE_OPENOFFICE}
6538: ${MASTER_SITE_PERL_CPAN}
6539: ${MASTER_SITE_PGSQL}
1.174 asau 6540: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 6541: ${MASTER_SITE_R_CRAN}
6542: ${MASTER_SITE_SOURCEFORGE}
6543: ${MASTER_SITE_SOURCEFORGE_JP}
6544: ${MASTER_SITE_SUNSITE}
6545: ${MASTER_SITE_SUSE}
6546: ${MASTER_SITE_TEX_CTAN}
6547: ${MASTER_SITE_XCONTRIB}
6548: ${MASTER_SITE_XEMACS}
1.174 asau 6549: ${MASTER_SITE_XORG}
1.100 rillig 6550: </pre>
1.88 wiz 6551: <p>Some explanations for the less self-explaining ones:
6552: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6553: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.132 spz 6554: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.88 wiz 6555: <p>If you choose one of these predefined sites, you may
6556: want to specify a subdirectory of that site. Since these
6557: macros may expand to more than one actual site, you
6558: <span class="emphasis"><em>must</em></span> use the following construct to
6559: specify a subdirectory:</p>
1.81 rillig 6560: <pre class="programlisting">
1.100 rillig 6561: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6562: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6563: </pre>
1.81 rillig 6564: <p>Note the trailing slash after the subdirectory
1.88 wiz 6565: name.</p>
1.81 rillig 6566: </div>
1.148 asau 6567: <div class="sect2">
1.81 rillig 6568: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6569: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6570: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6571: all the distfiles exist in a local directory
1.93 rillig 6572: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6573: user). If the files do not exist, they are fetched using
6574: commands of the form</p>
1.75 rillig 6575: <pre class="programlisting">
1.100 rillig 6576: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6577: </pre>
1.88 wiz 6578: <p>where <code class="literal">${site}</code> varies through
6579: several possibilities in turn: first,
6580: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6581: sites specified in either <code class="varname">SITES.file</code> if
6582: defined, else <code class="varname">MASTER_SITES</code> or
6583: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6584: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6585: all except the first and the last can be optionally sorted
6586: by the user, via setting either
6587: <code class="varname">MASTER_SORT_RANDOM</code>, and
6588: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6589: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6590: <p> The specific command and arguments used depend on the
6591: <code class="varname">FETCH_USING</code> parameter. The example above is
6592: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6593: <p>The distfiles mirror run by the NetBSD Foundation uses the
6594: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6595: distfiles, if they are freely distributable. Packages setting
6596: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6597: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6598: mirrored.</p>
1.81 rillig 6599: </div>
1.75 rillig 6600: </div>
1.148 asau 6601: <div class="sect1">
1.75 rillig 6602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6603: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6604: <p>After the distfile(s) are fetched, their checksum is
6605: generated and compared with the checksums stored in the
6606: distinfo file. If the checksums don't match, the build is
6607: aborted. This is to ensure the same distfile is used for
6608: building, and that the distfile wasn't changed, e.g. by some
6609: malign force, deliberately changed distfiles on the master
6610: distribution site or network lossage.</p>
1.75 rillig 6611: </div>
1.148 asau 6612: <div class="sect1">
1.75 rillig 6613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6614: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6615: <p>When the distfiles are present on the local system, they
1.88 wiz 6616: need to be extracted, as they usually come in the form of some
6617: compressed archive format.</p>
1.75 rillig 6618: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6619: extracted. If you only need some of them, you can set the
6620: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6621: files.</p>
6622: <p>Extracting the files is usually done by a little
1.93 rillig 6623: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6624: already knows how to extract various archive formats, so most
6625: likely you will not need to change anything here. But if you
6626: need, the following variables may help you:</p>
1.148 asau 6627: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6628: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6629: <dd><p>Use these variables to override the default
1.88 wiz 6630: options for an extract command, which are defined in
1.93 rillig 6631: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6632: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6633: <dd><p>This variable can be set to
1.114 jmcneill 6634: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6635: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6636: absolute pathname pointing to the command with which tar
1.114 jmcneill 6637: archives should be extracted. It is preferred to choose bsdtar over gtar
6638: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6639: </dl></div>
1.88 wiz 6640: <p>If the <code class="filename">extract</code> program doesn't
6641: serve your needs, you can also override the
6642: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6643: command used for extracting the files. This command is
6644: executed in the <code class="filename">${WRKSRC}</code>
6645: directory. During execution of this command, the shell
6646: variable <code class="varname">extract_file</code> holds the absolute
6647: pathname of the file that is going to be extracted.</p>
1.75 rillig 6648: <p>And if that still does not suffice, you can override the
1.88 wiz 6649: <code class="varname">do-extract</code> target in the package
6650: Makefile.</p>
1.75 rillig 6651: </div>
1.148 asau 6652: <div class="sect1">
1.75 rillig 6653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6654: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6655: <p>After extraction, all the patches named by the
1.88 wiz 6656: <code class="varname">PATCHFILES</code>, those present in the patches
6657: subdirectory of the package as well as in
6658: $LOCALPATCHES/$PKGPATH (e.g.
6659: <code class="filename">/usr/local/patches/graphics/png</code>) are
6660: applied. Patchfiles ending in <code class="filename">.Z</code> or
6661: <code class="filename">.gz</code> are uncompressed before they are
6662: applied, files ending in <code class="filename">.orig</code> or
6663: <code class="filename">.rej</code> are ignored. Any special options to
1.189 snj 6664: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.110 hubertf 6665: <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>
1.189 snj 6666: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 6667: it fail if the patches apply with some lines of fuzz. Please
6668: fix (regen) the patches so that they apply cleanly. The
6669: rationale behind this is that patches that don't apply cleanly
6670: may end up being applied in the wrong place, and cause severe
6671: harm there.</p>
1.75 rillig 6672: </div>
1.148 asau 6673: <div class="sect1">
1.75 rillig 6674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6675: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6676: <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 6677: </p>
1.75 rillig 6678: </div>
1.148 asau 6679: <div class="sect1">
1.75 rillig 6680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6681: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6682: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6683: linkers. The following variables can be used to tweak the
6684: wrappers.</p>
1.148 asau 6685: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6686: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6687: <dd><p>The command used to print progress
1.88 wiz 6688: messages. Does nothing by default. Set to
6689: <code class="literal">${ECHO}</code> to see the progress
6690: messages.</p></dd>
1.75 rillig 6691: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6692: <dd><p>This variable can be set to
1.88 wiz 6693: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6694: depending on whether you want additional information in the
6695: wrapper log file.</p></dd>
1.75 rillig 6696: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6697: <dd><p>This variable can be set to
1.88 wiz 6698: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6699: on whether the wrapper should use its cache, which will
6700: improve the speed. The default value is
6701: <code class="literal">yes</code>, but is forced to
6702: <code class="literal">no</code> if the platform does not support
6703: it.</p></dd>
1.75 rillig 6704: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6705: <dd><p>A list of reordering commands. A reordering
6706: command has the form
6707: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6708: It ensures that that
6709: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6710: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6711: </p></dd>
1.75 rillig 6712: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6713: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6714: investigate further]</p></dd>
1.75 rillig 6715: </dl></div>
6716: </div>
1.148 asau 6717: <div class="sect1">
1.75 rillig 6718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6719: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6720: <p>Most pieces of software need information on the header
6721: files, system calls, and library routines which are available
6722: on the platform they run on. The process of determining this
6723: information is known as configuration, and is usually
6724: automated. In most cases, a script is supplied with the
6725: distfiles, and its invocation results in generation of header
6726: files, Makefiles, etc.</p>
6727: <p>If the package contains a configure script, this can be
6728: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6729: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6730: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6731: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6732: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6733: <pre class="programlisting">
1.100 rillig 6734: .for d in ${CONFIGURE_DIRS}
6735: cd ${WRKSRC} \
6736: && cd ${d} \
6737: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6738: .endfor
6739: </pre>
1.88 wiz 6740: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6741: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6742: <code class="varname">WRKSRC</code>. In each of these directories, the
6743: configure script is run with the environment
6744: <code class="varname">CONFIGURE_ENV</code> and arguments
6745: <code class="varname">CONFIGURE_ARGS</code>. The variables
6746: <code class="varname">CONFIGURE_ENV</code>,
6747: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6748: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6749: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6750: package.</p>
1.144 wiz 6751: <p>If the program uses the Perl way of configuration (mainly Perl
6752: modules, but not only), i.e. a file called
6753: <code class="filename">Makefile.PL</code>, it should include
6754: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6755: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6756: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6757: <p>If the program uses an <code class="filename">Imakefile</code>
6758: for configuration, the appropriate steps can be invoked by
6759: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6760: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6761: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6762: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6763: xmkmf's environment by adding them to the
6764: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6765: <p>If the program uses <code class="filename">cmake</code>
6766: for configuration, the appropriate steps can be invoked by
1.128 wiz 6767: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6768: You can add variables to cmake's environment by adding them to the
6769: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6770: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6771: The top directory argument is given by the
6772: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6773: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6774: <p>If there is no configure step at all, set
1.128 wiz 6775: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6776: </div>
1.148 asau 6777: <div class="sect1">
1.75 rillig 6778: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6779: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6780: <p>For building a package, a rough equivalent of the
6781: following code is executed.</p>
1.75 rillig 6782: <pre class="programlisting">
1.100 rillig 6783: .for d in ${BUILD_DIRS}
6784: cd ${WRKSRC} \
6785: && cd ${d} \
6786: && env ${MAKE_ENV} \
6787: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6788: -f ${MAKE_FILE} \
6789: ${BUILD_TARGET}
6790: .endfor
6791: </pre>
1.88 wiz 6792: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6793: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6794: <code class="varname">WRKSRC</code>. In each of these directories,
6795: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6796: <code class="varname">MAKE_ENV</code> and arguments
6797: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6798: <code class="varname">MAKE_ENV</code>,
6799: <code class="varname">BUILD_MAKE_FLAGS</code>,
6800: <code class="varname">MAKE_FILE</code> and
6801: <code class="varname">BUILD_TARGET</code> may all be changed by the
6802: package.</p>
1.75 rillig 6803: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6804: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6805: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6806: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6807: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6808: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6809: <p>If there is no build step at all, set
1.128 wiz 6810: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6811: </div>
1.148 asau 6812: <div class="sect1">
1.75 rillig 6813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6814: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6815: <p>[TODO]</p>
6816: </div>
1.148 asau 6817: <div class="sect1">
1.75 rillig 6818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6819: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6820: <p>Once the build stage has completed, the final step is to
1.88 wiz 6821: install the software in public directories, so users can
6822: access the programs and files.</p>
1.75 rillig 6823: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6824: equivalent of the following code is executed. Additionally,
6825: before and after this code, much magic is performed to do
6826: consistency checks, registering the package, and so on.</p>
6827: <pre class="programlisting">
1.100 rillig 6828: .for d in ${INSTALL_DIRS}
6829: cd ${WRKSRC} \
6830: && cd ${d} \
6831: && env ${MAKE_ENV} \
6832: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6833: -f ${MAKE_FILE} \
6834: ${INSTALL_TARGET}
6835: .endfor
6836: </pre>
1.75 rillig 6837: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6838: <span class="emphasis"><em>build</em></span> phase.
6839: <code class="varname">INSTALL_DIRS</code> defaults to
6840: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6841: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6842: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6843: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6844: defined.</p>
1.75 rillig 6845: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6846: variables are useful. They are all variations of the
1.189 snj 6847: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 6848: permissions preset. <code class="varname">INSTALL</code> is the plain
6849: install command. The specialized variants, together with their
6850: intended use, are:</p>
1.148 asau 6851: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6852: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6853: <dd><p>directories that contain
6854: binaries</p></dd>
1.75 rillig 6855: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6856: <dd><p>directories that contain
6857: scripts</p></dd>
1.75 rillig 6858: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6859: <dd><p>directories that contain shared and static
6860: libraries</p></dd>
1.75 rillig 6861: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6862: <dd><p>directories that contain data
6863: files</p></dd>
1.75 rillig 6864: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6865: <dd><p>directories that contain man
6866: pages</p></dd>
1.75 rillig 6867: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6868: <dd><p>binaries that can be stripped from debugging
6869: symbols</p></dd>
1.75 rillig 6870: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6871: <dd><p>binaries that cannot be
6872: stripped</p></dd>
1.75 rillig 6873: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6874: <dd><p>game
6875: binaries</p></dd>
1.75 rillig 6876: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6877: <dd><p>shared and static
6878: libraries</p></dd>
1.75 rillig 6879: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6880: <dd><p>data files</p></dd>
6881: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6882: <dd><p>data files for
6883: games</p></dd>
1.75 rillig 6884: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6885: <dd><p>man pages</p></dd>
6886: </dl></div>
6887: <p>Some other variables are:</p>
1.148 asau 6888: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6889: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6890: <dd><p>A list of directories relative to
1.88 wiz 6891: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6892: beginning of the <span class="emphasis"><em>install</em></span> phase.
6893: The package is supposed to create all needed directories itself
6894: before installing files to it and list all other directories here.
6895: </p></dd>
1.75 rillig 6896: </dl></div>
1.97 rillig 6897: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6898: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6899: mostly relevant for packages in the <code class="filename">regress</code>
6900: category.</p>
1.75 rillig 6901: </div>
1.148 asau 6902: <div class="sect1">
1.75 rillig 6903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6904: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6905: <p>Once the install stage has completed, a binary package of
6906: the installed files can be built. These binary packages can be
6907: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6908: the <span class="command"><strong>make bin-install</strong></span> or by using
6909: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6910: <p>By default, the binary packages are created in
6911: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6912: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6913: one for each category in the <code class="varname">CATEGORIES</code>
6914: variable. <code class="varname">PACKAGES</code> defaults to
6915: <code class="filename">pkgsrc/packages</code>.</p>
6916: </div>
1.148 asau 6917: <div class="sect1">
1.88 wiz 6918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6919: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6920: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6921: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6922: to clean the work directories of all dependencies too, use
1.110 hubertf 6923: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6924: </div>
1.148 asau 6925: <div class="sect1">
1.75 rillig 6926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6927: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6928: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6929: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6930: <dd><p>For any of the main targets described in the
6931: previous section, two auxiliary targets exist with
1.128 wiz 6932: <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 6933: prefix for the main target's name. These targets are
1.88 wiz 6934: invoked before and after the main target is called,
6935: allowing extra configuration or installation steps be
6936: performed from a package's Makefile, for example, which
6937: a program's configure script or install target
6938: omitted.</p></dd>
1.75 rillig 6939: <dt><span class="term">do-*</span></dt>
1.88 wiz 6940: <dd><p>Should one of the main targets do the wrong thing,
6941: and should there be no variable to fix this, you can
6942: redefine it with the do-* target. (Note that redefining
6943: the target itself instead of the do-* target is a bad
6944: idea, as the pre-* and post-* targets won't be called
6945: anymore, etc.) You will not usually need to do
6946: this.</p></dd>
1.75 rillig 6947: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6948: <dd>
1.110 hubertf 6949: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6950: you noticed some file was not installed properly, you
6951: can repeat the installation with this target, which will
1.128 wiz 6952: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6953: <p>This is the default value of
6954: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6955: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6956: package</strong></span>, where the defaults are
1.128 wiz 6957: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6958: respectively.</p>
6959: </dd>
1.75 rillig 6960: <dt><span class="term">deinstall</span></dt>
6961: <dd>
1.189 snj 6962: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 6963: current directory, effectively de-installing the
6964: package. The following variables can be used to tune the
6965: behaviour:</p>
1.148 asau 6966: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6967: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.189 snj 6968: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 6969: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6970: <dd><p>Remove all packages that require (depend on)
6971: the given package. This can be used to remove any
6972: packages that may have been pulled in by a given
1.110 hubertf 6973: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6974: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6975: <code class="filename">pkgsrc/x11/kde</code>, this is
6976: likely to remove whole KDE. Works by adding
1.189 snj 6977: <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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 6978: command line.</p></dd>
1.75 rillig 6979: </dl></div>
6980: </dd>
1.88 wiz 6981: <dt><span class="term">bin-install</span></dt>
6982: <dd><p>Install a binary package from local disk and via FTP
6983: from a list of sites (see the
6984: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6985: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6986: available anywhere. The arguments given to
1.110 hubertf 6987: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6988: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6989: operation, etc.</p></dd>
1.75 rillig 6990: <dt><span class="term">update</span></dt>
6991: <dd>
1.88 wiz 6992: <p>This target causes the current package to be
6993: updated to the latest version. The package and all
6994: depending packages first get de-installed, then current
6995: versions of the corresponding packages get compiled and
6996: installed. This is similar to manually noting which
6997: packages are currently installed, then performing a
1.110 hubertf 6998: series of <span class="command"><strong>make deinstall</strong></span> and
6999: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7000: <code class="varname">UPDATE_TARGET</code> is set to) for these
7001: packages.</p>
1.128 wiz 7002: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 7003: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7004: update</strong></span> was interrupted for some reason.
7005: However, in this case, make sure you don't call
1.110 hubertf 7006: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7007: list of dependent packages in <code class="varname">WRKDIR</code>.
7008: Otherwise, you lose the ability to automatically update
7009: the current package along with the dependent packages
7010: you have installed.</p>
1.110 hubertf 7011: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7012: update</strong></span> will only work as long as the package
7013: tree remains unchanged. If the source code for one of
7014: the packages to be updated has been changed, resuming
1.110 hubertf 7015: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7016: fail!</p>
7017: <p>The following variables can be used either on the
1.110 hubertf 7018: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7019: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7020: update</strong></span>:</p>
1.148 asau 7021: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7022: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7023: <dd><p>Install target to recursively use for the
7024: updated package and the dependent packages.
7025: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7026: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7027: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7028: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7029: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7030: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7031: endless loop!</p></dd>
1.75 rillig 7032: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7033: <dd><p>Don't clean up after updating. Useful if
7034: you want to leave the work sources of the updated
7035: packages around for inspection or other purposes.
7036: Be sure you eventually clean up the source tree
1.128 wiz 7037: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7038: or you may run into troubles with old source code
7039: still lying around on your next
1.110 hubertf 7040: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7041: update</strong></span>.</p></dd>
1.75 rillig 7042: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7043: <dd><p>Deinstall each package before installing
7044: (making <code class="varname">DEPENDS_TARGET</code>). This
7045: may be necessary if the
1.128 wiz 7046: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7047: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7048: update</strong></span>.</p></dd>
1.75 rillig 7049: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7050: <dd><p>Allows you to disable recursion and hardcode
7051: the target for packages. The default is
1.128 wiz 7052: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7053: facilitating a recursive update of prerequisite
7054: packages. Only set
7055: <code class="varname">DEPENDS_TARGET</code> if you want to
7056: disable recursive updates. Use
7057: <code class="varname">UPDATE_TARGET</code> instead to just
7058: set a specific target for each package to be
1.110 hubertf 7059: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7060: (see above).</p></dd>
1.75 rillig 7061: </dl></div>
7062: </dd>
7063: <dt><span class="term">clean-update</span></dt>
7064: <dd>
1.88 wiz 7065: <p>Clean the source tree for all packages that would
1.110 hubertf 7066: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7067: from the current directory. This target should not be
7068: used if the current package (or any of its depending
7069: packages) have already been de-installed (e.g., after
1.110 hubertf 7070: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7071: some packages you intended to update. As a rule of
7072: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7073: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7074: and only if you have a dirty package tree (e.g., if you
7075: used <code class="varname">NOCLEAN</code>).</p>
7076: <p>If you are unsure about whether your tree is
1.110 hubertf 7077: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7078: clean</strong></span> at the top of the tree, or use the
7079: following sequence of commands from the directory of the
7080: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7081: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7082: time, otherwise you lose all the packages you wanted to
7083: update!):</p>
1.87 wiz 7084: <pre class="screen">
7085: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7086: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7087: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7088: </pre>
1.88 wiz 7089: <p>The following variables can be used either on the
1.110 hubertf 7090: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7091: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 7092: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7093: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7094: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7095: reconstruct the list of directories to update for
1.110 hubertf 7096: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7097: update</strong></span> successfully installed all
7098: packages you wanted to update. Normally, this is
1.110 hubertf 7099: done automatically on <span class="command"><strong>make
1.88 wiz 7100: update</strong></span>, but may have been suppressed by
7101: the <code class="varname">NOCLEAN</code> variable (see
7102: above).</p></dd>
1.75 rillig 7103: </dl></div>
7104: </dd>
1.88 wiz 7105: <dt><span class="term">replace</span></dt>
7106: <dd>
7107: <p>Update the installation of the current package. This
7108: differs from update in that it does not replace dependent
1.189 snj 7109: 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 7110: target to work.</p>
7111: <p><span class="emphasis"><em>Be careful when using this
7112: target!</em></span> There are no guarantees that dependent
7113: packages will still work, in particular they will most
1.110 hubertf 7114: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7115: library package whose shared library major version changed
7116: between your installed version and the new one. For this
7117: reason, this target is not officially supported and only
7118: recommended for advanced users.</p>
7119: </dd>
1.75 rillig 7120: <dt><span class="term">info</span></dt>
1.189 snj 7121: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 7122: package. You can use this to check which version of a
7123: package is installed.</p></dd>
7124: <dt><span class="term">index</span></dt>
7125: <dd>
7126: <p>This is a top-level command, i.e. it should be used in
7127: the <code class="filename">pkgsrc</code> directory. It creates a
7128: database of all packages in the local pkgsrc tree, including
7129: dependencies, comment, maintainer, and some other useful
7130: information. Individual entries are created by running
1.110 hubertf 7131: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7132: directories. This index file is saved as
7133: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7134: verbose format by running <span class="command"><strong>make
1.88 wiz 7135: print-index</strong></span>. You can search in it with
1.110 hubertf 7136: <span class="command"><strong>make search
1.88 wiz 7137: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7138: extract a list of all packages that depend on a particular
1.110 hubertf 7139: one by running <span class="command"><strong>make show-deps
1.88 wiz 7140: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7141: <p>Running this command takes a very long time, some
7142: hours even on fast machines!</p>
7143: </dd>
1.75 rillig 7144: <dt><span class="term">readme</span></dt>
1.88 wiz 7145: <dd>
7146: <p>This target generates a
7147: <code class="filename">README.html</code> file, which can be
1.189 snj 7148: 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 7149: contain references to any packages which are in the
7150: <code class="varname">PACKAGES</code> directory on the local
7151: host. The generated files can be made to refer to URLs
7152: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7153: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7154: wanted to generate <code class="filename">README.html</code>
7155: files which pointed to binary packages on the local
7156: machine, in the directory
7157: <code class="filename">/usr/packages</code>, set
7158: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7159: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7160: <code class="varname">${PACKAGES}</code> directory and its
7161: subdirectories will be searched for all the binary
7162: packages.</p>
7163: <p>The target can be run at the toplevel or in category
7164: directories, in which case it descends recursively.</p>
7165: </dd>
1.75 rillig 7166: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7167: <dd><p>This is a top-level command, run it in
7168: <code class="filename">pkgsrc</code>. Use this target to create a
7169: file <code class="filename">README-all.html</code> which contains a
7170: list of all packages currently available in the NetBSD
7171: Packages Collection, together with the category they belong
7172: to and a short description. This file is compiled from the
7173: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7174: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7175: readme</strong></span>.</p></dd>
1.75 rillig 7176: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7177: <dd><p>This is very much the same as the
1.128 wiz 7178: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7179: used when generating a pkgsrc tree to be written to a
7180: CD-ROM. This target also produces
7181: <code class="filename">README.html</code> files, and can be made
7182: to refer to URLs based on
7183: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7184: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7185: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7186: <dd><p>This target shows which distfiles and patchfiles
7187: are needed to build the package
7188: (<code class="varname">ALLFILES</code>, which contains all
7189: <code class="varname">DISTFILES</code> and
1.87 wiz 7190: <code class="varname">PATCHFILES</code>, but not
7191: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7192: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7193: <dd><p>This target shows nothing if the package is not
7194: installed. If a version of this package is installed,
7195: but is not the version provided in this version of
7196: pkgsrc, then a warning message is displayed. This target
7197: can be used to show which of your installed packages are
7198: downlevel, and so the old versions can be deleted, and
7199: the current ones added.</p></dd>
1.75 rillig 7200: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7201: <dd><p>This target shows the directory in the pkgsrc
7202: hierarchy from which the package can be built and
7203: installed. This may not be the same directory as the one
7204: from which the package was installed. This target is
7205: intended to be used by people who may wish to upgrade
7206: many packages on a single host, and can be invoked from
7207: the top-level pkgsrc Makefile by using the
1.128 wiz 7208: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7209: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7210: <dd><p>This target shows which installed packages match
7211: the current package's <code class="varname">DEPENDS</code>. Useful
7212: if out of date dependencies are causing build
7213: problems.</p></dd>
1.75 rillig 7214: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7215: <dd><p>After a package is installed, check all its
7216: binaries and (on ELF platforms) shared libraries to see
7217: if they find the shared libs they need. Run by default
1.110 hubertf 7218: 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 7219: <dt><span class="term">print-PLIST</span></dt>
7220: <dd>
1.128 wiz 7221: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7222: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7223: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7224: -newer work/.extract_done</strong></span>. An attempt is made
7225: to care for shared libs etc., but it is
1.87 wiz 7226: <span class="emphasis"><em>strongly</em></span> recommended to review the
7227: result before putting it into
7228: <code class="filename">PLIST</code>. On upgrades, it's useful to
7229: diff the output of this command against an already
7230: existing <code class="filename">PLIST</code> file.</p>
1.189 snj 7231: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 7232: other methods that don't update file access times, be
7233: sure to add these files manually to your
1.128 wiz 7234: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7235: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7236: them!</p>
1.128 wiz 7237: <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 7238: information on this target.</p>
1.75 rillig 7239: </dd>
7240: <dt><span class="term">bulk-package</span></dt>
7241: <dd>
1.88 wiz 7242: <p>Used to do bulk builds. If an appropriate binary
7243: package already exists, no action is taken. If not, this
7244: target will compile, install and package it (and its
7245: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 7246: properly. See <a class="xref" href="#bulk" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 7, <i>Creating binary packages for everything in pkgsrc (bulk
7247: builds)</i></a>).
1.88 wiz 7248: After creating the binary package, the sources, the
7249: just-installed package and its required packages are
7250: removed, preserving free disk space.</p>
7251: <p><span class="emphasis"><em>Beware that this target may deinstall
7252: all packages installed on a system!</em></span></p>
1.75 rillig 7253: </dd>
7254: <dt><span class="term">bulk-install</span></dt>
7255: <dd>
1.88 wiz 7256: <p>Used during bulk-installs to install required
7257: packages. If an up-to-date binary package is available,
1.189 snj 7258: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110 hubertf 7259: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7260: but the installed binary won't be removed.</p>
1.88 wiz 7261: <p>A binary package is considered
1.128 wiz 7262: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.189 snj 7263: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148 asau 7264: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7265: <li class="listitem"><p>None of the package's files
1.88 wiz 7266: (<code class="filename">Makefile</code>, ...) were modified
7267: since it was built.</p></li>
1.128 wiz 7268: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7269: packages were modified since it was built.</p></li>
1.75 rillig 7270: </ul></div>
1.88 wiz 7271: <p><span class="emphasis"><em>Beware that this target may deinstall
7272: all packages installed on a system!</em></span></p>
1.75 rillig 7273: </dd>
7274: </dl></div>
7275: </div>
7276: </div>
1.148 asau 7277: <div class="chapter">
1.75 rillig 7278: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7279: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7280: <div class="toc">
7281: <p><b>Table of Contents</b></p>
1.195 wiz 7282: <dl class="toc">
1.106 rillig 7283: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7284: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7285: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7286: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7287: </dl>
7288: </div>
1.87 wiz 7289: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7290: by pkgsrc and also for individual packages to define what commands
7291: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7292: or for later run-time of an installed packaged (such as
7293: <code class="varname">DEPENDS</code>).
7294: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7295: package will not be used.</p>
7296: <p>When building a package, the replacement tools are
1.75 rillig 7297: made available in a directory (as symlinks or wrapper scripts)
7298: that is early in the executable search path. Just like the buildlink
1.87 wiz 7299: system, this helps with consistent builds.</p>
7300: <p>A tool may be needed to help build a specific package. For example,
7301: perl, GNU make (gmake) or yacc may be needed.</p>
7302: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7303: tool may be inefficient for building a package with pkgsrc.
7304: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7305: yacc) or a better sed.</p>
7306: <p>The tools used by a package can be listed by running
1.110 hubertf 7307: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 7308: <div class="sect1">
1.75 rillig 7309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7310: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7311: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7312: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7313: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7314: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7315: These can be seen by running:
1.110 hubertf 7316: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7317: <p>If a package needs a specific program to build
1.75 rillig 7318: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7319: to define the tools needed.</p>
1.75 rillig 7320: </div>
1.148 asau 7321: <div class="sect1">
1.75 rillig 7322: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7323: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7324: <p>In the following examples, the :run means that it is needed at
7325: run-time (and becomes a DEPENDS).
1.75 rillig 7326: The default is a build dependency which can be set with
7327: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7328: and pkg-config:build.)</p>
1.75 rillig 7329: <pre class="programlisting">
7330: USE_TOOLS+= gmake perl:run pkg-config
7331: </pre>
1.87 wiz 7332: <p>When using the tools framework, a
1.75 rillig 7333: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7334: which contains the full path to the appropriate tool. For example,
1.128 wiz 7335: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7336: on Linux systems.</p>
7337: <p>If you always need a pkgsrc version of the
1.75 rillig 7338: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7339: </p>
7340: </div>
1.148 asau 7341: <div class="sect1">
1.75 rillig 7342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7343: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7344: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7345: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7346: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7347: the name of the common tools. For example:</p>
7348: <pre class="programlisting">
7349: .if exists(/usr/bin/bzcat)
7350: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7351: .elif exists(/usr/bin/bzip2)
7352: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7353: .endif
1.69 rillig 7354:
1.75 rillig 7355: TOOLS_PLATFORM.true?= true # shell builtin
7356: </pre>
7357: </div>
1.148 asau 7358: <div class="sect1">
1.97 rillig 7359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7360: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 asau 7361: <div class="qandaset">
1.198 ! tnn 7362: <a name="idm73133136"></a><dl>
1.106 rillig 7363: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7364: </dt>
1.106 rillig 7365: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7366: tools?</a>
7367: </dt>
1.106 rillig 7368: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7369: package is using while being built? I want to know whether it
7370: uses sed or not.</a>
7371: </dt>
7372: </dl>
1.148 asau 7373: <table border="0" style="width: 100%;">
7374: <colgroup>
1.97 rillig 7375: <col align="left" width="1%">
1.128 wiz 7376: <col>
1.148 asau 7377: </colgroup>
1.97 rillig 7378: <tbody>
1.148 asau 7379: <tr class="question">
1.97 rillig 7380: <td align="left" valign="top">
1.198 ! tnn 7381: <a name="tools.new"></a><a name="idm73132752"></a><p><b>18.4.1.</b></p>
1.97 rillig 7382: </td>
7383: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7384: </tr>
7385: <tr class="answer">
7386: <td align="left" valign="top"></td>
7387: <td align="left" valign="top"><p>TODO</p></td>
7388: </tr>
1.148 asau 7389: <tr class="question">
1.97 rillig 7390: <td align="left" valign="top">
1.198 ! tnn 7391: <a name="tools.listall"></a><a name="idm73131728"></a><p><b>18.4.2.</b></p>
1.97 rillig 7392: </td>
7393: <td align="left" valign="top"><p>How do I get a list of all available
7394: tools?</p></td>
7395: </tr>
7396: <tr class="answer">
7397: <td align="left" valign="top"></td>
7398: <td align="left" valign="top"><p>TODO</p></td>
7399: </tr>
1.148 asau 7400: <tr class="question">
1.97 rillig 7401: <td align="left" valign="top">
1.198 ! tnn 7402: <a name="tools.used"></a><a name="idm73130704"></a><p><b>18.4.3.</b></p>
1.97 rillig 7403: </td>
7404: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7405: package is using while being built? I want to know whether it
7406: uses sed or not.</p></td>
7407: </tr>
7408: <tr class="answer">
7409: <td align="left" valign="top"></td>
7410: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7411: to do it.)</p></td>
7412: </tr>
7413: </tbody>
7414: </table>
7415: </div>
7416: </div>
1.75 rillig 7417: </div>
1.148 asau 7418: <div class="chapter">
1.75 rillig 7419: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7420: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7421: <div class="toc">
7422: <p><b>Table of Contents</b></p>
1.195 wiz 7423: <dl class="toc">
1.106 rillig 7424: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7425: <dd><dl>
1.106 rillig 7426: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7427: <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 7428: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7429: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7430: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7431: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7432: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7433: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7434: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7435: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7436: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7437: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7438: </dl></dd>
1.128 wiz 7439: <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 7440: <dd><dl>
7441: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7442: <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>
7443: </dl></dd>
1.128 wiz 7444: <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 7445: <dd><dl>
7446: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7447: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7448: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7449: </dl></dd>
7450: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7451: <dd><dl>
7452: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7453: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7454: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7455: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7456: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7457: </dl></dd>
1.128 wiz 7458: <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 7459: <dd><dl>
7460: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7461: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7462: <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 7463: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7464: </dl></dd>
1.128 wiz 7465: <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 7466: <dd><dl>
7467: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7468: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7469: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7470: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7471: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7472: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7473: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7474: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7475: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7476: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7477: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7478: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7479: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7480: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7481: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7482: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7483: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7484: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7485: emulation</a></span></dt>
1.106 rillig 7486: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7487: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7488: </dl></dd>
1.106 rillig 7489: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7490: </dl>
7491: </div>
1.148 asau 7492: <div class="sect1">
1.75 rillig 7493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7494: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 asau 7495: <div class="sect2">
1.75 rillig 7496: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7497: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7498: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7499: different platforms. As a result, it is important to ensure,
7500: where possible, that packages in pkgsrc are portable. This
7501: chapter mentions some particular details you should pay
7502: attention to while working on pkgsrc.</p>
1.78 rillig 7503: </div>
1.148 asau 7504: <div class="sect2">
1.78 rillig 7505: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7506: <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 7507: </h3></div></div></div>
1.78 rillig 7508: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7509: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7510: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7511: want to use those variables in the preprocessor directives of
1.189 snj 7512: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7513: <code class="literal">.for</code>), you need to include the file
7514: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7515: loads the user preferences.</p>
1.78 rillig 7516: <p>But note that some variables may not be completely defined
1.87 wiz 7517: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7518: included, as they may contain references to variables that are
7519: not yet defined. In shell commands this is no problem, since
7520: variables are actually macros, which are only expanded when they
7521: are used. But in the preprocessor directives mentioned above and
7522: in dependency lines (of the form <code class="literal">target:
7523: dependencies</code>) the variables are expanded at load
7524: time.</p>
1.148 asau 7525: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7526: <h3 class="title">Note</h3>
7527: <p>Currently there is no exhaustive list of all
1.87 wiz 7528: variables that tells you whether they can be used at load time
7529: or only at run time, but it is in preparation.</p>
1.78 rillig 7530: </div>
7531: </div>
1.148 asau 7532: <div class="sect2">
1.78 rillig 7533: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7534: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7535: <p>Occasionally, packages require interaction from the user,
7536: and this can be in a number of ways:</p>
1.148 asau 7537: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7538: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7539: interaction such as entering username/password or accepting a
7540: license on a web page.</p></li>
1.128 wiz 7541: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7542: passwords.</p></li>
1.128 wiz 7543: <li class="listitem"><p>help to configure the package before it is built</p></li>
7544: <li class="listitem"><p>help during the build process</p></li>
7545: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7546: </ul></div>
1.88 wiz 7547: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7548: provided to notify the pkgsrc mechanism of an interactive stage
7549: which will be needed, and this should be set in the package's
7550: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7551: <pre class="programlisting">
1.100 rillig 7552: INTERACTIVE_STAGE= build
1.87 wiz 7553: </pre>
1.78 rillig 7554: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7555: <pre class="programlisting">
1.100 rillig 7556: INTERACTIVE_STAGE= configure install
1.87 wiz 7557: </pre>
1.88 wiz 7558: <p>The user can then decide to skip this package by setting the
7559: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7560: </div>
1.148 asau 7561: <div class="sect2">
1.75 rillig 7562: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7563: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7564: <p>Authors of software can choose the licence under which
7565: software can be copied. This is due to copyright law, and reasons
7566: for license choices are outside the scope of pkgsrc. The pkgsrc
7567: system recognizes that there are a number of licenses which some
7568: users may find objectionable or difficult or impossible to comply
7569: with. The Free Software Foundation has declared some licenses
7570: "Free", and the Open Source Initiative has a definition of "Open
7571: Source". The pkgsrc system, as a policy choice, does not label
7572: packages which have licenses that are Free or Open Source.
7573: However, packages without a license meeting either of those tests
7574: are labeled with a license tag denoting the license. Note that a
7575: package with no license to copy trivially does not meet either the
7576: Free or Open Source test.</p>
7577: <p>For packages which are not Free or Open Source, pkgsrc will
7578: not build the package unless the user has indicated to pkgsrc that
7579: packages with that particular license may be built. Note that
7580: this documentation avoids the term "accepted the license". The
7581: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7582: accidentally building a package with a non-free license;
1.98 wiz 7583: judgement and responsibility remain with the user. (Installation
7584: of binary packages are not currently subject to this mechanism;
7585: this is a bug.)</p>
7586: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7587: or the GPL, and not the other. The free licenses are added to the
7588: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7589: user can override the default by setting the
7590: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7591: of "+=". The licenses accepted by default are:
7592: </p>
7593: <pre class="programlisting">
1.154 rodent 7594: apache-1.1 apache-2.0
7595: arphic-public
7596: artistic artistic-2.0
7597: boost-license
7598: cc-by-sa-v3.0
1.161 ryoon 7599: cc0-1.0-universal
1.154 rodent 7600: cddl-1.0
7601: cpl-1.0
7602: epl-v1.0
7603: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7604: gnu-gpl-v1
7605: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7606: gnu-gpl-v3 gnu-lgpl-v3
7607: ibm-public-license-1.0
7608: ipafont
7609: isc
7610: lppl-1.3c
7611: lucent
7612: miros
7613: mit
7614: mpl-1.0 mpl-1.1 mpl-2.0
7615: mplusfont
7616: ofl-v1.0 ofl-v1.1
7617: original-bsd modified-bsd 2-clause-bsd
7618: php
7619: png-license
7620: postgresql-license
7621: public-domain
7622: python-software-foundation
7623: qpl-v1.0
1.158 rodent 7624: sgi-free-software-b-v2.0
1.154 rodent 7625: sleepycat-public
7626: unlicense
7627: x11
7628: zlib
7629: zpl
1.121 jnemeth 7630: </pre>
7631: <p>
7632: </p>
1.78 rillig 7633: <p>The license tag mechanism is intended to address
1.87 wiz 7634: copyright-related issues surrounding building, installing and
7635: using a package, and not to address redistribution issues (see
7636: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7637: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7638: Packages with redistribution restrictions should set these
7639: tags.</p>
1.98 wiz 7640: <p>Denoting that a package may be copied according to a
7641: particular license is done by placing the license in
1.87 wiz 7642: <code class="filename">pkgsrc/licenses</code> and setting the
7643: <code class="varname">LICENSE</code> variable to a string identifying the
1.189 snj 7644: 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 7645: <pre class="programlisting">
1.100 rillig 7646: LICENSE= xv-license
1.87 wiz 7647: </pre>
7648: <p>When trying to build, the user will get a notice that the
1.98 wiz 7649: package is covered by a license which has not been placed in the
7650: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7651: <pre class="programlisting">
1.100 rillig 7652: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7653: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7654: ===> To view the license, enter "/usr/bin/make show-license".
7655: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7656: ===> ACCEPTABLE_LICENSES+=xv-license
7657: *** Error code 1
1.87 wiz 7658: </pre>
1.110 hubertf 7659: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7660: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7661: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7662: convey to pkgsrc that it should not in the future fail because of
7663: that license:</p>
1.78 rillig 7664: <pre class="programlisting">
1.100 rillig 7665: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7666: </pre>
1.154 rodent 7667: <p>When adding a package with a new license, the following steps
7668: are required:</p>
7669: <div class="orderedlist"><ol class="orderedlist" type="1">
7670: <li class="listitem">
7671: <p>Check if the file can avoid the -license filename tag as described above by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.html" target="_top">Various Licenses and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name | Open Source Initiative</a>. If this is the case, additionally add the license filename to:</p>
7672: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7673: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7674: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.158 rodent 7675: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154 rodent 7676: </ul></div>
7677: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7678: </li>
7679: <li class="listitem"><p>The license text should be added to <code class="filename">pkgsrc/licenses</code> for displaying. A list of known licenses can be seen in this directory.</p></li>
7680: </ol></div>
1.98 wiz 7681: <p>When the license changes (in a way other than formatting),
7682: please make sure that the new license has a different name (e.g.,
7683: append the version number if it exists, or the date). Just
7684: because a user told pkgsrc to build programs under a previous
7685: version of a license does not mean that pkgsrc should build
1.99 rillig 7686: programs under the new licenses. The higher-level point is that
1.98 wiz 7687: pkgsrc does not evaluate licenses for reasonableness; the only
7688: test is a mechanistic test of whether a particular text has been
7689: approved by either of two bodies.</p>
1.78 rillig 7690: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7691: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7692: is deprecated because it does not crisply refer to a particular
7693: license text. Another problem with such usage is that it does not
7694: enable a user to tell pkgsrc to proceed for a single package
7695: without also telling pkgsrc to proceed for all packages with that
7696: tag.</p>
1.75 rillig 7697: </div>
1.148 asau 7698: <div class="sect2">
1.75 rillig 7699: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7700: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7701: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7702: Because a license tag is required unless the package is Free or
7703: Open Source, all packages with restrictions should have license
7704: tags. By declaring the restrictions, package tools can
7705: automatically refrain from e.g. placing binary packages on FTP
7706: sites.</p>
7707: <p>There are four restrictions that may be encoded, which are
7708: the cross product of sources (distfiles) and binaries not being
7709: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7710: language in any license, and because non-Free licenses tend to be
7711: different from each other, pkgsrc adopts a definition of FTP and
7712: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7713: should not be made available over the Internet at no charge.
7714: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7715: made available on some kind of media, together with other source
7716: and binary packages, and which is sold for a distribution charge.
7717: </p>
7718: <p>In order to encode these restrictions, the package system
1.87 wiz 7719: defines five make variables that can be set to note these
7720: restrictions:</p>
1.148 asau 7721: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7722: <li class="listitem">
1.75 rillig 7723: <p><code class="varname">RESTRICTED</code></p>
7724: <p>This variable should be set whenever a restriction
1.87 wiz 7725: exists (regardless of its kind). Set this variable to a
1.98 wiz 7726: string containing the reason for the restriction. It should
7727: be understood that those wanting to understand the restriction
7728: will have to read the license, and perhaps seek advice of
7729: counsel.</p>
1.75 rillig 7730: </li>
1.128 wiz 7731: <li class="listitem">
1.75 rillig 7732: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7733: <p>Binaries may not be placed on CD-ROM containing other
7734: binary packages, for which a distribution charge may be made.
7735: In this case, set this variable to
7736: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7737: </li>
1.128 wiz 7738: <li class="listitem">
1.75 rillig 7739: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7740: <p>Binaries may not made available on the Internet without
7741: charge. In this case, set this variable to
7742: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7743: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7744: </li>
1.128 wiz 7745: <li class="listitem">
1.75 rillig 7746: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7747: <p>Distfiles may not be placed on CD-ROM, together with
7748: other distfiles, for which a fee may be charged. In this
7749: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7750: </p>
1.75 rillig 7751: </li>
1.128 wiz 7752: <li class="listitem">
1.75 rillig 7753: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7754: <p>Distfiles may not made available via FTP at no charge.
7755: In this case, set this variable to
7756: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7757: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7758: </li>
7759: </ul></div>
1.139 wiz 7760: <p>Please note that packages will to be removed from pkgsrc
7761: when the distfiles are not distributable and cannot be obtained
7762: for a period of one full quarter branch. Packages with manual /
7763: interactive fetch must have a maintainer and it is his/her
7764: responsibility to ensure this.</p>
1.75 rillig 7765: </div>
1.148 asau 7766: <div class="sect2">
1.75 rillig 7767: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7768: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7769: <p>Your package may depend on some other package being present
1.88 wiz 7770: - and there are various ways of expressing this dependency.
7771: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7772: <code class="varname">DEPENDS</code> definitions, the
7773: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7774: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7775: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7776: 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 7777: <p>The basic difference between the two variables is as
1.87 wiz 7778: follows: The <code class="varname">DEPENDS</code> definition registers
7779: that pre-requisite in the binary package so it will be pulled in
7780: when the binary package is later installed, whilst the
7781: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7782: dependency that is only needed for building the package.</p>
1.75 rillig 7783: <p>This means that if you only need a package present whilst
1.87 wiz 7784: you are building, it should be noted as a
7785: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7786: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7787: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7788: <pre class="programlisting">
1.100 rillig 7789: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7790: </pre>
1.128 wiz 7791: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7792: may include any of the wildcard version numbers recognized by
1.189 snj 7793: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7794: <div class="orderedlist"><ol class="orderedlist" type="1">
7795: <li class="listitem">
1.75 rillig 7796: <p>If your package needs another package's binaries or
1.160 wiz 7797: libraries to build and run, and if that package has a
1.87 wiz 7798: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7799: <pre class="programlisting">
1.100 rillig 7800: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7801: </pre>
1.75 rillig 7802: </li>
1.128 wiz 7803: <li class="listitem">
1.160 wiz 7804: <p>If your package needs another package's binaries or
7805: libraries only for building, and if that package has a
7806: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7807: <pre class="programlisting">
7808: .include "../../graphics/jpeg/buildlink3.mk"
7809: </pre>
7810: <p>but set
7811: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7812: to make it a build dependency only. This case is rather
7813: rare.</p>
7814: </li>
7815: <li class="listitem">
1.132 spz 7816: <p>If your package needs binaries from another package to build,
7817: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7818: <pre class="programlisting">
1.132 spz 7819: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 7820: </pre>
1.75 rillig 7821: </li>
1.132 spz 7822: <li class="listitem"><p>If your package needs a library with which to link and
7823: there is no <code class="filename">buildlink3.mk</code> file
7824: available, create one. Using
7825: <code class="varname">DEPENDS</code> won't be sufficient because the
7826: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7827: <li class="listitem">
1.132 spz 7828: <p>If your package needs some executable to be able to run
7829: correctly and if there's no
7830: <code class="filename">buildlink3.mk</code> file, this is specified
7831: using the <code class="varname">DEPENDS</code> variable. The
1.189 snj 7832: <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.132 spz 7833: be able to execute the latex binary from the teTeX package
7834: when it runs, and that is specified:</p>
1.75 rillig 7835: <pre class="programlisting">
1.132 spz 7836: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7837: </pre>
1.132 spz 7838: </li>
7839: <li class="listitem">
7840: <p>You can use wildcards in package dependencies. Note that
7841: such wildcard dependencies are retained when creating binary
7842: packages. The dependency is checked when installing the binary
7843: package and any package which matches the pattern will be
7844: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7845: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7846: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7847: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7848: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7849: <p>Wildcards can also be used to specify that a package
1.87 wiz 7850: will only build against a certain minimum version of a
7851: pre-requisite:</p>
1.75 rillig 7852: <pre class="programlisting">
1.132 spz 7853: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 7854: </pre>
1.132 spz 7855: <p>This means that the package will build using version 6.0
7856: of ImageMagick or newer. Such a dependency may be warranted
7857: if, for example, the command line options of an executable
7858: have changed.</p>
7859: <p>If you need to depend on minimum versions of libraries,
7860: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7861: <p>For security fixes, please update the package
1.110 hubertf 7862: 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 7863: information.</p>
1.75 rillig 7864: </li>
1.165 bsiegert 7865: <li class="listitem">
7866: <p>If the package depends on either one of two (or more)
7867: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7868: comma-separated list between curly braces.</p>
7869: <p>As an example, take a package that depends on the Perl
7870: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7871: itself since version 5.10.0. This either/or dependency is
7872: expressed as:</p>
7873: <pre class="programlisting">
7874: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7875: </pre>
7876: </li>
1.75 rillig 7877: </ol></div>
7878: <p>If your package needs files from another package to build,
1.87 wiz 7879: add the relevant distribution files to
7880: <code class="varname">DISTFILES</code>, so they will be extracted
1.189 snj 7881: 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 7882: (It relies on the jpeg sources being present in source form
7883: during the build.)</p>
1.75 rillig 7884: </div>
1.148 asau 7885: <div class="sect2">
1.75 rillig 7886: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7887: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7888: <p>Your package may conflict with other packages a user might
1.87 wiz 7889: already have installed on his system, e.g. if your package
1.88 wiz 7890: installs the same set of files as another package in the pkgsrc
1.190 wiz 7891: tree or has the same <code class="varname">PKGNAME</code>.</p>
7892: <p>These cases are handled automatically by the packaging tools
7893: at package installation time and do not need to be handled
7894: manually.</p>
7895: <p>In case the conflicts can not be recognized automatically
7896: (e.g., packages using the same config file location but no other
7897: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7898: space-separated list of packages (including version string) your
7899: package conflicts with.</p>
1.190 wiz 7900: <p>For example, if both <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
7901: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7902: use the same config file, you would set in
7903: <code class="filename">foo/bar/Makefile</code>:</p>
1.87 wiz 7904: <pre class="programlisting">
1.190 wiz 7905: CONFLICTS= baz-[0-9]*
1.87 wiz 7906: </pre>
1.190 wiz 7907: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75 rillig 7908: <pre class="programlisting">
1.190 wiz 7909: CONFLICTS= bar-[0-9]*
1.87 wiz 7910: </pre>
1.75 rillig 7911: </div>
1.148 asau 7912: <div class="sect2">
1.75 rillig 7913: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7914: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7915: <p>There are several reasons why a package might be
1.88 wiz 7916: instructed to not build under certain circumstances. If the
1.87 wiz 7917: package builds and runs on most platforms, the exceptions
1.193 dholland 7918: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7919: the package builds and runs on a small handful of platforms,
7920: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7921: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7922: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7923: (OS-version-platform) that can use glob-style
7924: wildcards.</p>
7925: <p>If a package is not appropriate for some platforms (as
7926: oopposed to merely broken), a different set of variables should be
7927: used as this affects failure reporting and statistics.
7928: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7929: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7930: the package is appropriate for only a small handful of platforms
7931: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7932: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7933: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7934: (OS-version-platform) that can use glob-style
7935: wildcards.</p>
1.88 wiz 7936: <p>Some packages are tightly bound to a specific version of an
1.189 snj 7937: 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 7938: backwards compatible with other versions of the OS, and should be
7939: uploaded to a version specific directory on the FTP server. Mark
7940: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7941: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7942: the package system internals, but may be used in the
7943: future.</p>
1.75 rillig 7944: <p>If the package should be skipped (for example, because it
1.87 wiz 7945: provides functionality already provided by the system), set
1.88 wiz 7946: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7947: the package should fail because some preconditions are not met,
7948: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7949: message.</p>
1.75 rillig 7950: </div>
1.148 asau 7951: <div class="sect2">
1.75 rillig 7952: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7953: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7954: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7955: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7956: be set in the package Makefile. This will be carried into any
7957: binary package that is made from this pkgsrc entry. A
1.128 wiz 7958: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.189 snj 7959: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7960: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7961: </div>
1.148 asau 7962: <div class="sect2">
1.75 rillig 7963: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7964: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7965: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7966: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7967: and after committing that file, ask pkgsrc-security@NetBSD.org to
7968: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7969: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7970: <code class="varname">PKGREVISION</code> should be increased (this is of
7971: course not necessary if the problem is fixed by using a newer
7972: release of the software), and the pattern in the
7973: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7974: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7975: branch, be sure to submit a pullup request!</p>
1.75 rillig 7976: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7977: semi-automatically by a weekly cron job.</p>
1.75 rillig 7978: </div>
1.148 asau 7979: <div class="sect2">
1.75 rillig 7980: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7981: <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 7982: <p>When making fixes to an existing package it can be useful
1.87 wiz 7983: to change the version number in <code class="varname">PKGNAME</code>. To
7984: avoid conflicting with future versions by the original author, a
1.128 wiz 7985: <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 7986: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7987: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7988: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7989: <pre class="programlisting">
1.100 rillig 7990: DISTNAME= foo-17.42
7991: PKGREVISION= 9
1.87 wiz 7992: </pre>
1.75 rillig 7993: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7994: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7995: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7996: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7997: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7998: <p>When a new release of the package is released, the
1.87 wiz 7999: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8000: minor release of the above package, things should be like:</p>
1.75 rillig 8001: <pre class="programlisting">
1.100 rillig 8002: DISTNAME= foo-17.43
1.87 wiz 8003: </pre>
8004: <p><code class="varname">PKGREVISION</code> should be incremented for any
8005: non-trivial change in the resulting binary package. Without a
8006: <code class="varname">PKGREVISION</code> bump, someone with the previous
8007: version installed has no way of knowing that their package is out
8008: of date. Thus, changes without increasing
8009: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8010: trivial that no reasonable person would want to upgrade", and this
8011: is the rough test for when increasing
8012: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8013: changes that do not merit increasing
8014: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 8015: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8016: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 8017: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8018: or comments in Makefile.</p></li>
1.128 wiz 8019: <li class="listitem"><p>
1.100 rillig 8020: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 8021: <li class="listitem"><p>
1.100 rillig 8022: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8023: <li class="listitem"><p>
1.100 rillig 8024: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8025: </ul></div>
1.87 wiz 8026: <p>Examples of changes that do merit an increase to
8027: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 8028: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8029: <li class="listitem"><p>
1.100 rillig 8030: Security fixes</p></li>
1.128 wiz 8031: <li class="listitem"><p>
1.100 rillig 8032: Changes or additions to a patch file</p></li>
1.128 wiz 8033: <li class="listitem"><p>
1.100 rillig 8034: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8035: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8036: </ul></div>
1.78 rillig 8037: <p>PKGREVISION must also be incremented when dependencies have ABI
8038: changes.</p>
1.75 rillig 8039: </div>
1.148 asau 8040: <div class="sect2">
1.79 rillig 8041: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8042: <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 8043: <p>When you want to replace the same text in multiple files
1.87 wiz 8044: or when the replacement text varies, patches alone cannot help.
8045: This is where the SUBST framework comes in. It provides an
8046: easy-to-use interface for replacing text in files.
8047: Example:</p>
8048: <pre class="programlisting">
1.100 rillig 8049: SUBST_CLASSES+= fix-paths
8050: SUBST_STAGE.fix-paths= pre-configure
8051: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8052: SUBST_FILES.fix-paths= src/*.c
8053: SUBST_FILES.fix-paths+= scripts/*.sh
8054: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8055: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8056: </pre>
1.79 rillig 8057: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8058: that are used to identify the different SUBST blocks that are
8059: defined. The SUBST framework is heavily used by pkgsrc, so it is
8060: important to always use the <code class="literal">+=</code> operator with
8061: this variable. Otherwise some substitutions may be
8062: skipped.</p>
1.79 rillig 8063: <p>The remaining variables of each SUBST block are
1.87 wiz 8064: parameterized with the identifier from the first line
8065: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8066: parameters to a function call.</p>
1.79 rillig 8067: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8068: which the replacement will take place. All combinations of
8069: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8070: <code class="literal">post-</code> together with a phase name are
8071: possible, though only few are actually used. Most commonly used
8072: are <code class="literal">post-patch</code> and
8073: <code class="literal">pre-configure</code>. Of these two,
8074: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8075: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8076: have the state after applying the patches but before making any
8077: other changes. This is especially useful when you are debugging
8078: a package in order to create new patches for it. Similarly,
8079: <code class="literal">post-build</code> is preferred over
8080: <code class="literal">pre-install</code>, because the install phase should
8081: generally be kept as simple as possible. When you use
8082: <code class="literal">post-build</code>, you have the same files in the
8083: working directory that will be installed later, so you can check
8084: if the substitution has succeeded.</p>
1.79 rillig 8085: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8086: that is printed just before the substitution is done.</p>
1.79 rillig 8087: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8088: globbing patterns that specifies the files in which the
8089: substitution will take place. The patterns are interpreted
8090: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8091: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.189 snj 8092: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87 wiz 8093: command should be prefixed with <code class="literal">-e</code>, so that
8094: all SUBST blocks look uniform.</p>
1.79 rillig 8095: <p>There are some more variables, but they are so seldomly
1.87 wiz 8096: used that they are only documented in the
8097: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8098: </div>
1.75 rillig 8099: </div>
1.148 asau 8100: <div class="sect1">
1.75 rillig 8101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8102: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8103: <div class="sect2">
1.75 rillig 8104: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8105: <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 8106: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8107: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8108: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8109: with the name of each file to download as an argument, expecting
8110: it to output the URL of the directory from which to download
1.189 snj 8111: 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 8112: example of this usage.</p>
1.75 rillig 8113: <p>If the download can't be automated, because the user must
1.87 wiz 8114: submit personal information to apply for a password, or must pay
8115: for the source, or whatever, you can set
8116: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8117: displayed to the user before aborting the build. Example:</p>
8118: <pre class="programlisting">
1.100 rillig 8119: FETCH_MESSAGE= "Please download the files"
8120: FETCH_MESSAGE+= " "${DISTFILES:Q}
8121: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8122: </pre>
1.75 rillig 8123: </div>
1.148 asau 8124: <div class="sect2">
1.75 rillig 8125: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8126: <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 8127: <p>Sometimes authors of a software package make some
1.87 wiz 8128: modifications after the software was released, and they put up a
8129: new distfile without changing the package's version number. If a
8130: package is already in pkgsrc at that time, the checksum will
8131: no longer match. The contents of the new distfile should be
8132: compared against the old one before changing anything, to make
8133: sure the distfile was really updated on purpose, and that
8134: no trojan horse or so crept in.
1.97 rillig 8135: Please mention that the distfiles were compared and what was found
1.159 rodent 8136: in your commit message.</p>
8137: <p>Then, the correct way to work around this is to
1.87 wiz 8138: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8139: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8140: <code class="varname">DISTFILES</code> and
1.93 rillig 8141: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8142: subdirectory of the local distfiles directory.
1.110 hubertf 8143: (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 8144: In case this
1.87 wiz 8145: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8146: including the <code class="filename">nbX</code> suffix) or a date stamp
1.159 rodent 8147: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8148: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's name does not contain a version and the distfile is apt to change. In cases where the likelihood of this is very small, <code class="varname">DIST_SUBDIR</code> might not be required. Additionally, <code class="varname">DIST_SUBDIR</code> must not be removed unless the distfile name changes, even if a package is being moved or renamed.</p>
8149: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8150: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8151: path in the filenames.
1.159 rodent 8152: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8153: Furthermore, a mail to the package's authors seems appropriate
8154: telling them that changing distfiles after releases without
8155: changing the file names is not good practice.</p>
1.75 rillig 8156: </div>
8157: </div>
1.148 asau 8158: <div class="sect1">
1.75 rillig 8159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8160: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8161: <div class="sect2">
1.75 rillig 8162: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8163: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8164: <p>pkgsrc supports many different machines, with different
1.87 wiz 8165: object formats like a.out and ELF, and varying abilities to do
8166: shared library and dynamic loading at all. To accompany this,
8167: varying commands and options have to be passed to the
8168: compiler, linker, etc. to get the Right Thing, which can be
8169: pretty annoying especially if you don't have all the machines
8170: at your hand to test things. The
1.189 snj 8171: <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 8172: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8173: both static and dynamic libraries from a set of source files,
8174: thus being platform-independent.</p>
8175: <p>Here's how to use libtool in a package in seven simple
8176: steps:</p>
1.128 wiz 8177: <div class="orderedlist"><ol class="orderedlist" type="1">
8178: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8179: Makefile.</p></li>
1.128 wiz 8180: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8181: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8182: add it to the definition of <code class="varname">CC</code>, if only
8183: libraries are being built in a given Makefile. This one command
8184: will build both PIC and non-PIC library objects, so you need not
8185: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8186: <li class="listitem">
1.75 rillig 8187: <p>For the linking of the library, remove any
1.128 wiz 8188: <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
8189: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8190: <pre class="programlisting">
1.100 rillig 8191: ${LIBTOOL} --mode=link \
8192: ${CC} -o ${.TARGET:.a=.la} \
8193: ${OBJS:.o=.lo} \
8194: -rpath ${PREFIX}/lib \
8195: -version-info major:minor
1.87 wiz 8196: </pre>
1.75 rillig 8197: <p>Note that the library is changed to have a
1.87 wiz 8198: <code class="filename">.la</code> extension, and the objects are
8199: changed to have a <code class="filename">.lo</code>
8200: extension. Change <code class="varname">OBJS</code> as
8201: necessary. This automatically creates all of the
8202: <code class="filename">.a</code>,
8203: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8204: necessary) in the build directory. Be sure to include
1.128 wiz 8205: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8206: minor are zero, as libtool will otherwise strip off the
8207: shared library version.</p>
1.75 rillig 8208: <p>From the libtool manual:</p>
8209: <pre class="programlisting">
1.100 rillig 8210: So, libtool library versions are described by three integers:
1.69 rillig 8211:
1.100 rillig 8212: CURRENT
8213: The most recent interface number that this library implements.
1.69 rillig 8214:
1.100 rillig 8215: REVISION
8216: The implementation number of the CURRENT interface.
1.69 rillig 8217:
1.100 rillig 8218: AGE
8219: The difference between the newest and oldest interfaces that
8220: this library implements. In other words, the library implements
8221: all the interface numbers in the range from number `CURRENT -
8222: AGE' to `CURRENT'.
1.1 grant 8223:
1.100 rillig 8224: If two libraries have identical CURRENT and AGE numbers, then the
8225: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8226: </pre>
1.128 wiz 8227: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8228: different results for a.out and ELF (excluding symlinks)
8229: in only one case. An ELF library of the form
1.128 wiz 8230: <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 8231: will have a symlink of
1.128 wiz 8232: <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 8233: on an a.out platform. This is handled
8234: automatically.</p>
1.128 wiz 8235: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8236: directory of the library being built.</p>
1.76 rillig 8237: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8238: <code class="filename">.la</code> file, the other files will be
8239: added automatically.</p>
1.75 rillig 8240: </li>
1.128 wiz 8241: <li class="listitem">
1.76 rillig 8242: <p>When linking shared object (<code class="filename">.so</code>)
1.189 snj 8243: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8244: shared libraries, use <span class="quote">“<span class="quote">-module
8245: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8246: tacked on.</p>
1.76 rillig 8247: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8248: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8249: </li>
1.128 wiz 8250: <li class="listitem">
1.75 rillig 8251: <p>When linking programs that depend on these libraries
1.87 wiz 8252: <span class="emphasis"><em>before</em></span> they are installed, preface
1.189 snj 8253: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8254: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8255: libraries (static or shared), but please be aware that
8256: libtool will not allow you to specify a relative path in
1.128 wiz 8257: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8258: expects you to change that argument to be the
8259: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8260: <pre class="programlisting">
1.100 rillig 8261: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8262: </pre>
1.75 rillig 8263: <p>should be changed to:</p>
8264: <pre class="programlisting">
1.100 rillig 8265: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8266: </pre>
1.75 rillig 8267: <p>and it will do the right thing with the libraries.</p>
8268: </li>
1.128 wiz 8269: <li class="listitem">
1.189 snj 8270: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8271: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8272: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8273: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8274: <pre class="programlisting">
1.126 jakllsch 8275: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8276: </pre>
1.76 rillig 8277: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8278: shared library, any needed symlinks, and run
1.189 snj 8279: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8280: </li>
1.128 wiz 8281: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8282: the <code class="filename">.la</code>
8283: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8284: </ol></div>
8285: </div>
1.148 asau 8286: <div class="sect2">
1.75 rillig 8287: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8288: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8289: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8290: package Makefile. This will override the package's own libtool
8291: in most cases. For older libtool using packages, libtool is
8292: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8293: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8294: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8295: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8296: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8297: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8298: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8299: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8300: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8301: libraries built and installed, then use
8302: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8303: <p>If your package makes use of the platform-independent library
1.87 wiz 8304: for loading dynamic shared objects, that comes with libtool
8305: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8306: <p>Some packages use libtool incorrectly so that the package
8307: may not work or build in some circumstances. Some of the more
8308: common errors are:</p>
1.148 asau 8309: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8310: <li class="listitem">
1.75 rillig 8311: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8312: executable or library. This in itself isn't a problem if one of two things
8313: has been done:</p>
1.128 wiz 8314: <div class="orderedlist"><ol class="orderedlist" type="1">
8315: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8316: <code class="filename">libfoo.la</code>, not
8317: <code class="filename">foo.la</code></p></li>
1.128 wiz 8318: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8319: </ol></div>
8320: </li>
1.128 wiz 8321: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8322: The function lt_dlinit() should be called and the macro
8323: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8324: executables.</p></li>
1.75 rillig 8325: </ul></div>
8326: </div>
1.148 asau 8327: <div class="sect2">
1.75 rillig 8328: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8329: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8330: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8331: to regenerate the configure script and Makefile.in makefile
8332: templates, then they should be executed in a pre-configure
8333: target.</p>
1.75 rillig 8334: <p>For packages that need only autoconf:</p>
8335: <pre class="programlisting">
1.100 rillig 8336: AUTOCONF_REQD= 2.50 # if default version is not good enough
8337: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8338: ...
1.1 grant 8339:
1.100 rillig 8340: pre-configure:
8341: cd ${WRKSRC} && autoconf
1.1 grant 8342:
1.100 rillig 8343: ...
1.87 wiz 8344: </pre>
1.75 rillig 8345: <p>and for packages that need automake and autoconf:</p>
8346: <pre class="programlisting">
1.100 rillig 8347: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8348: USE_TOOLS+= automake # use "automake14" for automake-1.4
8349: ...
8350:
8351: pre-configure:
8352: set -e; cd ${WRKSRC}; \
8353: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8354:
1.100 rillig 8355: ...
1.87 wiz 8356: </pre>
1.75 rillig 8357: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8358: require GNU Make.</p>
1.75 rillig 8359: <p>There are times when the configure process makes
1.87 wiz 8360: additional changes to the generated files, which then causes
8361: the build process to try to re-execute the automake sequence.
8362: This is prevented by touching various files in the configure
8363: stage. If this causes problems with your package you can set
8364: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8365: Makefile.</p>
1.75 rillig 8366: </div>
8367: </div>
1.148 asau 8368: <div class="sect1">
1.75 rillig 8369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8370: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 8371: <div class="sect2">
1.87 wiz 8372: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8373: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8374: <p>Compilers for the C, C++, and Fortran languages comes with
8375: the NetBSD base system. By default, pkgsrc assumes that a package
8376: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8377: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8378: <p>To declare which language's compiler a package needs, set
8379: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8380: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8381: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8382: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8383: written in C++, usually need a C compiler for the configure
8384: phase.</p>
8385: </div>
1.148 asau 8386: <div class="sect2">
1.87 wiz 8387: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8388: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8389: <p>If a program is written in Java, use the Java framework in
8390: pkgsrc. The package must include
8391: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8392: provides the following variables:</p>
1.148 asau 8393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8394: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8395: dependency on the JDK is added. If
1.128 wiz 8396: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8397: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8398: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8399: JDK.</p></li>
1.128 wiz 8400: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8401: a package needs a Java2 implementation. The supported values
1.128 wiz 8402: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8403: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8404: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8405: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8406: above. This variable is not set by default.</p></li>
1.130 wiz 8407: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8408: automatically set to the runtime location of the used Java
8409: implementation dependency. It may be used to set
8410: <code class="varname">JAVA_HOME</code> to a good value if the program
8411: needs this variable to be defined.
8412: </p></li>
1.87 wiz 8413: </ul></div>
8414: </div>
1.148 asau 8415: <div class="sect2">
1.87 wiz 8416: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8417: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8418: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8419: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8420: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8421: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8422: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8423: that you want adjusted. Every occurrence of
8424: <code class="filename">*/bin/perl</code> in a she-bang line will be
8425: replaced with the full path to the perl executable.</p>
1.87 wiz 8426: <p>If a particular version of perl is needed, set the
8427: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8428: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8429: <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 8430: about handling perl modules.</p>
8431: </div>
1.148 asau 8432: <div class="sect2">
1.87 wiz 8433: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8434: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8435: <p><code class="varname">REPLACE_SH</code>,
8436: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8437: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8438: hash bangs in files. Please use the appropriate one, prefering
8439: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8440: Each should contain a list of scripts, relative to
8441: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8442: occurrence of the matching shell in a she-bang line will be
8443: replaced with the full path to the shell executable.
1.147 wiz 8444: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8445: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8446: </div>
1.148 asau 8447: <div class="sect2">
1.147 wiz 8448: <div class="titlepage"><div><div><h3 class="title">
8449: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8450: <p>Currently, there is no special handling for other languages
8451: in pkgsrc. If a compiler package provides a
8452: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8453: just add a (build) dependency on the appropriate compiler
8454: package.</p>
8455: </div>
8456: </div>
1.148 asau 8457: <div class="sect1">
1.87 wiz 8458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8459: <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 8460: <p>The most common failures when building a package are that
8461: some platforms do not provide certain header files, functions or
8462: libraries, or they provide the functions in a library that the
8463: original package author didn't know. To work around this, you
8464: can rewrite the source code in most cases so that it does not
8465: use the missing functions or provides a replacement function.</p>
1.148 asau 8466: <div class="sect2">
1.77 rillig 8467: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8468: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8469: <p>If a package already comes with a GNU configure script, the
8470: preferred way to fix the build failure is to change the
8471: configure script, not the code. In the other cases, you can
8472: utilize the C preprocessor, which defines certain macros
8473: depending on the operating system and hardware architecture it
8474: compiles for. These macros can be queried using for example
8475: <code class="varname">#if defined(__i386)</code>. Almost every operating
8476: system, hardware architecture and compiler has its own macro.
8477: For example, if the macros <code class="varname">__GNUC__</code>,
8478: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8479: are all defined, you know that you are using NetBSD on an i386
8480: compatible CPU, and your compiler is GCC.</p>
8481: <p>The list of the following macros for hardware and
8482: operating system depends on the compiler that is used. For
8483: example, if you want to conditionally compile code on Solaris,
8484: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8485: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8486: <div class="sect3">
1.75 rillig 8487: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8488: <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 8489: <p>To distinguish between 4.4 BSD-derived systems and the
8490: rest of the world, you should use the following code.</p>
8491: <pre class="programlisting">
1.100 rillig 8492: #include <sys/param.h>
8493: #if (defined(BSD) && BSD >= 199306)
8494: /* BSD-specific code goes here */
8495: #else
8496: /* non-BSD-specific code goes here */
8497: #endif
1.75 rillig 8498: </pre>
1.77 rillig 8499: <p>If this distinction is not fine enough, you can also test
8500: for the following macros.</p>
1.75 rillig 8501: <pre class="programlisting">
1.151 obache 8502: Cygwin __CYGWIN__
8503: DragonFly __DragonFly__
1.100 rillig 8504: FreeBSD __FreeBSD__
1.151 obache 8505: Haiku __HAIKU__
1.100 rillig 8506: Interix __INTERIX
8507: IRIX __sgi (TODO: get a definite source for this)
8508: Linux linux, __linux, __linux__
1.193 dholland 8509: Mac OS X __APPLE__
1.151 obache 8510: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8511: Minix3 __minix
1.100 rillig 8512: NetBSD __NetBSD__
8513: OpenBSD __OpenBSD__
8514: Solaris sun, __sun
1.75 rillig 8515: </pre>
8516: </div>
1.148 asau 8517: <div class="sect3">
1.75 rillig 8518: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8519: <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 8520: <pre class="programlisting">
1.100 rillig 8521: i386 i386, __i386, __i386__
8522: MIPS __mips
8523: SPARC sparc, __sparc
1.75 rillig 8524: </pre>
8525: </div>
1.148 asau 8526: <div class="sect3">
1.75 rillig 8527: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8528: <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 8529: <pre class="programlisting">
1.100 rillig 8530: GCC __GNUC__ (major version), __GNUC_MINOR__
8531: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8532: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8533: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8534: </pre>
8535: </div>
8536: </div>
1.148 asau 8537: <div class="sect2">
1.78 rillig 8538: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8539: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8540: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8541: combinations of compiler version and architecture and almost
8542: always relation to optimisation being enabled. Common symptoms
8543: are gcc internal errors or never finishing compiling a
1.78 rillig 8544: file.</p>
8545: <p>Typically, a workaround involves testing the
8546: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8547: optimisation for that combination of file,
1.198 ! tnn 8548: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
! 8549: <p>This used to be a big problem in the past, but is rarely
! 8550: needed now as compiler technology has matured. If you still need
! 8551: to add a compiler specific workaround, please do so in the file
! 8552: <code class="filename">hacks.mk</code> and describe the symptom and
! 8553: compiler version as detailed as possible.</p>
1.78 rillig 8554: </div>
1.148 asau 8555: <div class="sect2">
1.78 rillig 8556: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8557: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8558: </h3></div></div></div>
1.92 rillig 8559: <p>This error message often means that a package did not
1.78 rillig 8560: link to a shared library it needs. The following functions are
8561: known to cause this error message over and over.</p>
8562: <div class="informaltable">
8563: <a name="undefined-reference-functions"></a><table border="1">
8564: <colgroup>
8565: <col>
8566: <col>
8567: <col>
8568: </colgroup>
8569: <thead><tr>
8570: <th>Function</th>
8571: <th>Library</th>
8572: <th>Affected platforms</th>
8573: </tr></thead>
8574: <tbody>
8575: <tr>
8576: <td>accept, bind, connect</td>
8577: <td>-lsocket</td>
8578: <td>Solaris</td>
8579: </tr>
8580: <tr>
8581: <td>crypt</td>
8582: <td>-lcrypt</td>
8583: <td>DragonFly, NetBSD</td>
8584: </tr>
8585: <tr>
8586: <td>dlopen, dlsym</td>
8587: <td>-ldl</td>
8588: <td>Linux</td>
8589: </tr>
8590: <tr>
8591: <td>gethost*</td>
8592: <td>-lnsl</td>
8593: <td>Solaris</td>
8594: </tr>
8595: <tr>
8596: <td>inet_aton</td>
8597: <td>-lresolv</td>
8598: <td>Solaris</td>
8599: </tr>
8600: <tr>
8601: <td>nanosleep, sem_*, timer_*</td>
8602: <td>-lrt</td>
8603: <td>Solaris</td>
8604: </tr>
8605: <tr>
8606: <td>openpty</td>
8607: <td>-lutil</td>
8608: <td>Linux</td>
8609: </tr>
8610: </tbody>
8611: </table>
8612: </div>
8613: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8614: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8615: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8616: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8617: bmake</strong></span>.</p>
1.148 asau 8618: <div class="sect3">
1.92 rillig 8619: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8620: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8621: <p>When you are using the SunPro compiler, there is another
8622: possibility. That compiler cannot handle the following code:</p>
8623: <pre class="programlisting">
1.100 rillig 8624: extern int extern_func(int);
1.93 rillig 8625:
1.100 rillig 8626: static inline int
8627: inline_func(int x)
8628: {
1.92 rillig 8629: return extern_func(x);
1.100 rillig 8630: }
1.93 rillig 8631:
1.100 rillig 8632: int main(void)
8633: {
1.92 rillig 8634: return 0;
1.100 rillig 8635: }
1.92 rillig 8636: </pre>
8637: <p>It generates the code for <code class="function">inline_func</code> even if
8638: that function is never used. This code then refers to
8639: <code class="function">extern_func</code>, which can usually not be resolved. To
8640: solve this problem you can try to tell the package to disable inlining
8641: of functions.</p>
8642: </div>
1.87 wiz 8643: </div>
1.148 asau 8644: <div class="sect2">
1.87 wiz 8645: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8646: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8647: <p>Sometimes packages fail to build because the compiler runs
8648: into an operating system specific soft limit. With the
8649: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8650: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8651: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8652: Setting this variable is similar to running the shell builtin
1.110 hubertf 8653: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8654: segment size or maximum stack size of a process, respectively, to
8655: their hard limits.</p>
1.78 rillig 8656: </div>
1.75 rillig 8657: </div>
1.148 asau 8658: <div class="sect1">
1.75 rillig 8659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8660: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 8661: <div class="sect2">
1.75 rillig 8662: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8663: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8664: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8665: with some operating systems cannot create more than one
8666: directory at a time. As such, you should call
8667: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8668: <pre class="programlisting">
1.100 rillig 8669: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8670: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8671: </pre>
1.128 wiz 8672: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8673: dir2</code></span>”</span> to the
1.87 wiz 8674: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8675: automatically do the right thing.</p>
1.75 rillig 8676: </div>
1.148 asau 8677: <div class="sect2">
1.75 rillig 8678: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8679: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8680: <p>In general, documentation should be installed into
1.87 wiz 8681: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8682: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8683: includes the version number of the package).</p>
1.84 wiz 8684: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8685: directory where HTML documentation is installed with the
1.128 wiz 8686: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8687: is needed because otherwise the documentation ends up in
8688: <code class="filename">${PREFIX}/share/doc/html</code> or other
8689: places.</p>
8690: <p>An exception to the above is that library API documentation
1.189 snj 8691: 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 8692: browsers (devhelp) should be left at their default location, which
8693: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8694: documentation can be recognized from files ending in
8695: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8696: (It is also acceptable to install such files in
8697: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8698: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8699: <code class="filename">.devhelp*</code> file must be directly in that
8700: directory then, no additional subdirectory level is allowed in
8701: this case. This is usually achieved by using
1.128 wiz 8702: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8703: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8704: though.)</p>
1.75 rillig 8705: </div>
1.148 asau 8706: <div class="sect2">
1.75 rillig 8707: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8708: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8709: <p>Certain packages, most of them in the games category, install
1.87 wiz 8710: a score file that allows all users on the system to record their
8711: highscores. In order for this to work, the binaries need to be
8712: installed setgid and the score files owned by the appropriate
1.142 wiz 8713: group and/or owner (traditionally the "games" user/group). Set
8714: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8715: following variables, documented in more detail in
8716: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8717: behaviour: <code class="varname">GAMEDATAMODE</code>,
8718: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8719: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 8720: <p>A package should therefore never hard code file ownership or
1.87 wiz 8721: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8722: <code class="varname">INSTALL_GAME_DATA</code> to set these
8723: correctly.</p>
1.75 rillig 8724: </div>
1.148 asau 8725: <div class="sect2">
1.75 rillig 8726: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8727: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8728: <p><code class="varname">DESTDIR</code> support means that a package
8729: installs into a staging directory, not the final location of the
8730: files. Then a binary package is created which can be used for
8731: installation as usual. There are two ways: Either the package must
1.128 wiz 8732: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8733: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8734: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8735: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 8736: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8737: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8738: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8739: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8740: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8741: the inclusion.</p></li>
1.128 wiz 8742: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8743: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8744: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8745: automatically. Many manual rules and pre/post-install often are
8746: incorrect; fix them.</p></li>
1.128 wiz 8747: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8748: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8749: <li class="listitem"><p>In general, packages should support
1.103 wiz 8750: <code class="varname">UNPRIVILEGED</code> to be able to use
8751: DESTDIR.</p></li>
8752: </ul></div>
8753: </div>
1.148 asau 8754: <div class="sect2">
1.103 wiz 8755: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8756: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8757: <p>Your package may also contain scripts with hardcoded paths to
8758: other interpreters besides (or as well as) perl. To correct the
8759: full pathname to the script interpreter, you need to set the
8760: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8761: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8762: <pre class="programlisting">
1.100 rillig 8763: REPLACE_INTERPRETER+= tcl
8764: REPLACE.tcl.old= .*/bin/tclsh
8765: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8766: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8767: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8768: </pre>
1.148 asau 8769: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8770: <h3 class="title">Note</h3>
8771: <p>Before March 2006, these variables were called
1.87 wiz 8772: <code class="varname">_REPLACE.*</code> and
8773: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8774: </div>
8775: </div>
1.148 asau 8776: <div class="sect2">
1.75 rillig 8777: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8778: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8779: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8780: the Makefile fragment
8781: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8782: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8783: configuration for such modules as well as various hooks to tune
8784: this configuration. See comments in this file for
8785: details.</p>
1.75 rillig 8786: <p>Perl5 modules will install into different places depending
1.87 wiz 8787: on the version of perl used during the build process. To
8788: address this, pkgsrc will append lines to the
8789: <code class="filename">PLIST</code> corresponding to the files listed in
8790: the installed <code class="filename">.packlist</code> file generated by
8791: most perl5 modules. This is invoked by defining
8792: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8793: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8794: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8795: e.g.:</p>
1.75 rillig 8796: <pre class="programlisting">
1.153 wiz 8797: PERL5_PACKLIST= auto/Pg/.packlist
1.87 wiz 8798: </pre>
1.153 wiz 8799: <p>The perl5 config variables
8800: <code class="varname">installarchlib</code>,
8801: <code class="varname">installscript</code>,
8802: <code class="varname">installvendorbin</code>,
8803: <code class="varname">installvendorscript</code>,
8804: <code class="varname">installvendorarch</code>,
8805: <code class="varname">installvendorlib</code>,
8806: <code class="varname">installvendorman1dir</code>, and
8807: <code class="varname">installvendorman3dir</code> represent those
8808: locations in which components of perl5 modules may be installed,
8809: provided as variable with uppercase and prefixed with
8810: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8811: and may be used by perl5 packages that don't have a packlist.
8812: These variables are also substituted for in the
8813: <code class="filename">PLIST</code> as uppercase prefixed with
8814: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8815: </div>
1.148 asau 8816: <div class="sect2">
1.75 rillig 8817: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8818: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8819: <p>Some packages install info files or use the
1.128 wiz 8820: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8821: commands. <code class="varname">INFO_FILES</code> should be defined in
8822: the package Makefile so that <code class="filename">INSTALL</code> and
8823: <code class="filename">DEINSTALL</code> scripts will be generated to
8824: handle registration of the info files in the Info directory
1.128 wiz 8825: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8826: files registration is either provided by the system, or by a
8827: special purpose package automatically added as dependency if
8828: needed.</p>
1.75 rillig 8829: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8830: <code class="filename">${PREFIX}</code> where info files are primarily
8831: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8832: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8833: <p>The info files for the package should be listed in the
1.87 wiz 8834: package <code class="filename">PLIST</code>; however any split info files
8835: need not be listed.</p>
1.128 wiz 8836: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8837: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8838: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8839: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8840: should be noted with the <code class="varname">TEXINFO_REQD</code>
8841: variable in the package <code class="filename">Makefile</code>. By
8842: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8843: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8844: does not match the required minimum, a build dependency on the
1.189 snj 8845: <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 8846: be added automatically.</p>
1.75 rillig 8847: <p>The build and installation process of the software provided
1.87 wiz 8848: by the package should not use the
1.110 hubertf 8849: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8850: info files is the task of the package
8851: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8852: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8853: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8854: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8855: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8856: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8857: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8858: no effect except the logging of a message. The script overriding
1.110 hubertf 8859: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8860: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8861: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8862: </div>
1.148 asau 8863: <div class="sect2">
1.75 rillig 8864: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8865: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8866: <p>All packages that install manual pages should install them
1.87 wiz 8867: into the same directory, so that there is one common place to look
8868: for them. In pkgsrc, this place is
8869: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8870: should be used in packages. The default for
8871: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8872: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8873: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8874: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8875: <h3 class="title">Note</h3>
1.87 wiz 8876: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8877: is far from complete.</p>
1.75 rillig 8878: </div>
1.81 rillig 8879: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8880: <code class="filename">man/</code> as the top level directory for the man
8881: page file entries, and the pkgsrc framework will convert as
8882: needed. In all other places, the correct
8883: <code class="varname">PKGMANDIR</code> must be used.</p>
8884: <p>Packages that are
8885: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8886: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8887: <code class="filename">./configure</code>
8888: --mandir switch to set where the man pages should be installed.
8889: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8890: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8891: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8892: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8893: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8894: Or if the <code class="filename">./configure</code> script uses
8895: a non-standard use of --mandir, you can set
8896: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8897: <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 8898: information on installation of compressed manual pages.</p>
1.75 rillig 8899: </div>
1.148 asau 8900: <div class="sect2">
1.75 rillig 8901: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8902: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8903: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8904: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8905: you need to take some extra steps to make sure they get registered
8906: in the database:</p>
1.128 wiz 8907: <div class="orderedlist"><ol class="orderedlist" type="1">
8908: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8909: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8910: takes care of rebuilding the GConf database at installation and
1.87 wiz 8911: deinstallation time, and tells the package where to install
1.107 rillig 8912: GConf data files using some standard configure arguments. It
1.87 wiz 8913: also disallows any access to the database directly from the
8914: package.</p></li>
1.128 wiz 8915: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8916: <code class="filename">.schemas</code> files under
8917: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8918: installed under <code class="filename">${PREFIX}/etc</code>, you will
8919: need to manually patch the package.</p></li>
1.128 wiz 8920: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8921: directory, as they will be handled automatically. See
1.194 bsiegert 8922: <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 8923: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8924: your <code class="filename">Makefile</code> with a list of all
8925: <code class="filename">.schemas</code> files installed by the package, if
8926: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8927: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8928: your <code class="filename">Makefile</code> with a
8929: list of all <code class="filename">.entries</code> files installed by the
8930: package, if any. Names must not contain any directories in
8931: them.</p></li>
1.75 rillig 8932: </ol></div>
8933: </div>
1.148 asau 8934: <div class="sect2">
1.75 rillig 8935: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 8936: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8937: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8938: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8939: get registered in the database:</p>
1.128 wiz 8940: <div class="orderedlist"><ol class="orderedlist" type="1">
8941: <li class="listitem"><p>Include
1.119 mishka 8942: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8943: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8944: takes care of rebuilding the scrollkeeper database at
8945: installation and deinstallation time, and disallows any access
8946: to it directly from the package.</p></li>
1.128 wiz 8947: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8948: <code class="filename">libdata/scrollkeeper</code> directory, as they
8949: will be handled automatically.</p></li>
1.128 wiz 8950: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 8951: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8952: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 8953: </ol></div>
8954: </div>
1.148 asau 8955: <div class="sect2">
1.75 rillig 8956: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8957: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8958: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8959: the fonts database in the directory where they get installed at
8960: installation and deinstallation time. This can be automatically
8961: done by using the pkginstall framework.</p>
1.75 rillig 8962: <p>You can list the directories where fonts are installed in the
1.87 wiz 8963: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8964: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 8965: <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 8966: Also make sure that the database file
8967: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8968: <p>Note that you should not create new directories for fonts;
1.87 wiz 8969: instead use the standard ones to avoid that the user needs to
8970: manually configure his X server to find them.</p>
1.75 rillig 8971: </div>
1.148 asau 8972: <div class="sect2">
1.75 rillig 8973: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8974: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8975: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8976: take some extra steps to get them registered in the GTK2 database
8977: properly:</p>
1.128 wiz 8978: <div class="orderedlist"><ol class="orderedlist" type="1">
8979: <li class="listitem"><p>Include
1.87 wiz 8980: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8981: <code class="filename">buildlink3.mk</code> file. This takes care of
8982: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 8983: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 8984: your package installs GTK2 immodules.</p></li>
1.128 wiz 8985: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 8986: GTK2 loaders.</p></li>
1.128 wiz 8987: <li class="listitem">
1.87 wiz 8988: <p>Patch the package to not touch any of the GTK2
8989: databases directly. These are:</p>
1.148 asau 8990: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8991: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8992: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8993: </ul></div>
8994: </li>
1.128 wiz 8995: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 8996: any entries under the <code class="filename">libdata/gtk-2.0</code>
8997: directory, as they will be handled automatically.</p></li>
1.75 rillig 8998: </ol></div>
8999: </div>
1.148 asau 9000: <div class="sect2">
1.75 rillig 9001: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9002: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9003: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9004: registered in system-wide catalogs (like DTDs, sub-catalogs,
9005: etc.), you need to take some extra steps:</p>
1.128 wiz 9006: <div class="orderedlist"><ol class="orderedlist" type="1">
9007: <li class="listitem"><p>Include
1.87 wiz 9008: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9009: your <code class="filename">Makefile</code>, which takes care of
9010: registering those files in system-wide catalogs at
9011: installation and deinstallation time.</p></li>
1.128 wiz 9012: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9013: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9014: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9015: any XML catalogs installed by the package.</p></li>
1.128 wiz 9016: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9017: to be added to the SGML catalog. These come in groups of
9018: three strings; see xmlcatmgr(1) for more information
9019: (specifically, arguments recognized by the 'add' action).
9020: Note that you will normally not use this variable.</p></li>
1.128 wiz 9021: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9022: to be added to the XML catalog. These come in groups of three
9023: strings; see xmlcatmgr(1) for more information (specifically,
9024: arguments recognized by the 'add' action). Note that you will
9025: normally not use this variable.</p></li>
1.75 rillig 9026: </ol></div>
9027: </div>
1.148 asau 9028: <div class="sect2">
1.75 rillig 9029: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9030: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9031: <p>If a package provides extensions to the MIME database by
1.87 wiz 9032: installing <code class="filename">.xml</code> files inside
9033: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9034: need to take some extra steps to ensure that the database is kept
9035: consistent with respect to these new files:</p>
1.128 wiz 9036: <div class="orderedlist"><ol class="orderedlist" type="1">
9037: <li class="listitem"><p>Include
1.87 wiz 9038: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9039: (avoid using the <code class="filename">buildlink3.mk</code> file from
9040: this same directory, which is reserved for inclusion from
9041: other <code class="filename">buildlink3.mk</code> files). It takes
9042: care of rebuilding the MIME database at installation and
9043: deinstallation time, and disallows any access to it directly
9044: from the package.</p></li>
1.128 wiz 9045: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9046: <code class="filename">share/mime</code> directory,
9047: <span class="emphasis"><em>except</em></span> for files saved under
9048: <code class="filename">share/mime/packages</code>. The former are
9049: handled automatically by
9050: the update-mime-database program, but the latter are
9051: package-dependent and must be removed by the package that
9052: installed them in the first place.</p></li>
1.128 wiz 9053: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9054: from the PLIST. They will be handled by the shared-mime-info
9055: package.</p></li>
1.75 rillig 9056: </ol></div>
9057: </div>
1.148 asau 9058: <div class="sect2">
1.75 rillig 9059: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9060: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9061: <p>If a package uses intltool during its build, add
9062: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9063: which forces it to use the intltool package provided by pkgsrc,
9064: instead of the one bundled with the distribution file.</p>
1.75 rillig 9065: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9066: latest available version; this way, the package benefits of any
9067: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9068: </div>
1.148 asau 9069: <div class="sect2">
1.75 rillig 9070: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9071: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9072: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9073: the startup directory by default, but you can enable it, by adding
9074: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9075: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9076: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9077: it will automatically remove the scripts when the package is
9078: deinstalled.</p>
1.75 rillig 9079: </div>
1.148 asau 9080: <div class="sect2">
1.75 rillig 9081: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9082: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9083: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9084: the <code class="filename">ls-R</code> database of the tree needs to be
9085: updated.</p>
1.148 asau 9086: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9087: <h3 class="title">Note</h3>
1.125 wiz 9088: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9089: packages should install files
1.125 wiz 9090: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9091: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9092: </div>
1.128 wiz 9093: <div class="orderedlist"><ol class="orderedlist" type="1">
9094: <li class="listitem"><p>Include
1.125 wiz 9095: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9096: takes care of rebuilding the <code class="filename">ls-R</code>
9097: database at installation and deinstallation time.</p></li>
1.128 wiz 9098: <li class="listitem">
1.75 rillig 9099: <p>If your package installs files into a texmf
1.87 wiz 9100: tree other than the one
1.125 wiz 9101: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9102: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9103: trees that need database update.</p>
1.75 rillig 9104: <p>If your package also installs font map files that need
1.110 hubertf 9105: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9106: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9107: set <code class="varname">TEX_MAP_FILES</code> and/or
9108: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9109: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9110: be run automatically at installation/deinstallation to
9111: enable/disable font map files for TeX output
9112: drivers.</p>
1.75 rillig 9113: </li>
1.128 wiz 9114: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9115: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9116: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9117: </ol></div>
9118: </div>
1.148 asau 9119: <div class="sect2">
1.85 jmmv 9120: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9121: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9122: emulation</h3></div></div></div>
9123: <p>There are some packages that provide libraries and
9124: executables for running binaries from a one operating system
9125: on a different one (if the latter supports it). One example
9126: is running Linux binaries on NetBSD.</p>
1.189 snj 9127: <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 9128: helps in extracting and packaging Linux rpm packages.</p>
9129: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9130: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9131: if all libraries for each installed executable can be found by
9132: the dynamic linker. Since the standard dynamic linker is run,
9133: this fails for emulation packages, because the libraries used
9134: by the emulation are not in the standard directories.</p>
9135: </div>
1.148 asau 9136: <div class="sect2">
1.87 wiz 9137: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9138: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9139: <p>If a package installs images under the
1.87 wiz 9140: <code class="filename">share/icons/hicolor</code> and/or updates the
9141: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9142: database, you need to take some extra steps to make sure that the
9143: shared theme directory is handled appropriately and that the cache
9144: database is rebuilt:</p>
1.128 wiz 9145: <div class="orderedlist"><ol class="orderedlist" type="1">
9146: <li class="listitem"><p>Include
1.87 wiz 9147: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9148: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9149: entry that refers to the theme cache.</p></li>
1.128 wiz 9150: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9151: directories from the <code class="filename">share/icons/hicolor</code>
9152: hierarchy because they will be handled automatically.</p></li>
9153: </ol></div>
9154: <p>The best way to verify that the PLIST is correct with
9155: respect to the last two points is to regenerate it using
1.110 hubertf 9156: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9157: </div>
1.148 asau 9158: <div class="sect2">
1.85 jmmv 9159: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9160: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9161: <p>If a package installs <code class="filename">.desktop</code> files
9162: under <code class="filename">share/applications</code> and these include
1.159 rodent 9163: MIME information (MimeType key), you need to take extra steps to
9164: ensure that they are registered into the MIME database:</p>
1.128 wiz 9165: <div class="orderedlist"><ol class="orderedlist" type="1">
9166: <li class="listitem"><p>Include
1.85 jmmv 9167: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9168: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9169: <code class="filename">share/applications/mimeinfo.cache</code> file.
9170: It will be handled automatically.</p></li>
9171: </ol></div>
9172: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9173: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9174: print-PLIST</strong></span>.</p>
1.75 rillig 9175: </div>
9176: </div>
1.148 asau 9177: <div class="sect1">
1.87 wiz 9178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9179: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9180: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9181: immediately. In this case, one can plainly mark a package as broken. For
9182: this, one just sets the variable <code class="varname">BROKEN</code> to the
9183: reason why the package is broken (similar to the
9184: <code class="varname">RESTRICTED</code> variable). A user trying to build
9185: the package will immediately be shown this message, and the build
9186: will not be even tried.</p>
9187: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9188: intervals.</p>
9189: </div>
1.75 rillig 9190: </div>
1.148 asau 9191: <div class="chapter">
1.75 rillig 9192: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9193: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9194: <p>To check out all the gotchas when building a package, here are
9195: the steps that I do in order to get a package working. Please note
9196: this is basically the same as what was explained in the previous
9197: sections, only with some debugging aids.</p>
1.148 asau 9198: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9199: <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>
9200: <li class="listitem">
1.189 snj 9201: <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 9202: create a directory for a new package, change into it, then run
1.110 hubertf 9203: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9204: <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>
9205: <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>
9206: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9207: </li>
1.128 wiz 9208: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9209: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9210: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9211: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9212: configure step to the package's
9213: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9214: <li class="listitem">
1.75 rillig 9215: <p>Make the package compile, doing multiple rounds of</p>
9216: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9217: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9218: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9219: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9220: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9221: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9222: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9223: <p>Doing this step as non-root user will ensure that no files
9224: are modified that shouldn't be, especially during the build
1.110 hubertf 9225: phase. <span class="command"><strong>mkpatches</strong></span>,
9226: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.189 snj 9227: 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 9228: package.</p>
1.75 rillig 9229: </li>
1.128 wiz 9230: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9231: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9232: <li class="listitem">
1.76 rillig 9233: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9234: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9235: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9236: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9237: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9238: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9239: <p>You usually need to be <code class="username">root</code> to do
9240: this. Look if there are any files left:</p>
1.75 rillig 9241: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9242: <p>If this reveals any files that are missing in
1.88 wiz 9243: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9244: </li>
1.128 wiz 9245: <li class="listitem">
1.88 wiz 9246: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9247: package again and make a binary package:</p>
1.75 rillig 9248: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9249: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9250: </li>
1.128 wiz 9251: <li class="listitem">
1.75 rillig 9252: <p>Delete the installed package:</p>
1.88 wiz 9253: <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 9254: </li>
1.128 wiz 9255: <li class="listitem">
1.110 hubertf 9256: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9257: command, which shouldn't find anything now:</p>
1.75 rillig 9258: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9259: </li>
1.128 wiz 9260: <li class="listitem">
1.75 rillig 9261: <p>Reinstall the binary package:</p>
1.93 rillig 9262: <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 9263: </li>
1.128 wiz 9264: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9265: <li class="listitem">
1.189 snj 9266: <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 9267: reports:</p>
1.75 rillig 9268: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9269: </li>
1.128 wiz 9270: <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 9271: </ul></div>
9272: </div>
1.148 asau 9273: <div class="chapter">
1.75 rillig 9274: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9275: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9276: <div class="toc">
9277: <p><b>Table of Contents</b></p>
1.195 wiz 9278: <dl class="toc">
1.106 rillig 9279: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9280: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9281: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 9282: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9283: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9284: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9285: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9286: </dl>
9287: </div>
1.148 asau 9288: <div class="sect1">
1.75 rillig 9289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9290: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9291: <p>Our policy is that we accept binaries only from pkgsrc
9292: developers to guarantee that the packages don't contain any
9293: trojan horses etc. This is not to annoy anyone but rather to
9294: protect our users! You're still free to put up your home-made
9295: binary packages and tell the world where to get them. NetBSD
9296: developers doing bulk builds and wanting to upload them please
1.174 asau 9297: see <a class="xref" href="#bulk" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 7, <i>Creating binary packages for everything in pkgsrc (bulk
9298: builds)</i></a>.</p>
1.75 rillig 9299: </div>
1.148 asau 9300: <div class="sect1">
1.75 rillig 9301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9302: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9303: <p>First, check that your package is complete, compiles and
1.110 hubertf 9304: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.189 snj 9305: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9306: archive that contains all files that make up the package.
1.87 wiz 9307: Finally, send this package to the pkgsrc bug tracking system,
1.189 snj 9308: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9309: that, go to the web page
1.110 hubertf 9310: <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 9311: which contains some instructions and a link to a form where you
9312: can submit packages. The
1.189 snj 9313: <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
1.124 snj 9314: also available as a substitute for either of the above two tools.
9315: </p>
1.87 wiz 9316: <p>In the form of the problem report, the category should be
1.128 wiz 9317: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9318: and version number, and the description field should contain a
9319: short description of your package (contents of the COMMENT
9320: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9321: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9322: <p>If you want to submit several packages, please send a
9323: separate PR for each one, it's easier for us to track things
9324: that way.</p>
9325: <p>Alternatively, you can also import new packages into
1.128 wiz 9326: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9327: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9328: for details.</p>
9329: </div>
1.148 asau 9330: <div class="sect1">
1.75 rillig 9331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9332: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9333: <p>Please note all package additions, updates, moves, and
1.93 rillig 9334: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9335: important to keep this file up to date and conforming to the
9336: existing format, because it will be used by scripts to
1.110 hubertf 9337: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9338: sites. Additionally, check the
1.76 rillig 9339: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9340: for the package you updated or removed, in case it was mentioned
9341: there.</p>
9342: <p>When the <code class="varname">PKGREVISION</code> of a package is
9343: bumped, the change should appear in
1.93 rillig 9344: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9345: related or otherwise relevant. Mass bumps that result from a
9346: dependency being updated should not be mentioned. In all other
9347: cases it's the developer's decision.</p>
9348: <p>There is a make target that helps in creating proper
1.110 hubertf 9349: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9350: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9351: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9352: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9353: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9354: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9355: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9356: For new packages, or package moves or removals, set the
9357: <code class="varname">CTYPE</code> variable on the command line to "Added",
9358: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9359: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9360: not the same as your NetBSD login name. The target also automatically
9361: removes possibly existing entries for the package in the
9362: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9363: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9364: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9365: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9366: makes the cvs commands use the main repository.
9367: </p>
1.75 rillig 9368: </div>
1.148 asau 9369: <div class="sect1">
1.75 rillig 9370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9371: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9372: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9373: access to the pkgsrc repository.</p>
9374: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9375: Start by adding the directory and then files in the directory. Don't
9376: forget to add the new package to the category's
9377: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9378: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9379: <pre class="programlisting">
9380: <code class="prompt">$</code> cd .../pkgsrc/category
9381: <code class="prompt">$</code> cvs add pkgname
9382: <code class="prompt">$</code> cd pkgname
9383: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9384: <code class="prompt">$</code> cvs add patches/p*
9385: <code class="prompt">$</code> cvs status | less
1.141 wiz 9386: <code class="prompt">$</code> cvs commit
1.140 wiz 9387: <code class="prompt">$</code> cd ..
9388: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9389: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9390: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9391: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9392: </pre>
1.87 wiz 9393: <p>The commit message of the initial import should include part of the
1.76 rillig 9394: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9395: what the package is/does.</p>
1.140 wiz 9396: <p>Also mention the new package in
9397: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9398: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9399: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9400: </div>
1.148 asau 9401: <div class="sect1">
1.75 rillig 9402: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9403: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9404: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9405: changes between old and new versions into the commit log when updating
1.87 wiz 9406: a package. There are various reasons for this:</p>
1.148 asau 9407: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9408: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9409: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9410: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9411: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9412: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9413: repository is very useful for people who read the pkgsrc-changes mailing
9414: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9415: the package.</p></li>
1.75 rillig 9416: </ul></div>
1.87 wiz 9417: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9418: has been released, it should not automatically be upgraded in the CVS
9419: repository. We prefer to be conservative in the packages that are
9420: included in pkgsrc - development or beta packages are not really the
9421: best thing for most places in which pkgsrc is used. Please use your
9422: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9423: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9424: </div>
1.148 asau 9425: <div class="sect1">
1.75 rillig 9426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9427: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9428: <p>Renaming packages is not recommended.</p>
9429: <p>When renaming packages, be sure to fix any references to old name
9430: in other Makefiles, options, buildlink files, etc.</p>
9431: <p>Also When renaming a package, please define
9432: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9433: pattern(s) of the previous package name.
9434: This may be repeated for multiple renames.
9435: The new package would be an exact replacement.
9436: </p>
1.128 wiz 9437: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9438: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9439: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9440: not be an exact replacement but is a suggestion for the replaced
9441: functionality.</p>
9442: </div>
1.148 asau 9443: <div class="sect1">
1.122 reed 9444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9445: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9446: <p>It is preferred that packages are not renamed or moved, but if needed
9447: please follow these steps.
9448: </p>
1.128 wiz 9449: <div class="orderedlist"><ol class="orderedlist" type="1">
9450: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9451: <li class="listitem">
1.75 rillig 9452: <p>Remove all CVS dirs.</p>
1.87 wiz 9453: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9454: <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 9455: <p>and use that for further work.</p>
1.75 rillig 9456: </li>
1.128 wiz 9457: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9458: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9459: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9460: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9461: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9462: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9463: for doing an update using pkgsrc building; for example, it can
1.189 snj 9464: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122 reed 9465: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9466: new <code class="varname">PKGPATH</code> for that moved package. Note that
9467: it may have multiple matches, so the tool should also check on the
9468: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9469: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9470: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9471: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9472: place.</p></li>
1.128 wiz 9473: <li class="listitem">
1.75 rillig 9474: <p>Check if any package depends on it:
9475: </p>
9476: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9477: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9478: </li>
1.128 wiz 9479: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9480: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9481: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9482: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9483: <li class="listitem">
1.75 rillig 9484: <p>Commit the changed and removed files:</p>
9485: <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 9486: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9487: </li>
9488: </ol></div>
9489: </div>
9490: </div>
1.148 asau 9491: <div class="chapter">
1.75 rillig 9492: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9493: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9494: <p>This section contains the answers to questions that may
9495: arise when you are writing a package. If you don't find your
9496: question answered here, first have a look in the other chapters,
9497: and if you still don't have the answer, ask on the
9498: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9499: <div class="qandaset">
1.198 ! tnn 9500: <a name="idm74678480"></a><dl>
1.106 rillig 9501: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9502: MAKEFLAGS, .MAKEFLAGS and
9503: MAKE_FLAGS?</a>
9504: </dt>
1.106 rillig 9505: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9506: MAKE, GMAKE and
9507: MAKE_PROGRAM?</a>
9508: </dt>
1.106 rillig 9509: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9510: CC, PKG_CC and
9511: PKGSRC_COMPILER?</a>
9512: </dt>
1.106 rillig 9513: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9514: BUILDLINK_LDFLAGS,
9515: BUILDLINK_LDADD and
9516: BUILDLINK_LIBS?</a>
9517: </dt>
1.106 rillig 9518: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9519: VARNAME=BUILDLINK_PREFIX.foo
9520: say it's empty?</a>
9521: </dt>
1.106 rillig 9522: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9523: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9524: don't understand the := inside
9525: it.</a>
9526: </dt>
1.106 rillig 9527: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9528: developers?</a>
9529: </dt>
1.106 rillig 9530: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9531: documentation?</a>
9532: </dt>
1.106 rillig 9533: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9534: do?</a>
9535: </dt>
1.75 rillig 9536: </dl>
1.148 asau 9537: <table border="0" style="width: 100%;">
9538: <colgroup>
1.75 rillig 9539: <col align="left" width="1%">
1.128 wiz 9540: <col>
1.148 asau 9541: </colgroup>
1.75 rillig 9542: <tbody>
1.148 asau 9543: <tr class="question">
1.75 rillig 9544: <td align="left" valign="top">
1.198 ! tnn 9545: <a name="devfaq.makeflags"></a><a name="idm74678096"></a><p><b>22.1.</b></p>
1.75 rillig 9546: </td>
9547: <td align="left" valign="top"><p>What is the difference between
9548: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9549: <code class="varname">MAKE_FLAGS</code>?</p></td>
9550: </tr>
9551: <tr class="answer">
1.91 rillig 9552: <td align="left" valign="top"></td>
1.75 rillig 9553: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.189 snj 9554: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 9555: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9556: the <code class="varname">MAKE_PROGRAM</code> when building the
9557: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9558: </tr>
1.148 asau 9559: <tr class="question">
1.75 rillig 9560: <td align="left" valign="top">
1.198 ! tnn 9561: <a name="devfaq.make"></a><a name="idm74674000"></a><p><b>22.2.</b></p>
1.75 rillig 9562: </td>
9563: <td align="left" valign="top"><p>What is the difference between
9564: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9565: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9566: </tr>
9567: <tr class="answer">
1.91 rillig 9568: <td align="left" valign="top"></td>
1.75 rillig 9569: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.189 snj 9570: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 9571: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9572: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9573: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9574: Make program that is used for building the
9575: package.</p></td>
9576: </tr>
1.148 asau 9577: <tr class="question">
1.75 rillig 9578: <td align="left" valign="top">
1.198 ! tnn 9579: <a name="devfaq.cc"></a><a name="idm74669648"></a><p><b>22.3.</b></p>
1.75 rillig 9580: </td>
9581: <td align="left" valign="top"><p>What is the difference between
9582: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9583: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9584: </tr>
9585: <tr class="answer">
1.91 rillig 9586: <td align="left" valign="top"></td>
1.75 rillig 9587: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9588: compiler, which can be configured by the pkgsrc user.
9589: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9590: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9591: path to a compiler, but the type of compiler that should be
1.76 rillig 9592: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9593: information about the latter variable.</p></td>
9594: </tr>
1.148 asau 9595: <tr class="question">
1.75 rillig 9596: <td align="left" valign="top">
1.198 ! tnn 9597: <a name="devfaq.bl3flags"></a><a name="idm74665424"></a><p><b>22.4.</b></p>
1.75 rillig 9598: </td>
9599: <td align="left" valign="top"><p>What is the difference between
9600: <code class="varname">BUILDLINK_LDFLAGS</code>,
9601: <code class="varname">BUILDLINK_LDADD</code> and
9602: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9603: </tr>
9604: <tr class="answer">
1.91 rillig 9605: <td align="left" valign="top"></td>
1.75 rillig 9606: <td align="left" valign="top"><p>[FIXME]</p></td>
9607: </tr>
1.148 asau 9608: <tr class="question">
1.75 rillig 9609: <td align="left" valign="top">
1.198 ! tnn 9610: <a name="devfaq.bl3prefix"></a><a name="idm74663248"></a><p><b>22.5.</b></p>
1.75 rillig 9611: </td>
1.110 hubertf 9612: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9613: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9614: say it's empty?</p></td>
9615: </tr>
9616: <tr class="answer">
1.91 rillig 9617: <td align="left" valign="top"></td>
1.75 rillig 9618: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9619: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9620: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9621: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9622: command.</p></td>
9623: </tr>
1.148 asau 9624: <tr class="question">
1.78 rillig 9625: <td align="left" valign="top">
1.198 ! tnn 9626: <a name="devfaq.master_sites"></a><a name="idm74660176"></a><p><b>22.6.</b></p>
1.78 rillig 9627: </td>
9628: <td align="left" valign="top"><p>What does
9629: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9630: don't understand the <code class="literal">:=</code> inside
9631: it.</p></td>
9632: </tr>
9633: <tr class="answer">
1.91 rillig 9634: <td align="left" valign="top"></td>
1.78 rillig 9635: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9636: assignment operator, like you might expect at first sight.
9637: Instead, it is a degenerate form of
9638: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.189 snj 9639: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78 rillig 9640: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9641: case of <code class="varname">MASTER_SITE_*</code>,
9642: <em class="replaceable"><code>old_string</code></em> is the empty string and
9643: <em class="replaceable"><code>new_string</code></em> is
9644: <code class="literal">package/</code>. That's where the
9645: <code class="literal">:</code> and the <code class="literal">=</code> fall
9646: together.</p></td>
9647: </tr>
1.148 asau 9648: <tr class="question">
1.78 rillig 9649: <td align="left" valign="top">
1.198 ! tnn 9650: <a name="devfaq.mailinglists"></a><a name="idm74652112"></a><p><b>22.7.</b></p>
1.78 rillig 9651: </td>
9652: <td align="left" valign="top"><p>Which mailing lists are there for package
9653: developers?</p></td>
9654: </tr>
9655: <tr class="answer">
1.91 rillig 9656: <td align="left" valign="top"></td>
1.148 asau 9657: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9658: <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 9659: <dd><p>This is a list for technical discussions related
9660: to pkgsrc development, e.g. soliciting feedback for changes to
9661: pkgsrc infrastructure, proposed new features, questions related
9662: to porting pkgsrc to a new platform, advice for maintaining a
9663: package, patches that affect many packages, help requests moved
9664: from pkgsrc-users when an infrastructure bug is found,
9665: etc.</p></dd>
1.110 hubertf 9666: <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 9667: <dd><p>All bug reports in category "pkg" sent with
1.189 snj 9668: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 9669: directly; use one of the other mailing
9670: lists.</p></dd>
9671: </dl></div></td>
9672: </tr>
1.148 asau 9673: <tr class="question">
1.80 rillig 9674: <td align="left" valign="top">
1.198 ! tnn 9675: <a name="devfaq.documentation"></a><a name="idm74648272"></a><p><b>22.8.</b></p>
1.80 rillig 9676: </td>
9677: <td align="left" valign="top"><p>Where is the pkgsrc
9678: documentation?</p></td>
9679: </tr>
9680: <tr class="answer">
1.91 rillig 9681: <td align="left" valign="top"></td>
1.80 rillig 9682: <td align="left" valign="top">
9683: <p>There are many places where you can find
9684: documentation about pkgsrc:</p>
1.148 asau 9685: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9686: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9687: of chapters that explain large parts of pkgsrc, but some
9688: chapters tend to be outdated. Which ones they are is hard to
9689: say.</p></li>
1.128 wiz 9690: <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 9691: about certain features, announcements of new parts of the pkgsrc
9692: infrastructure and sometimes even announcements that a certain
9693: feature has been marked as obsolete. The benefit here is that
9694: each message has a date appended to it.</p></li>
1.128 wiz 9695: <li class="listitem"><p>Many of the files in the
1.80 rillig 9696: <code class="filename">mk/</code> directory start with a comment that
9697: describes the purpose of the file and how it can be used by the
1.92 rillig 9698: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9699: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9700: help</strong></span>.</p></li>
1.128 wiz 9701: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9702: information, but they tend to be highly abbreviated, especially
9703: for actions that occur often. Some contain a detailed
9704: description of what has changed, but they are geared towards the
9705: other pkgsrc developers, not towards an average pkgsrc user.
9706: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9707: don't know what has been before, these messages may not be worth
9708: too much to you.</p></li>
1.128 wiz 9709: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9710: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9711: mind of the developer who wrote the code. To get this
1.110 hubertf 9712: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9713: to see who has written it and ask on the
9714: <code class="literal">tech-pkg</code> mailing list, so that others can
9715: find your questions later (see above). To be sure that the
9716: developer in charge reads the mail, you may CC him or
9717: her.</p></li>
9718: </ul></div>
9719: </td>
9720: </tr>
1.148 asau 9721: <tr class="question">
1.92 rillig 9722: <td align="left" valign="top">
1.198 ! tnn 9723: <a name="devfaq.too-much-time"></a><a name="idm74641744"></a><p><b>22.9.</b></p>
1.92 rillig 9724: </td>
9725: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9726: do?</p></td>
9727: </tr>
9728: <tr class="answer">
9729: <td align="left" valign="top"></td>
9730: <td align="left" valign="top">
1.93 rillig 9731: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9732: anyway.</p>
1.148 asau 9733: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9734: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.189 snj 9735: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.92 rillig 9736: will tell you about newer versions of installed packages that are
9737: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9738: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9739: — it contains a list of suggested new packages and a list of
1.92 rillig 9740: cleanups and enhancements for pkgsrc that would be nice to
9741: have.</p></li>
1.128 wiz 9742: <li class="listitem"><p>Review packages for which review was requested on
1.180 wiz 9743: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92 rillig 9744: mailing list.</p></li>
9745: </ul></div>
9746: </td>
9747: </tr>
1.75 rillig 9748: </tbody>
9749: </table>
9750: </div>
9751: </div>
1.148 asau 9752: <div class="chapter">
1.85 jmmv 9753: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9754: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9755: <div class="toc">
9756: <p><b>Table of Contents</b></p>
1.195 wiz 9757: <dl class="toc">
1.106 rillig 9758: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9759: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9760: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9761: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9762: </dl>
9763: </div>
1.110 hubertf 9764: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9765: site</a>:</p>
9766: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9767: environment, an intuitive and attractive desktop for users, and the
9768: GNOME development platform, an extensive framework for building
9769: applications that integrate into the rest of the desktop.</p></blockquote></div>
9770: <p>pkgsrc provides a seamless way to automatically build and install
9771: a complete GNOME environment <span class="emphasis"><em>under many different
9772: platforms</em></span>. We can say with confidence that pkgsrc is one of
9773: the most advanced build and packaging systems for GNOME due to its
9774: included technologies buildlink3, the wrappers and tools framework and
9775: automatic configuration file management. Lots of efforts are put into
9776: achieving a completely clean deinstallation of installed software
9777: components.</p>
1.110 hubertf 9778: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9779: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9780: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9781: pkgsrc as its preferred packaging system, contributing lots of
9782: portability fixes to make GNOME build and install under it.</p>
9783: <p>This chapter is aimed at pkgsrc developers and other people
9784: interested in helping our GNOME porting and packaging efforts. It
9785: provides instructions on how to manage the existing packages and some
9786: important information regarding their internals.</p>
1.148 asau 9787: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9788: <h3 class="title">We need your help!</h3>
9789: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9790: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9791: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9792: work</a> list! There is still a long way to go to get a
9793: fully-functional GNOME desktop under NetBSD and we need your help to
9794: achieve it!</p>
9795: </div>
1.148 asau 9796: <div class="sect1">
1.85 jmmv 9797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9798: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9799: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9800: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 9801: <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 9802: the core GNOME desktop environment. It only includes the necessary
9803: bits to get it to boot correctly, although it may lack important
9804: functionality for daily operation. The idea behind this package is
9805: to let end users build their own configurations on top of this one,
9806: first installing this meta package to achieve a functional setup and
9807: then adding individual applications.</p></li>
1.189 snj 9808: <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 9809: complete installation of the GNOME platform and desktop as defined
9810: by the GNOME project; this is based on the components distributed in
9811: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9812: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9813: official FTP server. Developer-only tools found in those
9814: directories are not installed unless required by some other
9815: component to work properly. Similarly, packages from the bindings
9816: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9817: in unless required as a dependency for an end-user component. This
1.189 snj 9818: 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>
9819: <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 9820: Installs all the tools required to build a GNOME component when
9821: fetched from the CVS repository. These are required to let the
1.110 hubertf 9822: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9823: </ul></div>
9824: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9825: sorted in a way that eases updates: a package may depend on other
9826: packages listed before it but not on any listed after it. It is very
9827: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9828: change it to alphabetical sorting!</em></span></p>
9829: </div>
1.148 asau 9830: <div class="sect1">
1.85 jmmv 9831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9832: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9833: <p>Almost all GNOME applications are written in C and use a common
9834: set of tools as their build system. Things get different with the new
9835: bindings to other languages (such as Python), but the following will
9836: give you a general idea on the minimum required tools:</p>
1.148 asau 9837: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9838: <li class="listitem">
1.85 jmmv 9839: <p>Almost all GNOME applications use the GNU Autotools as their
9840: build system. As a general rule you will need to tell this to your
9841: package:</p>
1.100 rillig 9842: <pre class="programlisting">
9843: GNU_CONFIGURE=yes
1.85 jmmv 9844: USE_LIBTOOL=yes
1.100 rillig 9845: USE_TOOLS+=gmake
9846: </pre>
1.85 jmmv 9847: </li>
1.128 wiz 9848: <li class="listitem">
1.85 jmmv 9849: <p>If the package uses pkg-config to detect dependencies, add this
9850: tool to the list of required utilities:</p>
9851: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.189 snj 9852: <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 9853: the end of the build process to ensure that you did not miss to
9854: specify any dependency in your package and that the version
9855: requirements are all correct.</p>
9856: </li>
1.128 wiz 9857: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9858: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9859: to handle dependencies and to force the package to use the latest
9860: available version.</p></li>
1.128 wiz 9861: <li class="listitem">
1.85 jmmv 9862: <p>If the package uses gtk-doc (a documentation generation
9863: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9864: tool is rather big and the distfile should come with pregenerated
9865: documentation anyway; if it does not, it is a bug that you ought to
9866: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9867: the default):</p>
9868: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9869: <p>The default location of installed HTML files
9870: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9871: and should not be changed unless the package insists on installing
9872: them somewhere else. Otherwise programs as
1.110 hubertf 9873: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9874: do that with an entry similar to:</p>
9875: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9876: </li>
9877: </ul></div>
9878: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9879: files under the installation prefix to maintain databases. In this
9880: context, shared means that those exact same directories and files are
9881: used among several different packages, leading to conflicts in the
9882: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9883: handle the most common cases, so you have to forget about using
9884: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9885: omitting shared files from them. If you find yourself doing those,
9886: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9887: <p>The following table lists the common situations that result in
9888: using shared directories or files. For each of them, the appropriate
9889: solution is given. After applying the solution be sure to
9890: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9891: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9892: <div class="table">
1.106 rillig 9893: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9894: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9895: <colgroup>
9896: <col>
9897: <col>
9898: </colgroup>
9899: <thead><tr>
9900: <th>If the package...</th>
9901: <th>Then...</th>
9902: </tr></thead>
9903: <tbody>
9904: <tr>
9905: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9906: <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 9907: </tr>
9908: <tr>
9909: <td>Installs icons under the
9910: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9911: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9912: <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 9913: </tr>
9914: <tr>
9915: <td>Installs files under
9916: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9917: <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 9918: </tr>
9919: <tr>
9920: <td>Installs <code class="filename">.desktop</code> files under
9921: <code class="filename">share/applications</code> and these include MIME
9922: information.</td>
1.110 hubertf 9923: <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 9924: </tr>
9925: </tbody>
1.91 rillig 9926: </table></div>
1.85 jmmv 9927: </div>
1.91 rillig 9928: <br class="table-break">
1.85 jmmv 9929: </div>
1.148 asau 9930: <div class="sect1">
1.85 jmmv 9931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9932: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9933: <p>When seeing GNOME as a whole, there are two kinds of
9934: updates:</p>
1.148 asau 9935: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9936: <dt><span class="term">Major update</span></dt>
9937: <dd>
9938: <p>Given that there is still a very long way for GNOME 3 (if it
9939: ever appears), we consider a major update one that goes from a
9940: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9941: where <code class="literal">Y</code> is even and greater than
9942: <code class="literal">X</code>. These are hard to achieve because they
9943: introduce lots of changes in the components' code and almost all
9944: GNOME distfiles are updated to newer versions. Some of them can
9945: even break API and ABI compatibility with the previous major
9946: version series. As a result, the update needs to be done all at
9947: once to minimize breakage.</p>
9948: <p>A major update typically consists of around 80 package
9949: updates and the addition of some new ones.</p>
9950: </dd>
9951: <dt><span class="term">Minor update</span></dt>
9952: <dd>
9953: <p>We consider a minor update one that goes from a
9954: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9955: one where <code class="literal">Y</code> is greater than
9956: <code class="literal">X</code>. These are easy to achieve because they do
9957: not update all GNOME components, can be done in an incremental way
9958: and do not break API nor ABI compatibility.</p>
9959: <p>A minor update typically consists of around 50 package
9960: updates, although the numbers here may vary a lot.</p>
9961: </dd>
9962: </dl></div>
9963: <p>In order to update the GNOME components in pkgsrc to a new stable
9964: release (either major or minor), the following steps should be
9965: followed:</p>
1.128 wiz 9966: <div class="orderedlist"><ol class="orderedlist" type="1">
9967: <li class="listitem">
1.85 jmmv 9968: <p>Get a list of all the tarballs that form the new release by
9969: using the following commands. These will leave the full list of the
1.120 snj 9970: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 9971: file:</p>
1.88 wiz 9972: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9973: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9974: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9975: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9976: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9977: awk '{ print $9 }' >>list.txt</code></strong></pre>
9978: </li>
1.128 wiz 9979: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 9980: bump their version to the release you are updating them to. The
9981: three meta packages should be always consistent with versioning.
9982: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9983: in them.</p></li>
1.128 wiz 9984: <li class="listitem">
1.85 jmmv 9985: <p>For each meta package, update all its
9986: <code class="varname">DEPENDS</code> lines to match the latest versions as
9987: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9988: newer version (even if found in the FTP) because the meta packages
9989: are supposed to list the exact versions that form a specific GNOME
9990: release. Exceptions are permitted here if a newer version solves a
9991: serious issue in the overall desktop experience; these typically
9992: come in the form of a revision bump in pkgsrc, not in newer versions
9993: from the developers.</p>
9994: <p>Packages not listed in the <code class="filename">list.txt</code> file
9995: should be updated to the latest version available (if found in
9996: pkgsrc). This is the case, for example, of the dependencies on the
1.189 snj 9997: 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 9998: </li>
1.128 wiz 9999: <li class="listitem">
1.85 jmmv 10000: <p>Generate a patch from the modified meta packages and extract the
10001: list of "new" lines. This will provide you an outline on what
10002: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10003: <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 10004: </li>
1.128 wiz 10005: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 10006: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 10007: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 10008: of <code class="filename">todo.txt</code> and update the packages listed in
10009: it in order. For major desktop updates none of these should be
1.93 rillig 10010: committed until the entire set is completed because there are chances
1.85 jmmv 10011: of breaking not-yet-updated packages.</p></li>
1.128 wiz 10012: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 10013: the tree one by one with appropriate log messages. At the end,
10014: commit the three meta package updates and all the corresponding
10015: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10016: <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>
10017: </ol></div>
10018: </div>
1.148 asau 10019: <div class="sect1">
1.85 jmmv 10020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10021: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10022: <p>GNOME is a very big component in pkgsrc which approaches 100
10023: packages. Please, it is very important that you always, always,
10024: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10025: 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 10026: their attention on portability issues and to ensure that future versions
10027: can be built out-of-the box on NetBSD. The less custom patches in
10028: pkgsrc, the easier further updates are. Those developers in charge of
10029: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10030: <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 10031: Bugzilla</a>. Not all components use these to track bugs, but most
10032: of them do. Do not be short on your reports: always provide detailed
10033: explanations of the current failure, how it can be improved to achieve
10034: maximum portability and, if at all possible, provide a patch against CVS
10035: head. The more verbose you are, the higher chances of your patch being
10036: accepted.</p>
10037: <p>Also, please avoid using preprocessor magic to fix portability
10038: issues. While the FreeBSD GNOME people are doing a great job in porting
10039: GNOME to their operating system, the official GNOME sources are now
10040: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10041: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10042: 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 10043: details.</p>
10044: </div>
10045: </div>
1.75 rillig 10046: </div>
1.148 asau 10047: <div class="part">
1.75 rillig 10048: <div class="titlepage"><div><div><h1 class="title">
10049: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10050: <div class="partintro">
1.75 rillig 10051: <div></div>
10052: <p>This part of the guide deals with everything
10053: from the infrastructure that is behind the interfaces described
10054: in the developer's guide. A casual package maintainer should not
10055: need anything from this part.</p>
10056: <div class="toc">
10057: <p><b>Table of Contents</b></p>
1.195 wiz 10058: <dl class="toc">
1.106 rillig 10059: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10060: <dd><dl>
1.106 rillig 10061: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10062: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10063: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10064: <dd><dl>
1.106 rillig 10065: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10066: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10067: </dl></dd>
1.106 rillig 10068: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10069: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10070: <dd><dl>
1.106 rillig 10071: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10072: <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 10073: </dl></dd>
1.106 rillig 10074: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10075: <dd><dl>
1.128 wiz 10076: <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>
10077: <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 10078: </dl></dd>
10079: </dl></dd>
1.106 rillig 10080: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10081: <dd><dl>
1.106 rillig 10082: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10083: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10084: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10085: <dd><dl>
1.106 rillig 10086: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10087: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10088: </dl></dd>
10089: </dl></dd>
1.106 rillig 10090: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10091: <dd><dl>
1.106 rillig 10092: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10093: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10094: </dl></dd>
10095: </dl>
10096: </div>
10097: </div>
1.148 asau 10098: <div class="chapter">
1.75 rillig 10099: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10100: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10101: <div class="toc">
10102: <p><b>Table of Contents</b></p>
1.195 wiz 10103: <dl class="toc">
1.106 rillig 10104: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10105: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10106: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10107: <dd><dl>
1.106 rillig 10108: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10109: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10110: </dl></dd>
1.106 rillig 10111: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10112: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10113: <dd><dl>
1.106 rillig 10114: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10115: <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 10116: </dl></dd>
1.106 rillig 10117: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10118: <dd><dl>
1.128 wiz 10119: <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>
10120: <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 10121: </dl></dd>
10122: </dl>
10123: </div>
10124: <p>The pkgsrc infrastructure consists of many small Makefile
10125: fragments. Each such fragment needs a properly specified
10126: interface. This chapter explains how such an interface looks
10127: like.</p>
1.148 asau 10128: <div class="sect1">
1.75 rillig 10129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10130: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10131: <p>Whenever a variable is defined in the pkgsrc
10132: infrastructure, the location and the way of definition provide
10133: much information about the intended use of that variable.
10134: Additionally, more documentation may be found in a header
10135: comment or in this pkgsrc guide.</p>
10136: <p>A special file is
10137: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10138: variables that are intended to be user-defined. They are either
10139: defined using the <code class="literal">?=</code> operator or they are
10140: left undefined because defining them to anything would
1.128 wiz 10141: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10142: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10143: file.</p>
10144: <p>Outside this file, the following conventions apply:
10145: Variables that are defined using the <code class="literal">?=</code>
10146: operator may be overridden by a package.</p>
10147: <p>Variables that are defined using the <code class="literal">=</code>
10148: operator may be used read-only at run-time.</p>
10149: <p>Variables whose name starts with an underscore must not be
10150: accessed outside the pkgsrc infrastructure at all. They may
10151: change without further notice.</p>
1.148 asau 10152: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10153: <h3 class="title">Note</h3>
10154: <p>These conventions are currently not applied
10155: consistently to the complete pkgsrc
10156: infrastructure.</p>
10157: </div>
10158: </div>
1.148 asau 10159: <div class="sect1">
1.81 rillig 10160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10161: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10162: <p>All variables that contain lists of things should default
10163: to being empty. Two examples that do not follow this rule are
10164: <code class="varname">USE_LANGUAGES</code> and
10165: <code class="varname">DISTFILES</code>. These variables cannot simply be
10166: modified using the <code class="literal">+=</code> operator in package
10167: <code class="filename">Makefile</code>s (or other files included by
10168: them), since there is no guarantee whether the variable is
10169: already set or not, and what its value is. In the case of
1.128 wiz 10170: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10171: the default value and just define it as in the following
10172: example.</p>
10173: <pre class="programlisting">
1.100 rillig 10174: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10175: </pre>
10176: <p>Because of the selection of this default value, the same
10177: value appears in many package Makefiles. Similarly for
10178: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10179: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10180: doesn't stand out. Nevertheless it is mentioned in many
10181: files.</p>
10182: </div>
1.148 asau 10183: <div class="sect1">
1.81 rillig 10184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10185: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 10186: <div class="sect2">
1.75 rillig 10187: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10188: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10189: <p>Variable evaluation takes place either at load time or at
10190: runtime, depending on the context in which they occur. The
10191: contexts where variables are evaluated at load time are:</p>
1.148 asau 10192: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10193: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10194: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10195: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10196: <code class="literal">.for</code>,</p></li>
1.128 wiz 10197: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10198: </ul></div>
10199: <p>A special exception are references to the iteration
10200: variables of <code class="literal">.for</code> loops, which are expanded
10201: inline, no matter in which context they appear.</p>
10202: <p>As the values of variables may change during load time,
10203: care must be taken not to evaluate them by accident. Typical
10204: examples for variables that should not be evaluated at load time
10205: are <code class="varname">DEPENDS</code> and
10206: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10207: clear, here is an example:</p>
10208: <pre class="programlisting">
1.100 rillig 10209: CONFIGURE_ARGS= # none
10210: CFLAGS= -O
10211: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10212:
1.100 rillig 10213: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10214:
1.100 rillig 10215: CFLAGS+= -Wall
1.75 rillig 10216: </pre>
10217: <p>This code shows how the use of the <code class="literal">:=</code>
10218: operator can quickly lead to unexpected results. The first
10219: paragraph is fairly common code. The second paragraph evaluates
10220: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10221: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10222: <code class="literal">-Wall</code> is appended to the
10223: <code class="varname">CFLAGS</code>, but this addition will not appear in
10224: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10225: paragraphs from above typically occur in completely unrelated
10226: files.</p>
10227: </div>
1.148 asau 10228: <div class="sect2">
1.75 rillig 10229: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10230: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10231: <p>After all the files have been loaded, the values of the
10232: variables cannot be changed anymore. Variables that are used in
10233: the shell commands are expanded at this point.</p>
10234: </div>
10235: </div>
1.148 asau 10236: <div class="sect1">
1.75 rillig 10237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10238: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10239: <p>There are many ways in which the definition and use of a
10240: variable can be restricted in order to detect bugs and
10241: violations of the (mostly unwritten) policies. See the
10242: <code class="literal">pkglint</code> developer's documentation for further
10243: details.</p>
10244: </div>
1.148 asau 10245: <div class="sect1">
1.78 rillig 10246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10247: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10248: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10249: of the following classes. Cases where a file falls into more
10250: than one class should be avoided as it often leads to subtle
10251: bugs.</p>
1.148 asau 10252: <div class="sect2">
1.75 rillig 10253: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10254: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10255: <p>In a traditional imperative programming language some of
1.76 rillig 10256: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10257: procedures. They take some input parameters and—after
10258: inclusion—provide a result in output parameters. Since all
1.76 rillig 10259: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10260: care must be taken not to use parameter names that have already
10261: another meaning. For example, <code class="varname">PKGNAME</code> is a
10262: bad choice for a parameter name.</p>
10263: <p>Procedures are completely evaluated at preprocessing time.
10264: That is, when calling a procedure all input parameters must be
10265: completely resolvable. For example,
10266: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10267: parameter since it is very likely that further text will be
10268: added after calling the procedure, which would effectively apply
10269: the procedure to only a part of the variable. Also, references
10270: to other variables wit will be modified after calling the
10271: procedure.</p>
10272: <p>A procedure can declare its output parameters either as
10273: suitable for use in preprocessing directives or as only
10274: available at runtime. The latter alternative is for variables
10275: that contain references to other runtime variables.</p>
10276: <p>Procedures shall be written such that it is possible to
10277: call the procedure more than once. That is, the file must not
10278: contain multiple-inclusion guards.</p>
10279: <p>Examples for procedures are
1.76 rillig 10280: <code class="filename">mk/bsd.options.mk</code> and
10281: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10282: that the parameters are evaluated at load time, they should be
10283: assigned using the <code class="literal">:=</code> operator, which should
10284: be used only for this purpose.</p>
10285: </div>
1.148 asau 10286: <div class="sect2">
1.75 rillig 10287: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10288: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10289: <p>Action files take some input parameters and may define
10290: runtime variables. They shall not define loadtime variables.
10291: There are action files that are included implicitly by the
10292: pkgsrc infrastructure, while other must be included
10293: explicitly.</p>
10294: <p>An example for action files is
1.76 rillig 10295: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10296: </div>
10297: </div>
1.148 asau 10298: <div class="sect1">
1.81 rillig 10299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10300: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10301: <p>Package <code class="filename">Makefile</code>s usually consist of
10302: a set of variable definitions, and include the file
10303: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10304: Before that, they may also include various other
10305: <code class="filename">*.mk</code> files if they need to query the
10306: availability of certain features like the type of compiler or
10307: the X11 implementation. Due to the heavy use of preprocessor
10308: directives like <code class="literal">.if</code> and
10309: <code class="literal">.for</code>, the order in which the files are loaded
10310: matters.</p>
10311: <p>This section describes at which point the various files
10312: are loaded and gives reasons for that order.</p>
1.148 asau 10313: <div class="sect2">
1.81 rillig 10314: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10315: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10316: </h3></div></div></div>
10317: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10318: is to define some essential variables like
10319: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10320: <code class="varname">MACHINE_ARCH</code>.</p>
10321: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10322: 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 10323: After that, those variables
1.81 rillig 10324: that have not been overridden by the user are loaded from
10325: <code class="filename">mk/defaults/mk.conf</code>.</p>
10326: <p>After the user settings, the system settings and platform
10327: settings are loaded, which may override the user
10328: settings.</p>
10329: <p>Then, the tool definitions are loaded. The tool wrappers
10330: are not yet in effect. This only happens when building a
10331: package, so the proper variables must be used instead of the
10332: direct tool names.</p>
10333: <p>As the last steps, some essential variables from the
10334: wrapper and the package system flavor are loaded, as well as the
10335: variables that have been cached in earlier phases of a package
10336: build.</p>
10337: </div>
1.148 asau 10338: <div class="sect2">
1.81 rillig 10339: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10340: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10341: </h3></div></div></div>
1.81 rillig 10342: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10343: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10344: loaded, which fill default values for those variables that have
1.93 rillig 10345: not been defined by the package. These variables may later
1.81 rillig 10346: be used even in unrelated files.</p>
10347: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10348: provides the target <code class="literal">error-check</code> that is added
10349: as a special dependency to all other targets that use
10350: <code class="varname">DELAYED_ERROR_MSG</code> or
10351: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10352: <p>Then, the package-specific hacks from
10353: <code class="filename">hacks.mk</code> are included.</p>
10354: <p>Then, various other files follow. Most of them don't have
10355: any dependencies on what they need to have included before or
10356: after them, though some do.</p>
10357: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10358: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10359: restricts the use of these variables to all the files that have
10360: been included before. Appearances in later files will be
10361: silently ignored.</p>
10362: <p>Then, the files for the main targets are included, in the
10363: order of later execution, though the actual order should not
10364: matter.</p>
10365: <p>At last, some more files are included that don't set any
10366: interesting variables but rather just define make targets to be
10367: executed.</p>
10368: </div>
10369: </div>
1.75 rillig 10370: </div>
1.148 asau 10371: <div class="chapter">
1.75 rillig 10372: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10373: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10374: <div class="toc">
10375: <p><b>Table of Contents</b></p>
1.195 wiz 10376: <dl class="toc">
1.106 rillig 10377: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10378: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10379: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10380: <dd><dl>
1.106 rillig 10381: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10382: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10383: </dl></dd>
10384: </dl>
10385: </div>
10386: <p>The pkgsrc infrastructure consists of a large codebase,
10387: and there are many corners where every little bit of a file is
10388: well thought out, making pkgsrc likely to fail as soon as
10389: anything is changed near those parts. To prevent most changes
10390: from breaking anything, a suite of regression tests should go
10391: along with every important part of the pkgsrc infrastructure.
10392: This chapter describes how regression tests work in pkgsrc and
10393: how you can add new tests.</p>
1.148 asau 10394: <div class="sect1">
1.75 rillig 10395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10396: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10397: <p></p>
10398: </div>
1.148 asau 10399: <div class="sect1">
1.75 rillig 10400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10401: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.189 snj 10402: <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 10403: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10404: can simply run that command, which will run all tests in the
1.76 rillig 10405: <code class="filename">regress</code> category.</p>
1.75 rillig 10406: </div>
1.148 asau 10407: <div class="sect1">
1.75 rillig 10408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10409: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10410: <p>Every directory in the <code class="filename">regress</code>
10411: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10412: is considered a regression test. This file is a shell program
1.110 hubertf 10413: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10414: The following functions can be overridden to suit your
10415: needs.</p>
1.148 asau 10416: <div class="sect2">
1.75 rillig 10417: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10418: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10419: <p>These functions do not take any parameters. They are all
1.128 wiz 10420: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10421: to check the exitcodes of any commands you run in the
10422: test.</p>
1.148 asau 10423: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10424: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10425: <dd><p>This function prepares the environment for the
10426: test. By default it does nothing.</p></dd>
10427: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10428: <dd><p>This function runs the actual test. By default,
10429: it calls <code class="varname">TEST_MAKE</code> with the arguments
10430: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10431: error messages into the file
10432: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10433: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10434: <dd><p>This function is run after the test and is
10435: typically used to compare the actual output from the one that is
10436: expected. It can make use of the various helper functions from
10437: the next section.</p></dd>
10438: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10439: <dd><p>This function cleans everything up after the
10440: test has been run. By default it does nothing.</p></dd>
10441: </dl></div>
10442: </div>
1.148 asau 10443: <div class="sect2">
1.75 rillig 10444: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10445: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 asau 10446: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10447: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10448: <dd><p>This function compares the exitcode of the
1.110 hubertf 10449: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10450: If they differ, the test will fail.</p></dd>
10451: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10452: <dd><p>This function checks for each of its parameters
1.110 hubertf 10453: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10454: extended regular expression. If it does not, the test will
10455: fail.</p></dd>
10456: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10457: <dd><p>This function checks for each of its parameters
1.110 hubertf 10458: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10459: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10460: If any of the regular expressions matches, the test will
10461: fail.</p></dd>
10462: </dl></div>
10463: </div>
10464: </div>
10465: </div>
1.148 asau 10466: <div class="chapter">
1.75 rillig 10467: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10468: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10469: <div class="toc">
10470: <p><b>Table of Contents</b></p>
1.195 wiz 10471: <dl class="toc">
1.106 rillig 10472: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10473: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10474: </dl>
10475: </div>
10476: <p>The pkgsrc system has already been ported to many
10477: operating systems, hardware architectures and compilers. This
10478: chapter explains the necessary steps to make pkgsrc even more
10479: portable.</p>
1.148 asau 10480: <div class="sect1">
1.75 rillig 10481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10482: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10483: <p>To port pkgsrc to a new operating system (called
10484: <code class="literal">MyOS</code> in this example), you need to touch the
10485: following files:</p>
1.148 asau 10486: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10487: <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 10488: <dd><p>This file contains some basic definitions, for
10489: example the name of the C
10490: compiler.</p></dd>
1.76 rillig 10491: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10492: <dd><p>Insert code that defines the variables
10493: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10494: <code class="varname">LOWER_OS_VERSION</code>,
10495: <code class="varname">LOWER_VENDOR</code>,
10496: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10497: <code class="varname">APPEND_ELF</code>, and the other variables that
10498: appear in this file.</p></dd>
1.93 rillig 10499: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10500: <dd><p>This file contains the platform-specific
10501: definitions that are used by pkgsrc. Start by copying one of the
10502: other files and edit it to your
10503: needs.</p></dd>
1.93 rillig 10504: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10505: <dd><p>This file defines the paths to all the tools
10506: that are needed by one or the other package in pkgsrc, as well
10507: as by pkgsrc itself. Find out where these tools are on your
10508: platform and add them.</p></dd>
10509: </dl></div>
10510: <p>Now, you should be able to build some basic packages, like
1.189 snj 10511: <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 10512: </div>
1.148 asau 10513: <div class="sect1">
1.75 rillig 10514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10515: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10516: <p>TODO</p>
10517: </div>
10518: </div>
10519: </div>
1.148 asau 10520: <div class="appendix">
10521: <div class="titlepage"><div><div><h1 class="title">
10522: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10523: <div class="toc">
10524: <p><b>Table of Contents</b></p>
1.195 wiz 10525: <dl class="toc">
1.75 rillig 10526: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10527: <dd><dl>
10528: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10529: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10530: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10531: <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 10532: </dl></dd>
10533: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10534: </dl>
10535: </div>
10536: <p>We checked to find a piece of software that wasn't in the packages
10537: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10538: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10539: present in the tree is beyond us, but it's useful for the purposes of
10540: this exercise.</p>
1.148 asau 10541: <div class="sect1">
1.75 rillig 10542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10543: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10544: <div class="sect2">
1.75 rillig 10545: <div class="titlepage"><div><div><h3 class="title">
10546: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10547: <pre class="programlisting">
1.100 rillig 10548: # $NetBSD$
10549: #
1.1 grant 10550:
1.100 rillig 10551: DISTNAME= bison-1.25
10552: CATEGORIES= devel
10553: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10554:
1.136 dholland 10555: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10556: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10557: COMMENT= GNU yacc clone
1.1 grant 10558:
1.100 rillig 10559: GNU_CONFIGURE= yes
1.152 wiz 10560: INFO_FILES= yes
1.1 grant 10561:
1.100 rillig 10562: .include "../../mk/bsd.pkg.mk"
1.1 grant 10563: </pre>
1.75 rillig 10564: </div>
1.148 asau 10565: <div class="sect2">
1.75 rillig 10566: <div class="titlepage"><div><div><h3 class="title">
10567: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10568: <pre class="programlisting">
1.100 rillig 10569: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.189 snj 10570: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10571: of the NetBSD source tree is beyond me.
1.1 grant 10572: </pre>
1.75 rillig 10573: </div>
1.148 asau 10574: <div class="sect2">
1.75 rillig 10575: <div class="titlepage"><div><div><h3 class="title">
10576: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10577: <pre class="programlisting">
1.100 rillig 10578: @comment $NetBSD$
10579: bin/bison
10580: man/man1/bison.1.gz
10581: share/bison.simple
10582: share/bison.hairy
1.1 grant 10583: </pre>
1.75 rillig 10584: </div>
1.148 asau 10585: <div class="sect2">
1.75 rillig 10586: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10587: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10588: </h3></div></div></div>
1.75 rillig 10589: <p>The NetBSD package system comes with
1.189 snj 10590: <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 10591: which helps to check the contents of these
10592: files. After installation it is quite easy to use, just change to the
10593: directory of the package you wish to examine and execute
1.110 hubertf 10594: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10595: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10596: looks fine.</pre>
10597: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10598: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10599: -Wall</strong></span> for a very thorough check.</p>
10600: </div>
10601: </div>
1.148 asau 10602: <div class="sect1">
1.75 rillig 10603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10604: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10605: <p>Create the directory where the package lives,
10606: plus any auxiliary directories:</p>
10607: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10608: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10609: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10610: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10611: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10612: <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 10613: then continue with fetching the distfile:</p>
10614: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10615: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10616: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10617: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10618: ftp: Error retrieving file: 500 Internal error
10619:
10620: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10621: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10622: ftp: Error retrieving file: 500 Internal error
10623:
10624: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10625: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10626: Successfully retrieved file.</pre>
10627: <p>Generate the checksum of the distfile into
1.76 rillig 10628: <code class="filename">distinfo</code>:</p>
1.88 wiz 10629: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10630: <p>Now compile:</p>
10631: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10632: >> Checksum OK for bison-1.25.tar.gz.
10633: ===> Extracting for bison-1.25
10634: ===> Patching for bison-1.25
10635: ===> Ignoring empty patch directory
10636: ===> Configuring for bison-1.25
10637: creating cache ./config.cache
10638: checking for gcc... cc
10639: checking whether we are using GNU C... yes
10640: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10641: checking how to run the C preprocessor... cc -E
10642: checking for minix/config.h... no
10643: checking for POSIXized ISC... no
10644: checking whether cross-compiling... no
10645: checking for ANSI C header files... yes
10646: checking for string.h... yes
10647: checking for stdlib.h... yes
10648: checking for memory.h... yes
10649: checking for working const... yes
10650: checking for working alloca.h... no
10651: checking for alloca... yes
10652: checking for strerror... yes
10653: updating cache ./config.cache
10654: creating ./config.status
10655: creating Makefile
10656: ===> Building for bison-1.25
10657: 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
10658: 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
10659: 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
10660: 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
10661: 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 10662: 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 10663: 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
10664: 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
10665: 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
10666: 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
10667: 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
10668: 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
10669: 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
10670: 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
10671: 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
10672: 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
10673: 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
10674: 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
10675: 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
10676: 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
10677: 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
10678: 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
10679: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10680: rm -f bison.s1
1.75 rillig 10681: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10682: <p>Everything seems OK, so install the files:</p>
10683: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10684: >> Checksum OK for bison-1.25.tar.gz.
10685: ===> Installing for bison-1.25
10686: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10687: rm -f /usr/pkg/bin/bison
10688: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10689: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10690: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10691: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10692: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10693: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10694: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10695: ===> Registering installation for bison-1.25</pre>
10696: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10697: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10698: binary package, do this now:</p>
10699: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10700: >> Checksum OK for bison-1.25.tar.gz.
10701: ===> Building package for bison-1.25
10702: Creating package bison-1.25.tgz
10703: Registering depends:.
1.75 rillig 10704: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10705: <p>Now that you don't need the source and object files
10706: any more, clean up:</p>
10707: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10708: ===> Cleaning for bison-1.25</pre>
10709: </div>
10710: </div>
1.148 asau 10711: <div class="appendix">
10712: <div class="titlepage"><div><div><h1 class="title">
10713: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10714: <div class="toc">
10715: <p><b>Table of Contents</b></p>
1.195 wiz 10716: <dl class="toc">
1.75 rillig 10717: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10718: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10719: </dl>
10720: </div>
1.148 asau 10721: <div class="sect1">
1.75 rillig 10722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10723: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10724: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10725: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10726: => figlet221.tar.gz doesn't seem to exist on this system.
10727: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10728: => [172219 bytes]
10729: Connected to ftp.plig.net.
10730: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10731: 331 Guest login ok, send your complete e-mail address as password.
10732: 230-You are user #5 of 500 simultaneous users allowed.
10733: 230-
1.68 rillig 10734: 230- ___ _ _ _
10735: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10736: 230- | _| _| . |_| . | | | . |_| . | _| . |
10737: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10738: 230- |_| |_| |___| |___|
10739: 230-
10740: 230-** Welcome to ftp.plig.org **
10741: 230-
10742: 230-Please note that all transfers from this FTP site are logged. If you
10743: 230-do not like this, please disconnect now.
10744: 230-
1.120 snj 10745: 230-This archive is available via
1.1 grant 10746: 230-
10747: 230-HTTP: http://ftp.plig.org/
10748: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10749: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10750: 230-
10751: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10752: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10753: 230-
10754: 230-
10755: 230 Logged in anonymously.
10756: Remote system type is UNIX.
10757: Using binary mode to transfer files.
10758: 200 Type okay.
10759: 250 "/pub" is new cwd.
10760: 250-"/pub/figlet" is new cwd.
10761: 250-
10762: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10763: 250-
1.75 rillig 10764: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10765: 250-
10766: 250-The official FIGlet web page is:
1.75 rillig 10767: 250- http://www.figlet.org/
1.1 grant 10768: 250-
10769: 250-If you have questions, please mailto:info@figlet.org. If you want to
10770: 250-contribute a font or something else, you can email us.
1.68 rillig 10771: 250
1.1 grant 10772: 250 "/pub/figlet/program" is new cwd.
10773: 250 "/pub/figlet/program/unix" is new cwd.
10774: local: figlet221.tar.gz remote: figlet221.tar.gz
10775: 502 Unimplemented command.
10776: 227 Entering Passive Mode (195,40,6,41,246,104)
10777: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10778: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10779: 226 Transfer completed.
10780: 172219 bytes received in 00:02 (75.99 KB/s)
10781: 221 Goodbye.
10782: => Checksum OK for figlet221.tar.gz.
10783: ===> Extracting for figlet-2.2.1nb2
10784: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10785: ===> Patching for figlet-2.2.1nb2
10786: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10787: ===> Overriding tools for figlet-2.2.1nb2
10788: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10789: ===> Configuring for figlet-2.2.1nb2
10790: ===> Building for figlet-2.2.1nb2
10791: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10792: chmod a+x figlet
10793: gcc -O2 -o chkfont chkfont.c
10794: => Unwrapping files-to-be-installed.
1.14 xtraeme 10795: <code class="prompt">#</code>
1.75 rillig 10796: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10797: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10798: ===> Installing for figlet-2.2.1nb2
10799: install -d -o root -g wheel -m 755 /usr/pkg/bin
10800: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10801: mkdir -p /usr/pkg/share/figlet
10802: cp figlet /usr/pkg/bin
10803: cp chkfont /usr/pkg/bin
10804: chmod 555 figlist showfigfonts
10805: cp figlist /usr/pkg/bin
10806: cp showfigfonts /usr/pkg/bin
10807: cp fonts/*.flf /usr/pkg/share/figlet
10808: cp fonts/*.flc /usr/pkg/share/figlet
10809: cp figlet.6 /usr/pkg/man/man6
10810: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10811: <code class="prompt">#</code></pre>
10812: </div>
1.148 asau 10813: <div class="sect1">
1.75 rillig 10814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10815: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10816: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10817: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10818: ===> Packaging figlet-2.2.1nb2
10819: ===> Building binary package for figlet-2.2.1nb2
10820: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10821: Using SrcDir value of /usr/pkg
1.68 rillig 10822: Registering depends:.
1.75 rillig 10823: <code class="prompt">#</code></pre>
10824: </div>
10825: </div>
1.148 asau 10826: <div class="appendix">
10827: <div class="titlepage"><div><div><h1 class="title">
10828: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10829: <div class="toc">
10830: <p><b>Table of Contents</b></p>
1.195 wiz 10831: <dl class="toc">
1.128 wiz 10832: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10833: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10834: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10835: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10836: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10837: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10838: source packages</a></span></dt>
10839: </dl>
10840: </div>
10841: <p>As in other big projects, the directory layout of pkgsrc
10842: is quite complex for newbies. This chapter explains where you
10843: find things on the FTP server. The base directory on
1.110 hubertf 10844: <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 10845: On other servers it may be different, but inside this directory,
10846: everything should look the same, no matter on which server you
10847: are. This directory contains some subdirectories, which are
10848: explained below.</p>
1.148 asau 10849: <div class="sect1">
1.76 rillig 10850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10851: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10852: <p>The directory <code class="filename">distfiles</code> contains lots
10853: of archive files from all pkgsrc packages, which are mirrored
10854: here. The subdirectories are called after their package names
10855: and are used when the distributed files have names that don't
10856: explicitly contain a version number or are otherwise too generic
10857: (for example <code class="filename">release.tar.gz</code>).</p>
10858: </div>
1.148 asau 10859: <div class="sect1">
1.76 rillig 10860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10861: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10862: <p>This directory contains things that individual pkgsrc
10863: developers find worth publishing.</p>
10864: </div>
1.148 asau 10865: <div class="sect1">
1.76 rillig 10866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10867: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10868: <p>This directory contains binary packages for the various
10869: platforms that are supported by pkgsrc.
10870: 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.148 asau 10871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10872: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10873: operating system for which the packages have been built. The
1.110 hubertf 10874: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10875: command, so it may differ from the one you are used to
10876: hear.</p></li>
1.128 wiz 10877: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10878: architecture of the platform for which the packages have been
1.110 hubertf 10879: built. It also includes the <code class="varname">ABI</code> (Application
10880: Binary Interface) for platforms that have several of
10881: them.</p></li>
1.128 wiz 10882: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10883: the operating system. For version numbers that change often (for
10884: example NetBSD-current), the often-changing part should be
10885: replaced with an <code class="literal">x</code>, for example
10886: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10887: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10888: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10889: for a stable branch, or <code class="literal">head</code> for packages
10890: built from the HEAD branch. The latter should only be used when
10891: the packages are updated on a regular basis. Otherwise the date
10892: from checking out pkgsrc should be appended, for example
10893: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10894: </ul></div>
10895: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10896: can quickly click through the directories on the
10897: server and find the best binary packages for their machines. Since they
10898: usually know the operating system and the hardware architecture, OPSYS
10899: and ARCH are placed first. After these choices, they can select the
10900: best combination of OSVERSION and TAG together, since it is usually the
10901: case that packages stay compatible between different version of the
10902: operating system.</p>
10903: <p>In each of these directories, there is a
10904: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10905: <code class="filename">All</code> which contains all binary packages.
10906: Besides that, there are various category directories that
10907: contain symbolic links to the real binary packages.</p>
10908: </div>
1.148 asau 10909: <div class="sect1">
1.76 rillig 10910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10911: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10912: <p>Here are the reports from bulk builds, for those who want
10913: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10914: 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 10915: </div>
1.148 asau 10916: <div class="sect1">
1.108 rillig 10917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10918: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10919: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10920: source packages</h2></div></div></div>
1.128 wiz 10921: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10922: that is the files that define how to create binary packages from
10923: source archives.</p>
10924: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10925: snapshot of the CVS repository, which is updated regularly. The
10926: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10927: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10928: <p>In the directories for the quarterly branches, there is an
10929: additional file called
1.126 jakllsch 10930: <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 10931: which contains the state of pkgsrc when it was branched.</p>
10932: </div>
1.75 rillig 10933: </div>
1.148 asau 10934: <div class="appendix">
10935: <div class="titlepage"><div><div><h1 class="title">
10936: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 10937: <div class="toc">
10938: <p><b>Table of Contents</b></p>
1.195 wiz 10939: <dl class="toc">
1.79 rillig 10940: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10941: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10942: </dl>
10943: </div>
1.79 rillig 10944: <p>This section contains information on editing the pkgsrc
10945: guide itself.</p>
1.148 asau 10946: <div class="sect1">
1.75 rillig 10947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10948: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10949: <p>The pkgsrc guide's source code is stored in
10950: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10951: are created from it:</p>
1.148 asau 10952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10953: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10954: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10955: <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>
10956: <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 10957: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 10958: <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 10959: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10960: </ul></div>
10961: </div>
1.148 asau 10962: <div class="sect1">
1.75 rillig 10963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10964: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10965: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 10966: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 10967: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 10968: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 10969: documentation) installed. These are automatically installed when
1.189 snj 10970: you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148 asau 10971: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 10972: right directory. All further steps will take place
10973: here.</p></li>
1.148 asau 10974: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 10975: <code class="filename">files/</code>.</p></li>
1.148 asau 10976: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 10977: guide for valid XML and to build the final output files. If you
10978: get any errors at this stage, you can just edit the files, as
10979: there are only symbolic links in the working directory, pointing
10980: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 10981: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 10982: commit)</strong></span></p></li>
1.148 asau 10983: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 10984: regenerate the output files with the proper RCS
10985: Ids.</p></li>
1.148 asau 10986: <li class="step">
1.110 hubertf 10987: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 10988: commit the files in both <code class="filename">pkgsrc/doc</code> and
10989: <code class="filename">htdocs</code>.</p>
1.148 asau 10990: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 10991: <h3 class="title">Note</h3>
10992: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 10993: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10994: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 10995: directory.</p>
10996: </div>
10997: </li>
1.79 rillig 10998: </ol></div>
1.75 rillig 10999: </div>
11000: </div>
11001: </div></body>
1.1 grant 11002: </html>
CVSweb <webmaster@jp.NetBSD.org>