Annotation of pkgsrc/doc/pkgsrc.html, revision 1.196
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>
228: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
229: </dl></dd>
230: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 233: <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 234: <dd><dl>
235: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 236: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
237: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
238: and
239: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
240: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 241: </dl></dd>
1.128 wiz 242: <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 243: <dd><dl>
1.128 wiz 244: <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 245: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
246: </dl></dd>
247: </dl></dd>
248: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
249: <dd><dl>
250: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
251: <dd><dl>
252: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
253: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
254: </dl></dd>
255: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
256: <dd><dl>
1.128 wiz 257: <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 258: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
259: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
260: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
261: </dl></dd>
262: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
263: <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>
264: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
265: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
266: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
267: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
268: <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>
269: </dl></dd>
270: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
271: <dd><dl>
272: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 273: <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 274: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 275: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 276: </dl></dd>
277: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
278: <dd><dl>
279: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
280: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
281: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
282: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 283: <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 284: <dd><dl>
285: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
286: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
287: </dl></dd>
1.128 wiz 288: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
289: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
297: <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 298: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
299: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
300: </dl></dd>
301: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
302: <dd><dl>
303: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
304: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
305: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
306: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
307: </dl></dd>
308: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
309: <dd><dl>
310: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
311: <dd><dl>
312: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 313: <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 314: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
315: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
316: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
317: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
318: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
319: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
320: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
321: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
322: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
323: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
324: </dl></dd>
1.128 wiz 325: <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 326: <dd><dl>
327: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
328: <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>
329: </dl></dd>
1.128 wiz 330: <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 331: <dd><dl>
332: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
333: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
335: </dl></dd>
336: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
337: <dd><dl>
338: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
339: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
340: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 341: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
342: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 343: </dl></dd>
1.128 wiz 344: <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 345: <dd><dl>
346: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
347: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 348: <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 349: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
350: </dl></dd>
1.128 wiz 351: <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 352: <dd><dl>
353: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
354: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
355: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
356: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
357: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
358: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
359: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
360: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 361: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 362: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 363: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
364: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
365: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
366: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
367: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
368: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
369: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
370: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 371: emulation</a></span></dt>
1.106 rillig 372: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
373: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 374: </dl></dd>
1.106 rillig 375: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 376: </dl></dd>
1.106 rillig 377: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
378: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 379: <dd><dl>
1.106 rillig 380: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
381: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
382: <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 383: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 384: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 385: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
386: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 387: </dl></dd>
388: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
389: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
390: <dd><dl>
391: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
392: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
393: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
394: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 395: </dl></dd>
1.75 rillig 396: </dl></dd>
397: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
398: <dd><dl>
1.106 rillig 399: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 400: <dd><dl>
1.106 rillig 401: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
402: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
403: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 404: <dd><dl>
1.106 rillig 405: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
406: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 407: </dl></dd>
1.106 rillig 408: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
409: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 410: <dd><dl>
1.106 rillig 411: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
412: <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 413: </dl></dd>
1.106 rillig 414: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 415: <dd><dl>
1.128 wiz 416: <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>
417: <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 418: </dl></dd>
419: </dl></dd>
1.106 rillig 420: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 421: <dd><dl>
1.106 rillig 422: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
423: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
424: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 425: <dd><dl>
1.106 rillig 426: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
427: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 428: </dl></dd>
429: </dl></dd>
1.106 rillig 430: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 431: <dd><dl>
1.106 rillig 432: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
433: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 434: </dl></dd>
435: </dl></dd>
436: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
437: <dd><dl>
438: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
439: <dd><dl>
440: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
441: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
442: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 443: <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 444: </dl></dd>
445: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
446: </dl></dd>
447: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
448: <dd><dl>
449: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
450: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
451: </dl></dd>
1.76 rillig 452: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
453: <dd><dl>
1.128 wiz 454: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
455: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
456: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
457: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
458: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
459: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 460: source packages</a></span></dt>
461: </dl></dd>
1.75 rillig 462: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
463: <dd><dl>
1.79 rillig 464: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 465: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
466: </dl></dd>
467: </dl>
468: </div>
1.82 rillig 469: <div class="list-of-tables">
470: <p><b>List of Tables</b></p>
471: <dl>
472: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
473: </dt>
1.106 rillig 474: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 475: </dt>
1.106 rillig 476: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 477: </dt>
1.82 rillig 478: </dl>
479: </div>
1.148 asau 480: <div class="chapter">
481: <div class="titlepage"><div><div><h1 class="title">
482: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 483: <div class="toc">
484: <p><b>Table of Contents</b></p>
1.195 wiz 485: <dl class="toc">
1.75 rillig 486: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 487: <dd><dl>
488: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
489: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
490: </dl></dd>
1.75 rillig 491: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
492: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 493: <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 494: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
495: </dl>
496: </div>
1.148 asau 497: <div class="sect1">
1.75 rillig 498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
499: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 500: <p>There is a lot of software freely available for Unix-based
501: systems, which is usually available in form of the source code. Before
502: such software can be used, it needs to be configured to the local
503: system, compiled and installed, and this is exactly what The NetBSD
504: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
505: to handle binary packages, so that not every user has to build the
506: packages for himself, which is a time-costly task.</p>
1.75 rillig 507: <p>pkgsrc currently contains several thousand packages,
508: including:</p>
1.148 asau 509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 510: <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 511: web server</p></li>
1.189 snj 512: <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 513: web browser</p></li>
1.189 snj 514: <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 515: Desktop Environment</p></li>
1.189 snj 516: <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 517: Desktop Environment</p></li>
518: </ul></div>
519: <p>...just to name a few.</p>
520: <p>pkgsrc has built-in support for handling varying dependencies,
521: such as pthreads and X11, and extended features such as IPv6 support on
522: a range of platforms.</p>
1.148 asau 523: <div class="sect2">
1.82 rillig 524: <div class="titlepage"><div><div><h3 class="title">
525: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
526: <p>
527: pkgsrc provides the following key features:
528: </p>
1.148 asau 529: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 530: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 531: and installation of binary packages. The source and latest
532: patches are retrieved from a master or mirror download site, checksum
533: verified, then built on your system. Support for binary-only
534: distributions is available for both native platforms and NetBSD
535: emulated platforms.</p></li>
1.128 wiz 536: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 537: including binaries, libraries, man pages and other
538: documentation.</p></li>
1.128 wiz 539: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 540: are handled automatically. The configuration files of various
541: packages are handled automatically during updates, so local changes
542: are preserved.</p></li>
1.128 wiz 543: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 544: consists of highly portable code. This allows the greatest speed of
1.132 spz 545: development when porting to a new platform. This portability also
1.82 rillig 546: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
547: platforms</em></span>.</p></li>
1.128 wiz 548: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 549: international encryption requirements and build-time options for a
550: large number of packages are all set in a simple, central
551: configuration file.</p></li>
1.128 wiz 552: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 553: freely available under a BSD license, so you may extend and adapt
554: pkgsrc to your needs. Support for local packages and patches is
555: available right out of the box, so you can configure it specifically
556: for your environment.</p></li>
557: </ul></div>
1.91 rillig 558: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 560: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 561: — That means, if a package contains bugs, it's better to find
1.91 rillig 562: them and to complain about them rather than to just install the package
563: and hope that it works. There are numerous checks in pkgsrc that try to
1.189 snj 564: 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 565: of shell scripts), and post-installation checks (installed files,
566: references to shared libraries, script interpreters).</p></li>
1.128 wiz 567: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 568: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 569: pkgsrc has been ported to many operating systems. Care is taken that
570: packages behave the same on all platforms.</p></li>
571: </ul></div>
1.82 rillig 572: </div>
1.148 asau 573: <div class="sect2">
1.82 rillig 574: <div class="titlepage"><div><div><h3 class="title">
575: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
576: <p>pkgsrc consists of both a source distribution and a binary
577: distribution for these operating systems. After retrieving the required
578: source or binaries, you can be up and running with pkgsrc in just
579: minutes!</p>
1.75 rillig 580: <p>pkgsrc was derived from FreeBSD's ports system, and
581: initially developed for NetBSD only. Since then, pkgsrc has
582: grown a lot, and now supports the following platforms:</p>
1.82 rillig 583: <div class="table">
584: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 585: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 586: <colgroup>
587: <col>
588: <col>
589: </colgroup>
590: <thead><tr>
591: <th>Platform</th>
592: <th>Date Support Added</th>
593: </tr></thead>
594: <tbody>
595: <tr>
1.110 hubertf 596: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 597: <td align="center">Aug 1997</td>
598: </tr>
599: <tr>
1.110 hubertf 600: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 601: <td align="center">Mar 1999</td>
602: </tr>
603: <tr>
1.110 hubertf 604: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 605: <td align="center">Jun 1999</td>
606: </tr>
607: <tr>
608: <td>
1.110 hubertf 609: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
610: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 611: </td>
612: <td align="center">Oct 2001</td>
613: </tr>
614: <tr>
1.110 hubertf 615: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 616: <td align="center">Nov 2002</td>
617: </tr>
618: <tr>
1.110 hubertf 619: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 620: <td align="center">Nov 2002</td>
621: </tr>
622: <tr>
1.110 hubertf 623: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 624: <td align="center">Dec 2002</td>
625: </tr>
626: <tr>
627: <td>BSD/OS</td>
628: <td align="center">Dec 2003</td>
629: </tr>
630: <tr>
1.110 hubertf 631: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 632: <td align="center">Dec 2003</td>
633: </tr>
634: <tr>
635: <td>
1.110 hubertf 636: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 637: (Microsoft Windows Services for Unix)
638: </td>
639: <td align="center">Mar 2004</td>
640: </tr>
641: <tr>
1.110 hubertf 642: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 643: <td align="center">Oct 2004</td>
644: </tr>
645: <tr>
1.110 hubertf 646: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 647: <td align="center">Nov 2004</td>
648: </tr>
1.98 wiz 649: <tr>
1.110 hubertf 650: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 651: <td align="center">Apr 2007</td>
652: </tr>
1.128 wiz 653: <tr>
654: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
655: <td align="center">Sep 2010</td>
656: </tr>
1.151 obache 657: <tr>
658: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 659: <td align="center">Jan 2011</td>
1.151 obache 660: </tr>
661: <tr>
662: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
663: <td align="center">Nov 2011</td>
664: </tr>
665: <tr>
666: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
667: <td align="center">Mar 2013</td>
668: </tr>
1.166 jnemeth 669: <tr>
670: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
671: <td align="center">Jul 2013</td>
672: </tr>
1.82 rillig 673: </tbody>
1.91 rillig 674: </table></div>
1.82 rillig 675: </div>
1.91 rillig 676: <br class="table-break">
1.82 rillig 677: </div>
1.75 rillig 678: </div>
1.148 asau 679: <div class="sect1">
1.75 rillig 680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
681: <a name="overview"></a>1.2. Overview</h2></div></div></div>
682: <p>This document is divided into three parts. The first,
1.110 hubertf 683: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 684: describes how one can use one of the packages in the Package
685: Collection, either by installing a precompiled binary package,
1.93 rillig 686: or by building one's own copy using the NetBSD package system.
1.110 hubertf 687: 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 688: package so it can be easily built by other NetBSD users without
689: knowing about the package's building details. The third part,
1.110 hubertf 690: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 691: is intended for those who want to understand how pkgsrc is
692: implemented.</p>
693: <p>This document is available in various formats:
1.110 hubertf 694: <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 695: </div>
1.148 asau 696: <div class="sect1">
1.75 rillig 697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
698: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 699: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
700: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 701: terminology used within this document.</p>
1.148 asau 702: <div class="variablelist"><dl class="variablelist">
1.75 rillig 703: <dt><span class="term">Package</span></dt>
704: <dd><p>A set of files and building instructions
705: that describe what's necessary
706: to build a certain piece of software using
707: pkgsrc. Packages are traditionally stored under
1.76 rillig 708: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 709: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 710: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 711: is part of the NetBSD operating system and can be bootstrapped
712: to run on non-NetBSD operating systems as well. It handles
713: building (compiling), installing, and removing of
714: packages.</p></dd>
1.75 rillig 715: <dt><span class="term">Distfile</span></dt>
716: <dd><p>This term describes the file or files that are
717: provided by the author of the piece of software to
718: distribute his work. All the changes necessary to build on
719: NetBSD are reflected in the corresponding package. Usually
720: the distfile is in the form of a compressed tar-archive,
721: but other types are possible, too. Distfiles are usually
722: stored below
1.76 rillig 723: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 724: <dt><span class="term">Port</span></dt>
725: <dd><p>This is the term used by FreeBSD and OpenBSD people
726: for what we call a package.
1.128 wiz 727: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 728: architecture.</p></dd>
729: <dt><span class="term">Precompiled/binary package</span></dt>
730: <dd>
731: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 732: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 733: file so it can be installed on machines of the same
734: machine architecture without the need to
735: recompile. Packages are usually generated in
1.76 rillig 736: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 737: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 738: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 739: especially in the context of precompiled packages.</p>
740: </dd>
741: <dt><span class="term">Program</span></dt>
1.88 wiz 742: <dd><p>The piece of software to be installed which will be
743: constructed from all the files in the distfile by the
744: actions defined in the corresponding package.</p></dd>
1.75 rillig 745: </dl></div>
1.148 asau 746: <div class="sect2">
1.75 rillig 747: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 748: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 749: <div class="variablelist"><dl class="variablelist">
1.75 rillig 750: <dt><span class="term">pkgsrc users</span></dt>
751: <dd>
752: <p>The
753: pkgsrc users are people who use the packages provided by pkgsrc.
754: Typically they are system administrators. The people using the
1.128 wiz 755: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
756: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 757: <p>There are two kinds of pkgsrc users: Some only want to
758: install pre-built binary packages. Others build the pkgsrc
759: packages from source, either for installing them directly or for
1.110 hubertf 760: 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 761: documentation.</p>
762: </dd>
763: <dt><span class="term">package maintainers</span></dt>
764: <dd><p>A
1.110 hubertf 765: 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 766: <dt><span class="term">infrastructure developers</span></dt>
767: <dd><p>These people are involved in all those files
1.76 rillig 768: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 769: 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 770: too.</p></dd>
771: </dl></div>
772: </div>
773: </div>
1.148 asau 774: <div class="sect1">
1.75 rillig 775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
776: <a name="typography"></a>1.4. Typography</h2></div></div></div>
777: <p>When giving examples for commands, shell prompts are used to
778: show if the command should/can be issued as root, or if
1.128 wiz 779: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 780: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
781: shell prompt, assuming they use the C-shell or tcsh.</p>
782: </div>
783: </div>
1.148 asau 784: <div class="part">
1.75 rillig 785: <div class="titlepage"><div><div><h1 class="title">
786: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
787: <div class="toc">
788: <p><b>Table of Contents</b></p>
1.195 wiz 789: <dl class="toc">
1.75 rillig 790: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
791: <dd><dl>
792: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
793: <dd><dl>
1.157 asau 794: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 795: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 796: </dl></dd>
797: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
798: <dd><dl>
799: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
800: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
801: </dl></dd>
802: </dl></dd>
803: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
804: <dd><dl>
1.82 rillig 805: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
806: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
807: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
808: <dd><dl>
1.151 obache 809: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
810: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
811: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 812: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
813: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
814: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
815: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
816: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
817: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
818: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 819: </dl></dd>
820: </dl></dd>
821: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
822: <dd><dl>
823: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
824: <dd><dl>
825: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
826: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 827: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
828: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
829: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
830: <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>
831: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
832: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 833: </dl></dd>
834: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
835: <dd><dl>
836: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
837: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
838: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
839: </dl></dd>
840: </dl></dd>
841: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
842: <dd><dl>
843: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
844: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 845: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 846: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 847: <dd><dl>
1.103 wiz 848: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 849: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
850: <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 851: </dl></dd>
1.103 wiz 852: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
853: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 854: </dl></dd>
855: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
856: <dd><dl>
857: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
858: <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 859: </dl></dd>
860: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
861: builds)</a></span></dt>
1.75 rillig 862: <dd><dl>
1.180 wiz 863: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
864: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
865: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
866: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 867: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
868: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 869: </dl></dd>
870: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
871: <dd><dl>
1.128 wiz 872: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
873: <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 874: </dl></dd>
875: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
876: <dd><dl>
877: <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 878: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
879: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
880: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
881: <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>
882: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
883: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
884: <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>
885: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
886: <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 887: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 888: <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>
889: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
890: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
891: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
892: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
893: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
894: <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 895: </dl></dd>
896: </dl>
897: </div>
1.148 asau 898: <div class="chapter">
1.75 rillig 899: <div class="titlepage"><div><div><h2 class="title">
900: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
901: <div class="toc">
902: <p><b>Table of Contents</b></p>
1.195 wiz 903: <dl class="toc">
1.75 rillig 904: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
905: <dd><dl>
1.157 asau 906: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 907: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 908: </dl></dd>
909: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
910: <dd><dl>
911: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
912: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
913: </dl></dd>
914: </dl>
915: </div>
1.91 rillig 916: <p>Before you download and extract the files, you need to decide
917: where you want to extract them. When using pkgsrc as root user, pkgsrc
918: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
919: free to install the sources and binary packages wherever you want in
920: your filesystem, provided that the pathname does not contain white-space
921: or other characters that are interpreted specially by the shell and some
922: other programs. A safe bet is to use only letters, digits, underscores
923: and dashes.</p>
1.148 asau 924: <div class="sect1">
1.75 rillig 925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
926: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
927: <p>Before you download any pkgsrc files, you should decide
928: whether you want the <span class="emphasis"><em>current</em></span> branch or the
929: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
930: quarterly basis from the current branch and only gets modified
931: for security updates. The names of the stable branches are built
932: from the year and the quarter, for example
1.188 snj 933: <code class="literal">2014Q3</code>.</p>
1.75 rillig 934: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 935: want to download pkgsrc. You can get it as a tar file or via CVS.
936: Both ways are described here.</p>
1.157 asau 937: <p>Note that tar archive contains CVS working copy.
938: Thus you can switch to using CVS at any later time.</p>
1.148 asau 939: <div class="sect2">
1.75 rillig 940: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 941: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 942: <p>The primary download location for all pkgsrc files is
1.157 asau 943: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
944: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
945: (it points to the same location).
946: There are a number of subdirectories for different purposes,
947: 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>
948: <p>The tar archive for the current branch is in the directory
949: <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 950: It is autogenerated daily.</p>
1.157 asau 951: <p>To save download time we provide bzip2- and
952: xz-compressed archives which are published at
953: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
954: and
955: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
956: respectively.
957: </p>
958: <p>You can fetch the same files using FTP.</p>
1.188 snj 959: <p>The tar file for the stable branch 2014Q3 is in the
960: 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 961: <p>To download a pkgsrc stable tarball, run:</p>
962: <pre class="screen">
1.166 jnemeth 963: <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 964: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 965: stable branch to be downloaded, for example,
1.188 snj 966: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
967: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 968: or your web browser.</p>
1.112 weinem 969: <p>Then, extract it with:</p>
1.188 snj 970: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 971: <p>This will create the directory <code class="filename">pkgsrc/</code>
972: in <code class="filename">/usr/</code> and all the package source will be
973: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
974: <p>To download pkgsrc-current, run:</p>
975: <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 976: </div>
1.148 asau 977: <div class="sect2">
1.75 rillig 978: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 979: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
980: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 981: <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 982: </pre>
983: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.188 snj 984: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.128 wiz 985: <p>This will create the directory <code class="filename">pkgsrc/</code>
986: in your <code class="filename">/usr/</code> directory and all the package source
987: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
988: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 989: <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 990: </pre>
1.188 snj 991: <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 992: <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 993: <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 994: </pre>
995: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
996: For Bourne shells, you can set it in your <code class="filename">.profile</code>
997: or better globally in <code class="filename">/etc/profile</code>:</p>
998: <pre class="programlisting">
999: # set CVS remote shell command
1000: CVS_RSH=ssh
1001: export CVS_RSH
1002: </pre>
1003: <p>By default, CVS doesn't do things like most people would expect it to do.
1004: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1005: in your home directory and saving the following lines to it.
1006: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1007: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1008: <pre class="programlisting">
1009: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1010: cvs -q -z2
1.101 rillig 1011: checkout -P
1.103 wiz 1012: update -dP
1013: diff -upN
1.101 rillig 1014: rdiff -u
1.128 wiz 1015: release -d
1.101 rillig 1016: </pre>
1.75 rillig 1017: </div>
1018: </div>
1.148 asau 1019: <div class="sect1">
1.75 rillig 1020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1021: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1022: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1023: (which also works if you have first installed it via a tar
1024: file). It saves bandwidth and hard disk activity, compared to
1025: downloading the tar file again.</p>
1.148 asau 1026: <div class="sect2">
1.75 rillig 1027: <div class="titlepage"><div><div><h3 class="title">
1028: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1029: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1030: <h3 class="title">Warning</h3>
1.77 rillig 1031: <p>When updating from a tar file, you first need to
1032: completely remove the old pkgsrc directory. Otherwise those
1033: files that have been removed from pkgsrc in the mean time will
1034: not be removed on your local disk, resulting in inconsistencies.
1035: When removing the old files, any changes that you have done to
1036: the pkgsrc files will be lost after updating. Therefore updating
1037: via CVS is strongly recommended.</p>
1.75 rillig 1038: </div>
1.82 rillig 1039: <p>Note that by default the distfiles and the binary packages
1040: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1041: before updating. You can also configure pkgsrc to store distfiles
1042: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1043: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1044: 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 1045: <p>To update pkgsrc from a tar file, download the tar file as
1046: explained above. Then, make sure that you have not made any
1047: changes to the files in the pkgsrc directory. Remove the pkgsrc
1048: directory and extract the new tar file. Done.</p>
1049: </div>
1.148 asau 1050: <div class="sect2">
1.75 rillig 1051: <div class="titlepage"><div><div><h3 class="title">
1052: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1053: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1054: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1055: </pre>
1056: <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>
1057: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1058: </pre>
1.148 asau 1059: <div class="sect3">
1.75 rillig 1060: <div class="titlepage"><div><div><h4 class="title">
1061: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1062: <p>When updating pkgsrc, the CVS program keeps track of the
1063: branch you selected. But if you, for whatever reason, want to
1064: switch from the stable branch to the current one, you can do it
1.128 wiz 1065: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1066: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1067: back to the stable branch, add the
1.188 snj 1068: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.75 rillig 1069: </div>
1.148 asau 1070: <div class="sect3">
1.75 rillig 1071: <div class="titlepage"><div><div><h4 class="title">
1072: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1073: <p>When you update pkgsrc, the CVS program will only touch
1074: those files that are registered in the CVS repository. That
1075: means that any packages that you created on your own will stay
1076: unmodified. If you change files that are managed by CVS, later
1077: updates will try to merge your changes with those that have been
1078: done by others. See the CVS manual, chapter
1.128 wiz 1079: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1080: </div>
1081: </div>
1082: </div>
1083: </div>
1.148 asau 1084: <div class="chapter">
1.75 rillig 1085: <div class="titlepage"><div><div><h2 class="title">
1086: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1087: <div class="toc">
1088: <p><b>Table of Contents</b></p>
1.195 wiz 1089: <dl class="toc">
1.82 rillig 1090: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1091: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1092: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1093: <dd><dl>
1.151 obache 1094: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1095: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1096: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 1097: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1098: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1099: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1100: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1101: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1102: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1103: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 1104: </dl></dd>
1105: </dl>
1106: </div>
1.148 asau 1107: <div class="sect1">
1.75 rillig 1108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1109: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1110: <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 1111: </div>
1.148 asau 1112: <div class="sect1">
1.82 rillig 1113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1114: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1115: <p>pkgsrc can be bootstrapped for use in two different modes:
1116: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1117: to privileged one all programs are installed under one particular user
1.149 asau 1118: and cannot utilise privileged operations (packages don't create
1119: special users and all special file permissions like setuid are ignored).
1120: </p>
1.82 rillig 1121: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1122: <pre class="screen">
1.167 asau 1123: <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 1124: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1125: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1126: </pre>
1.149 asau 1127: <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>
1128: <p>By default, in privileged mode pkgsrc uses
1129: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1130: where programs will be installed in,
1.87 wiz 1131: and <code class="filename">/var/db/pkg</code> for the package database
1.149 asau 1132: directory where pkgsrc will do its internal bookkeeping,
1133: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1134: where packages install their persistent data.
1135: In unprivileged mode pkgsrc uses
1136: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1137: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1138: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1139: </p>
1140: <p>You can change default layout using command-line arguments.
1141: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1142: </p>
1.148 asau 1143: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1144: <h3 class="title">Note</h3>
1.110 hubertf 1145: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1146: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1147: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1148: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1149: </div>
1.149 asau 1150: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1151: <h3 class="title">Note</h3>
1152: <p>It is possible to bootstrap multiple instances of pkgsrc
1153: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1154: corresponding to the installation you're working with to build
1155: and install packages.
1156: </p>
1157: </div>
1.75 rillig 1158: </div>
1.148 asau 1159: <div class="sect1">
1.75 rillig 1160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1161: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1162: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 asau 1163: <div class="sect2">
1.75 rillig 1164: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1165: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1166: <p>Cygwin 1.7.x and later are supported.</p>
1167: <p>You need to install minimal base packages in `Base' category
1168: plus any of compiler, gcc, gcc4, and/or clang.
1169: For gcc and gcc4, C and C++ compiler will be installed by default,
1170: but you can install Fortran compiler additionally
1171: because it will be required to use libtool.
1172: If it is not installed (or too old), Fortran compiler will be
1173: installed with pkgsrc automatically.</p>
1174: <p>As noted in
1175: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1176: su(1) command has been in Cygwin distribution, but it has never worked.
1177: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1178: </p>
1179: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1180: then pick "Run as administrator".</p></li></ul></div>
1181: </div>
1182: <div class="sect2">
1183: <div class="titlepage"><div><div><h3 class="title">
1184: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.148 asau 1185: <p>Darwin 5.x and up are supported.</p>
1186: <p>Before you start, you need to download and install
1187: the Mac OS X Developer Tools from Apple's Developer Connection.
1188: This requires (free) membership. See
1.126 jakllsch 1189: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 asau 1190: for details. Also, make sure you install X11 (an optional
1191: package included with the Developer Tools) if you intend
1192: to build packages that use the X11 Window System.
1193: (If you don't want or need the full Xcode GUI,
1194: download and install Command Line Tools for Xcode.)</p>
1.75 rillig 1195: </div>
1.148 asau 1196: <div class="sect2">
1.75 rillig 1197: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1198: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136 dholland 1199: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1200: other versions may work.</p>
1.75 rillig 1201: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1202: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1203: <div class="orderedlist"><ol class="orderedlist" type="1">
1204: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1205: <code class="filename">/var/db/pkg</code>. It is therefore
1206: recommended that you choose a different location (e.g.
1207: <code class="filename">/usr/pkgdb</code>) by
1208: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1209: <li class="listitem">
1.75 rillig 1210: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1211: good idea to move them out of the way to avoid confusion, e.g.</p>
1212: <pre class="screen">
1213: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1214: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1215: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1216: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1217: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1218: </pre>
1.75 rillig 1219: </li>
1.128 wiz 1220: <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 1221: <code class="filename">/etc/mk.conf.example</code> file
1222: when you use the bootstrap script.</p></li>
1.75 rillig 1223: </ol></div>
1224: </div>
1.148 asau 1225: <div class="sect2">
1.75 rillig 1226: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1227: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1228: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1229: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1230: <p> You should install ncurses (libncurses and libncurses-dev)
1231: packages.</p>
1232: </div>
1233: <div class="sect2">
1234: <div class="titlepage"><div><div><h3 class="title">
1235: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75 rillig 1236: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1237: providing a Unix-like environment with a tighter kernel integration than
1238: available with Cygwin. It is part of the Windows Services for Unix
1239: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1240: (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 1241: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1242: are not officially supported. (The main difference in 3.0/3.1 is lack
1243: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 wiz 1244: <p>Services for Unix Applications (aka SUA) is an integrated
1245: component of Windows Server 2003 R2 (5.2), Windows Vista and
1246: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1247: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1248: 6.1 (64bit) subsystems have been tested. Other versions may
1249: work as well. The Interix 5.x subsystem has not yet been tested
1250: with pkgsrc.</p>
1.148 asau 1251: <div class="sect3">
1.75 rillig 1252: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1253: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1254: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1255: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 asau 1256: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1257: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1258: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1259: <li class="listitem"><p>Remote Connectivity</p></li>
1260: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1261: </ul></div>
1262: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1263: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1264: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1265: pkgsrc (or from a binary package).</p>
1.75 rillig 1266: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1267: not need to be installed, but Remote Connectivity itself should be
1268: installed in order to have a working inetd.</p>
1.75 rillig 1269: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1270: behavior for Interix programs, and whether to make pathnames default to
1271: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1272: enabled. (Without case-sensitivity, a large number of packages including
1273: perl will not build.)</p>
1.75 rillig 1274: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1275: works (via the Data Execution Prevention feature). In order to use
1276: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1277: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1278: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1279: support contract; however, Debian Interix Port has made most Interix
1280: 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 1281: <p>In addition to the hotfix noted above, it may be necessary to
1282: disable Data Execution Prevention entirely to make Interix functional.
1283: This may happen only with certain types of CPUs; the cause is not fully
1284: understood at this time. If gcc or other applications still segfault
1285: repeatedly after installing one of the hotfixes note above, the
1286: following option can be added to the appropriate "boot.ini" line on the
1287: Windows boot drive: /NoExecute=AlwaysOff
1288: (WARNING, this will disable DEP completely, which may be a security
1289: risk if applications are often run as a user in the Administrators
1290: group!)</p>
1.75 rillig 1291: </div>
1.148 asau 1292: <div class="sect3">
1.75 rillig 1293: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1294: <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 1295: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1296: with pkgsrc, note the following things.</p>
1.148 asau 1297: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1298: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1299: Windows Services for UNIX, then click Change. In the installer, choose
1300: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1301: <li class="listitem">
1.75 rillig 1302: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1303: change the following registry key:</p>
1.75 rillig 1304: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1305: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1306: </li>
1.128 wiz 1307: <li class="listitem">
1.75 rillig 1308: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1309: following registry key:</p>
1.75 rillig 1310: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1311: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1312: </li>
1313: </ul></div>
1314: </div>
1.148 asau 1315: <div class="sect3">
1.75 rillig 1316: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1317: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1318: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1319: running "pkg_add") must be a member of the local Administrators
1320: group. Such a user must also be used to run the bootstrap. This is
1321: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1322: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1323: automatically complain if this is not the case. This ensures that
1324: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1325: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1326: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1327: NOT be used in conjunction with pkgsrc. If you choose to use them at
1328: the same time as the pkgsrc packages, ensure that you use the proper
1329: pkg_* tools for each type of binary package.</p>
1.75 rillig 1330: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1331: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1332: don't have a termcap/terminfo entry for it, but the following .termcap
1333: entry provides adequate emulation in most cases:</p>
1.75 rillig 1334: <pre class="programlisting">
1.100 rillig 1335: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1336: </pre>
1.75 rillig 1337: </div>
1.148 asau 1338: <div class="sect3">
1.75 rillig 1339: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1340: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1341: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1342: for a full Unix-like platform, it has some drawbacks that should
1343: be noted for those desiring to make the most of Interix.</p>
1.148 asau 1344: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1345: <li class="listitem">
1.75 rillig 1346: <p><span class="strong"><strong>X11:</strong></span></p>
1347: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1348: and can run X11 based applications, but it does
1349: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1350: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1351: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1352: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1353: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1354: and the free X11 server included with
1.110 hubertf 1355: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1356: </li>
1.128 wiz 1357: <li class="listitem">
1.75 rillig 1358: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1359: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1360: Win32 applications, it does not currently support various X11
1361: protocol extensions for acceleration (such as MIT-SHM or DGA).
1362: Most interactive applications to a local X server will run
1363: reasonably fast, but full motion video and other graphics
1364: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1365: </li>
1.128 wiz 1366: <li class="listitem">
1.75 rillig 1367: <p><span class="strong"><strong>Audio:</strong></span></p>
1368: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1369: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1370: audio system on Interix. Unlike on most platforms, the
1.189 snj 1371: <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 1372: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1373: server component. To output audio via an Interix host, the
1.189 snj 1374: <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 1375: must also be installed.</p>
1.75 rillig 1376: </li>
1.128 wiz 1377: <li class="listitem">
1.75 rillig 1378: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1379: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1380: is not currently possible to access CD/DVD drives, USB devices,
1381: or SCSI devices through non-filesystem means. Among other things,
1382: this makes it impossible to use Interix directly for CD/DVD
1383: burning.</p>
1.75 rillig 1384: </li>
1.128 wiz 1385: <li class="listitem">
1.75 rillig 1386: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1387: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1388: drives are also not directly accessible in Interix. However,
1389: support is in work to make tape drive access possible by using
1390: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1391: esound server).</p>
1.75 rillig 1392: </li>
1393: </ul></div>
1394: </div>
1.148 asau 1395: <div class="sect3">
1.75 rillig 1396: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1397: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1398: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1399: Windows system; any member of the local Administrators group will
1400: suffice. However, some packages currently assume that the user
1401: named "root" is the privileged user. To accommodate these, you
1402: may create such a user; make sure it is in the local group
1403: Administrators (or your language equivalent).</p>
1.110 hubertf 1404: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1405: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1406: time being, install packages as the local Administrator (or
1407: your language equivalent), or run the following command after
1408: installing a package to work around the issue:</p>
1.75 rillig 1409: <pre class="screen">
1.87 wiz 1410: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1411: </pre>
1.75 rillig 1412: </div>
1413: </div>
1.148 asau 1414: <div class="sect2">
1.75 rillig 1415: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1416: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75 rillig 1417: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1418: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1419: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1420: 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 1421: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.189 snj 1422: 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 1423: etc.</p>
1.86 schwarz 1424: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1425: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1426: you start out using "abi=n32", that's what all your packages will be built
1427: with.</p>
1428: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1429: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1430: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1431: try to link n32 object files with lib64 or vice versa. Check your
1432: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1433: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1434: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1435: as it appears that IRIX linker occasionally runs into issues when trying to
1436: link over a network-mounted file system.</p>
1.75 rillig 1437: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1438: as imake(1), but you may want to set some options depending on your local
1439: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1440: course, your compiler's man pages for details.</p>
1.75 rillig 1441: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1442:
1.87 wiz 1443: </p>
1.75 rillig 1444: <pre class="programlisting">
1.100 rillig 1445: PKGSRC_COMPILER= mipspro
1.87 wiz 1446: </pre>
1.75 rillig 1447: <p>
1.1 grant 1448:
1.110 hubertf 1449: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1450: are using gcc and may end up passing invalid flags to the compiler. Note that
1451: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1452: default.</p>
1.75 rillig 1453: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1454: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1455: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1456: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1457: '--preserve-path' flag.</p>
1.75 rillig 1458: </div>
1.148 asau 1459: <div class="sect2">
1.75 rillig 1460: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1461: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87 wiz 1462: <p>Some versions of Linux (for example Debian GNU/Linux) need
1463: either libtermcap or libcurses (libncurses). Installing the
1464: distributions libncurses-dev package (or equivalent) should fix
1465: the problem.</p>
1466: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1467: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1468: i386 have been tested.</p>
1.75 rillig 1469: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1470: directory:</p>
1.75 rillig 1471: <pre class="programlisting">
1.138 wiz 1472: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1473: </pre>
1.148 asau 1474: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1475: <h3 class="title">Note</h3>
1.138 wiz 1476: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1477: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1478: <p>For icc 10.1 neither of these appears to be necessary.</p>
1479: </div>
1480: <p>Use a value for ICCBASE that corresponds to the directory
1481: where icc is installed. After bootstrapping, set
1482: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137 wiz 1483: <pre class="programlisting">
1.138 wiz 1484: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1485: </pre>
1.138 wiz 1486: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1487: <code class="filename">/opt/intel_cc_80</code>. This is the default
1488: install directory for icc 8.0. If you are using a more recent
1489: version, be sure to set the correct path explicitly.
1490: </p>
1.75 rillig 1491: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1492: provided by icc, so binaries can be run on other systems which do not
1493: have the shared libraries installed.</p>
1494: <p>Libtool, however, extracts a list of libraries from the
1.189 snj 1495: <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 1496: records it, throwing away the -Bstatic and -Bdynamic options
1497: interspersed between the libraries. This means that
1498: libtool-linked C++ shared libraries will have a runtime
1499: dependency on the icc libraries until this is fixed in
1500: libtool.</p>
1.75 rillig 1501: </div>
1.148 asau 1502: <div class="sect2">
1.75 rillig 1503: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1504: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163 bsiegert 1505: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1506: Older versions might also work. Releases before #10 are not
1507: supported.</p>
1508: <p>The package tools of the (older) native ports tree,
1509: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1510: have the same names as the ones used by pkgsrc. Care should be taken
1511: that the right tools are used. When installing packages from source,
1512: use the <code class="filename">bmake</code> command for pkgsrc and
1513: <code class="filename">mmake</code> for MirPorts.</p>
1514: <p>pkgsrc and MirPorts use the same location for the package
1515: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1516: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1517: tree is self-contained. This is also the default setting used in the
1518: binary package builds.</p>
1519: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1520: server. The bootstrap kit there already contains the
1521: <span class="command"><strong>pkgin</strong></span> package manager. See the
1522: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1523: page for more details.</p>
1524: </div>
1525: <div class="sect2">
1526: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1527: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136 dholland 1528: <p>OpenBSD 5.1 has been tested and supported,
1529: other versions may work.</p>
1.75 rillig 1530: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1531: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1532: <div class="orderedlist"><ol class="orderedlist" type="1">
1533: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1534: <code class="filename">/var/db/pkg</code>. It is therefore
1535: recommended that you choose a different location (e.g.
1536: <code class="filename">/usr/pkgdb</code>) by
1537: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1538: <li class="listitem">
1.75 rillig 1539: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1540: good idea to move them out of the way to avoid confusion, e.g.</p>
1541: <pre class="screen">
1542: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1543: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1544: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1545: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1546: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1547: </pre>
1.75 rillig 1548: </li>
1.128 wiz 1549: <li class="listitem">
1.110 hubertf 1550: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1551: <code class="filename">/etc/mk.conf.example</code> file
1552: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1553: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1554: as well. You can work around this by enclosing all the pkgsrc-specific parts
1555: of the file with:</p>
1556: <pre class="programlisting">
1.100 rillig 1557: .ifdef BSD_PKG_MK
1558: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1559: .else
1560: # OpenBSD stuff
1561: .endif
1.87 wiz 1562: </pre>
1.75 rillig 1563: </li>
1564: </ol></div>
1565: </div>
1.148 asau 1566: <div class="sect2">
1.75 rillig 1567: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1568: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142 wiz 1569: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1570: You will need a working C compiler. Both gcc 4.5.3 and
1.87 wiz 1571: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1572: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1573: process and to build packages.</p>
1.148 asau 1574: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1575: <li class="listitem"><p>SUNWsprot</p></li>
1576: <li class="listitem"><p>SUNWarc</p></li>
1577: <li class="listitem"><p>SUNWbtool</p></li>
1578: <li class="listitem"><p>SUNWtoo</p></li>
1579: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1580: </ul></div>
1.78 rillig 1581: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1582: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1583: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1584: your $prefix are in your <code class="varname">PATH</code>. This includes
1585: <code class="filename">/usr/ccs/{bin,lib}</code>
1586: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148 asau 1587: <div class="sect3">
1.75 rillig 1588: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1589: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1590: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1591: for building all packages.</p>
1.75 rillig 1592: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1593: then either build gcc from
1.189 snj 1594: <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 1595: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1596: <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 1597: </div>
1.148 asau 1598: <div class="sect3">
1.75 rillig 1599: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1600: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1601: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1602: 5.0)</p>
1.148 asau 1603: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1604: <li class="listitem"><p>SPROcc
1.87 wiz 1605: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1606: <li class="listitem"><p>SPROcpl
1.87 wiz 1607: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1608: <li class="listitem"><p>SPROild
1.87 wiz 1609: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1610: <li class="listitem"><p>SPROlang
1.87 wiz 1611: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1612: </ul></div>
1.96 rillig 1613: <p>You should set the following variables in your
1.110 hubertf 1614: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1615: <pre class="programlisting">
1.100 rillig 1616: CC= cc
1617: CXX= CC
1618: CPP= cc -E
1619: CXXCPP= CC -E
1.96 rillig 1620: </pre>
1.148 asau 1621: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1622: <h3 class="title">Note</h3>
1623: <p>The <code class="varname">CPP</code> setting might break some
1624: packages that use the C preprocessor for processing things other
1625: than C source code.</p>
1626: </div>
1.75 rillig 1627: </div>
1.148 asau 1628: <div class="sect3">
1.75 rillig 1629: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1630: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1631: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1632: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1633: <pre class="programlisting">
1.100 rillig 1634: PKGSRC_COMPILER= sunpro
1635: ABI= 64
1.96 rillig 1636: </pre>
1.148 asau 1637: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1638: <h3 class="title">Note</h3>
1639: <p>This setting has been tested for the SPARC
1640: architecture. Intel and AMD machines need some more
1641: work.</p>
1642: </div>
1.75 rillig 1643: </div>
1.148 asau 1644: <div class="sect3">
1.75 rillig 1645: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1646: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110 hubertf 1647: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1648: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1649: The workaround is to use another shell for the configure
1.189 snj 1650: 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 1651: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1652: <pre class="programlisting">
1.100 rillig 1653: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1654: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1655: </pre>
1.189 snj 1656: <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 1657: </div>
1658: </div>
1659: </div>
1660: </div>
1.148 asau 1661: <div class="chapter">
1.75 rillig 1662: <div class="titlepage"><div><div><h2 class="title">
1663: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1664: <div class="toc">
1665: <p><b>Table of Contents</b></p>
1.195 wiz 1666: <dl class="toc">
1.75 rillig 1667: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1668: <dd><dl>
1669: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1670: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1671: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1672: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1673: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1674: <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>
1675: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1676: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1677: </dl></dd>
1678: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1679: <dd><dl>
1680: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1681: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1682: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1683: </dl></dd>
1684: </dl>
1685: </div>
1686: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1687: is to only install the package tools and to use binary packages
1.128 wiz 1688: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1689: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1690: of pkgsrc, too. Then you are able to build your own packages,
1691: and you can still use binary packages from someone else.</p>
1.148 asau 1692: <div class="sect1">
1.75 rillig 1693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1694: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1695: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1696: server and its mirrors, there are collections of binary packages,
1697: ready to be installed. These binary packages have been built using the
1698: default settings for the directories, that is:</p>
1.148 asau 1699: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1700: <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>
1701: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1702: <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 1703: </ul></div>
1704: <p>If you cannot use these directories for whatever reasons (maybe
1705: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1706: 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 1707: <div class="sect2">
1.75 rillig 1708: <div class="titlepage"><div><div><h3 class="title">
1709: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1710: <p>To install binary packages, you first need to know from where
1711: to get them. The first place where you should look is on the main
1.110 hubertf 1712: 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 1713: <p>This directory contains binary packages for multiple
1714: platforms. First, select your operating system. (Ignore the
1715: directories with version numbers attached to it, they just exist for
1716: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1717: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1718: <p>In this directory, you often find a file called
1719: <code class="filename">bootstrap.tar.gz</code> which contains the package
1720: management tools. If the file is missing, it is likely that your
1721: operating system already provides those tools. Download the file and
1722: extract it in the <code class="filename">/</code> directory. It will create
1723: the directories <code class="filename">/usr/pkg</code> (containing the tools
1724: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1725: (the database of installed packages).</p>
1.75 rillig 1726: </div>
1.148 asau 1727: <div class="sect2">
1.75 rillig 1728: <div class="titlepage"><div><div><h3 class="title">
1729: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1730: <p>In the directory from the last section, there is a
1.196 ! wiz 1731: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1732: binary packages that are available for the platform, excluding those
1733: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1734: medium you are using).</p>
1.109 rillig 1735: <p>To install packages directly from an FTP or HTTP server, run
1736: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1737: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1738: <pre class="screen">
1739: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196 ! wiz 1740: <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 1741: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1742: </pre>
1743: <p>Instead of URLs, you can also use local paths, for example if
1744: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1745: repository. If you want to install packages from multiple sources,
1746: you can separate them by a semicolon in
1747: <code class="varname">PKG_PATH</code>.</p>
1748: <p>After these preparations, installing a package is very
1749: easy:</p>
1750: <pre class="screen">
1751: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1752: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1753: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1754: </pre>
1.75 rillig 1755: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1756: package in question will be installed, too, assuming they are
1757: present where you install from.</p>
1.128 wiz 1758: <p>Adding packages might install vulnerable packages.
1759: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1760: regularly, especially after installing new packages, and verify
1761: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1762: <p>After you've installed packages, be sure to have
1.88 wiz 1763: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1764: <code class="varname">PATH</code> so you can actually start the just
1765: installed program.</p>
1.75 rillig 1766: </div>
1.148 asau 1767: <div class="sect2">
1.75 rillig 1768: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1769: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1770: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1771: installed from source code or from a binary package. The
1.110 hubertf 1772: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1773: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1774: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1775: name can be given with or without version number. Wildcards can
1776: also be used to deinstall a set of packages, for example
1777: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1778: so that the shell does not expand them before
1779: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1780: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1781: removes all the packages that require the package in question
1782: and then removes the package itself. For example:
1.82 rillig 1783:
1.88 wiz 1784: </p>
1.82 rillig 1785: <pre class="screen">
1.88 wiz 1786: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1787: </pre>
1.82 rillig 1788: <p>
1789:
1.88 wiz 1790: will remove jpeg and all the packages that used it; this allows
1791: upgrading the jpeg package.</p>
1.82 rillig 1792: </div>
1.148 asau 1793: <div class="sect2">
1.82 rillig 1794: <div class="titlepage"><div><div><h3 class="title">
1795: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1796: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1797: installed packages or binary package files.</p>
1.82 rillig 1798: </div>
1.148 asau 1799: <div class="sect2">
1.82 rillig 1800: <div class="titlepage"><div><div><h3 class="title">
1801: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1802: <p>
1.88 wiz 1803: The NetBSD Security-Officer and Packages Groups maintain a list of
1804: known security vulnerabilities to packages which are (or have been)
1805: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1806: 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 1807: </p>
1.82 rillig 1808: <p>
1.125 wiz 1809: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1810: this list can be downloaded
1811: automatically, and a security audit of all packages installed on a system
1812: can take place.
1813: </p>
1.82 rillig 1814: <p>
1.125 wiz 1815: There are two components to auditing. The first
1816: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1817: is for downloading
1.88 wiz 1818: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1819: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1820: installed packages are vulnerable. If a package is vulnerable, you
1821: will see output similar to the following:
1822: </p>
1.82 rillig 1823: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1824: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1825: <p>
1.125 wiz 1826: You may wish to have the
1.110 hubertf 1827: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1828: file downloaded daily so that
1829: it remains current. This may be done by adding an appropriate entry
1.189 snj 1830: 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 1831: </p>
1832: <pre class="screen">
1833: # download vulnerabilities file
1834: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1835: </pre>
1836: <p>
1837: will update the vulnerability list every day at 3AM. You may wish to do
1838: this more often than once a day.
1839:
1840: In addition, you may wish to run the package audit from the daily
1841: security script. This may be accomplished by adding the following
1842: line to <code class="filename">/etc/security.local</code>:
1843: </p>
1844: <pre class="screen">
1845: /usr/sbin/pkg_admin audit
1846: </pre>
1847: <p>
1.88 wiz 1848: </p>
1.82 rillig 1849: </div>
1.148 asau 1850: <div class="sect2">
1.82 rillig 1851: <div class="titlepage"><div><div><h3 class="title">
1852: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1853: <p>
1.189 snj 1854: 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 1855: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1856: argument to check if your packages are up-to-date, e.g.
1857: </p>
1858: <pre class="screen">
1859: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1860: ...
1.88 wiz 1861: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1862: </pre>
1.110 hubertf 1863: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1864: package on your system and rebuild any dependencies.
1865: </p>
1.82 rillig 1866: </div>
1.148 asau 1867: <div class="sect2">
1.82 rillig 1868: <div class="titlepage"><div><div><h3 class="title">
1869: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1870: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1871: administrative functions on the package system.</p>
1.82 rillig 1872: </div>
1.148 asau 1873: <div class="sect2">
1.82 rillig 1874: <div class="titlepage"><div><div><h3 class="title">
1875: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1876: <p>Please pay very careful attention to the warnings
1.189 snj 1877: 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 1878: inherent dangers of installing binary packages which you did
1879: not create yourself, and the security holes that can be
1880: introduced onto your system by indiscriminate adding of such
1881: files.</p>
1.75 rillig 1882: <p>The same warning of course applies to every package you
1.88 wiz 1883: install from source when you haven't completely read and
1884: understood the source code of the package, the compiler that
1885: is used to build the package and all the other tools that are
1886: involved.</p>
1.75 rillig 1887: </div>
1888: </div>
1.148 asau 1889: <div class="sect1">
1.75 rillig 1890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1891: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1892: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1893: directory now contains a set of packages, organized into
1894: categories. You can browse the online index of packages, or run
1.110 hubertf 1895: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1896: directory to build local <code class="filename">README.html</code> files for
1.189 snj 1897: 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 1898: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1899: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1900: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1901: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1902: different <code class="varname">LOCALBASE</code> definitions on the same
1903: system (inside a chroot is an exception). </p>
1904: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1905: 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 1906: instructions how to create your own packages.</p>
1.148 asau 1907: <div class="sect2">
1.75 rillig 1908: <div class="titlepage"><div><div><h3 class="title">
1909: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1910: <p>To build packages from source, you need a working C
1.88 wiz 1911: compiler. On NetBSD, you need to install the
1.128 wiz 1912: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1913: sets. If you want to build X11-related packages, the
1.128 wiz 1914: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1915: sets are required, too.</p>
1.75 rillig 1916: </div>
1.148 asau 1917: <div class="sect2">
1.75 rillig 1918: <div class="titlepage"><div><div><h3 class="title">
1919: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1920: <p>The first step for building a package is downloading the
1.88 wiz 1921: distfiles (i.e. the unmodified source). If they have not yet been
1922: downloaded, pkgsrc will fetch them automatically.</p>
1923: <p>If you have all files that you need in the
1924: <code class="filename">distfiles</code> directory,
1925: you don't need to connect. If the distfiles are on CD-ROM, you can
1926: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1927: </p>
1.82 rillig 1928: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1929: <p>
1.110 hubertf 1930: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1931: <p>By default a list of distribution sites will be randomly
1932: intermixed to prevent huge load on servers which holding popular
1933: packages (for example, SourceForge.net mirrors). Thus, every
1934: time when you need to fetch yet another distfile all the mirrors
1935: will be tried in new (random) order. You can turn this feature
1936: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1937: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1938: <p>You can overwrite some of the major distribution sites to
1939: fit to sites that are close to your own. By setting one or two
1940: variables you can modify the order in which the master sites are
1941: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1942: delimited list of domain suffixes.
1943: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1944: contains a whitespace delimited list of regular expressions. It
1945: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1946: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1947: some examples. This may save some of your bandwidth and
1948: time.</p>
1.75 rillig 1949: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1950: if you want to keep the settings, by editing the
1.110 hubertf 1951: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1952: and adding the definitions there.</p>
1.82 rillig 1953: <p>
1.88 wiz 1954: If a package depends on many other packages (such as
1.189 snj 1955: <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 1956: alternate between periods of
1957: downloading source, and compiling. To ensure you have all the source
1958: downloaded initially you can run the command:
1959: </p>
1.82 rillig 1960: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1961: <p>
1.88 wiz 1962: which will output and run a set of shell commands to fetch the
1963: necessary files into the <code class="filename">distfiles</code> directory. You can
1964: also choose to download the files manually.
1965: </p>
1.75 rillig 1966: </div>
1.148 asau 1967: <div class="sect2">
1.75 rillig 1968: <div class="titlepage"><div><div><h3 class="title">
1969: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1970: <p>
1.88 wiz 1971: Once the software has downloaded, any patches will be applied, then it
1972: will be compiled for you. This may take some time depending on your
1973: computer, and how many other packages the software depends on and their
1974: compile time.
1975: </p>
1.148 asau 1976: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1977: <h3 class="title">Note</h3>
1978: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1979: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1980: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1981: </div>
1.87 wiz 1982: <p>For example, type</p>
1.88 wiz 1983: <pre class="screen">
1984: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1985: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1986: </pre>
1.75 rillig 1987: <p>at the shell prompt to build the various components of the
1.88 wiz 1988: package.</p>
1.82 rillig 1989: <p>The next stage is to actually install the newly compiled
1.88 wiz 1990: program onto your system. Do this by entering:
1.82 rillig 1991:
1.88 wiz 1992: </p>
1.82 rillig 1993: <pre class="screen">
1.88 wiz 1994: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1995: </pre>
1.82 rillig 1996: <p>
1997:
1.88 wiz 1998: while you are still in the directory for whatever package you
1999: are installing.</p>
1.82 rillig 2000: <p>Installing the package on your system may require you to
1.88 wiz 2001: be root. However, pkgsrc has a
2002: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2003: to only become root for the actual installation step.</p>
1.82 rillig 2004: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2005: You can now enter:
1.82 rillig 2006:
1.88 wiz 2007: </p>
1.82 rillig 2008: <pre class="screen">
1.88 wiz 2009: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2010: </pre>
1.82 rillig 2011: <p>
2012:
1.88 wiz 2013: to remove the compiled files in the work directory, as you shouldn't need
2014: them any more. If other packages were also added to your system
2015: (dependencies) to allow your program to compile, you can tidy these up
2016: also with the command:</p>
1.82 rillig 2017: <pre class="screen">
1.88 wiz 2018: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2019: </pre>
1.75 rillig 2020: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2021: 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 2022: <p>The program is installed under the default root of the
2023: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2024: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2025: variable in your environment, and it will use that value as the
2026: root of your packages tree. So, to use
2027: <code class="filename">/usr/local</code>, set
2028: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2029: Please note that you should use a directory which is dedicated to
2030: packages and not shared with other programs (i.e., do not try and
2031: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2032: to add any of your own files or directories (such as
2033: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2034: <code class="filename">pkgsrc/</code>) below the
2035: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2036: conflicts between programs and other files installed by the
2037: package system and whatever else may have been installed
2038: there.</p>
1.110 hubertf 2039: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2040: alter some configuration options at build time. Have a look at
2041: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2042: of what will be set there by default. Environment variables such
2043: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2044: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2045: set them each time you want to use pkgsrc.</p>
1.128 wiz 2046: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2047: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 2048: or being installed. This may be for debugging purposes, or out of
2049: simple curiosity. A number of utility values have been added to
2050: help with this.</p>
1.128 wiz 2051: <div class="orderedlist"><ol class="orderedlist" type="1">
2052: <li class="listitem">
1.189 snj 2053: <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 2054: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2055: information will be displayed. For example,</p>
1.75 rillig 2056: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2057: <p>will show all the commands that are invoked, up to and
1.128 wiz 2058: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 2059: </li>
1.128 wiz 2060: <li class="listitem">
1.189 snj 2061: <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 2062: definition, then the <code class="varname">VARNAME</code> definition
2063: should be used, in conjunction with the show-var
1.189 snj 2064: 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 2065: variable <code class="varname">LOCALBASE</code>:</p>
2066: <pre class="screen">
2067: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2068: /usr/pkg
2069: <code class="prompt">%</code>
1.88 wiz 2070: </pre>
1.75 rillig 2071: </li>
2072: </ol></div>
2073: <p>If you want to install a binary package that you've either
1.88 wiz 2074: created yourself (see next section), that you put into
2075: pkgsrc/packages manually or that is located on a remote FTP
2076: server, you can use the "bin-install" target. This target will
1.189 snj 2077: 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 2078: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2079: sites searched is kept in the variable
2080: <code class="varname">BINPKG_SITES</code>, which defaults to
1.189 snj 2081: 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 2082: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2083: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2084: details.</p>
2085: <p>A final word of warning: If you set up a system that has a
2086: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2087: set that before any packages are installed, as you cannot use
2088: several directories for the same purpose. Doing so will result in
2089: pkgsrc not being able to properly detect your installed packages,
2090: and fail miserably. Note also that precompiled binary packages are
2091: usually built with the default <code class="varname">LOCALBASE</code> of
2092: <code class="filename">/usr/pkg</code>, and that you should
2093: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2094: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2095: </div>
2096: </div>
2097: </div>
1.148 asau 2098: <div class="chapter">
1.75 rillig 2099: <div class="titlepage"><div><div><h2 class="title">
2100: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2101: <div class="toc">
2102: <p><b>Table of Contents</b></p>
1.195 wiz 2103: <dl class="toc">
1.75 rillig 2104: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2105: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2106: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2107: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2108: <dd><dl>
1.103 wiz 2109: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2110: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2111: <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 2112: </dl></dd>
1.103 wiz 2113: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2114: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2115: </dl>
2116: </div>
1.104 rillig 2117: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2118: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2119: that file depends on the installation. On NetBSD, when you use
1.189 snj 2120: <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 2121: <code class="filename">/etc/</code>. In all other cases the default location is
2122: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2123: bootstrap program to install the binary packages.</p>
2124: <p>During the bootstrap, an example configuration file is created. To
2125: use that, you have to create the directory
2126: <code class="filename">${PREFIX}/etc</code> and copy the example file
2127: there.</p>
2128: <p>The format of the configuration file is that of the usual
2129: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2130: is done by setting variables in this file. Note that you can define all
2131: kinds of variables, and no special error checking (for example for
2132: spelling mistakes) takes place, so you have to try it out to see if it
2133: works.</p>
1.148 asau 2134: <div class="sect1">
1.75 rillig 2135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2136: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2137: <p>In this section, you can find some variables that apply to all
1.89 rillig 2138: pkgsrc packages. A complete list of the variables that can be
2139: configured by the user is available in
2140: <code class="filename">mk/defaults/mk.conf</code>, together with some
2141: comments that describe each variable's intent.</p>
1.148 asau 2142: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2143: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2144: packages will be installed. The default is
1.76 rillig 2145: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2146: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2147: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2148: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2149: installed. The default is
1.76 rillig 2150: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2151: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2152: X11 is installed on the system. The default is
1.194 bsiegert 2153: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 2154: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2155: downloaded copies of the original source distributions used
2156: for building pkgsrc packages. The default is
1.76 rillig 2157: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2158: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2159: database about installed packages is stored. The default is
2160: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2161: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2162: If set, override the packages'
2163: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2164: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2165: Backup location(s) for distribution files and patch files
2166: if not found locally or in
1.76 rillig 2167: <code class="filename">${MASTER_SITES}</code> or
2168: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2169: The defaults are
1.132 spz 2170: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2171: and
1.76 rillig 2172: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2173: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2174: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2175: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2176: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2177: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2178: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2179: List of acceptable licenses. License names are case-sensitive.
2180: Whenever you try to build a package whose license is not in this
2181: list, you will get an error message. If the license condition is
2182: simple enough, the error message will include specific
2183: instructions on how to change this variable.</p></li>
1.75 rillig 2184: </ul></div>
2185: </div>
1.148 asau 2186: <div class="sect1">
1.75 rillig 2187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2188: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2189: <p>XXX
2190: </p>
1.148 asau 2191: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2192: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2193: directory for the binary packages. The default is
1.76 rillig 2194: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2195: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2196: The top level directory where, if defined, the separate
2197: working directories will get created, and symbolically
1.76 rillig 2198: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2199: This is useful for building packages on several
1.76 rillig 2200: architectures, then <code class="filename">${PKGSRCDIR}</code>
2201: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2202: is local to every architecture. (It should be noted that
2203: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2204: — it is an internal definition which refers to the
1.75 rillig 2205: root of the pkgsrc tree. It is possible to have many
2206: pkgsrc tree instances.)</p></li>
1.128 wiz 2207: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2208: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2209: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2210: information.</p></li>
1.128 wiz 2211: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2212: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2213: BSD-style Makefile. If this is not set,
2214: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2215: <code class="filename">/dev/null</code> to avoid picking up
2216: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2217: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2218: By default, dependencies are only installed, and no binary
2219: package is created for them. You can set this variable to
1.174 asau 2220: <code class="literal">package-install</code> to automatically create binary
1.190 wiz 2221: packages after installing dependencies. Please note that the
1.194 bsiegert 2222: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.190 wiz 2223: <code class="literal">yes</code> to preserve binary packages when
2224: using the <code class="literal">install</code> as well.</p></li>
1.75 rillig 2225: </ul></div>
2226: </div>
1.148 asau 2227: <div class="sect1">
1.75 rillig 2228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2229: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2230: <p>Most packages support installation into a
1.103 wiz 2231: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2232: to be built, before the actual filesystem is touched. DESTDIR
2233: support exists in two variations:</p>
1.148 asau 2234: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2235: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 2236: installation and packaging is still run as root.</p></li>
2237: <li class="listitem"><p>Full DESTDIR support can run the complete
2238: build, installation and packaging as normal user. Root
2239: privileges are only needed to add packages.</p></li>
2240: </ul></div>
2241: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2242: you can set
2243: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2244: so it's preferable to convert a package to DESTDIR instead.</p>
1.103 wiz 2245: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2246: clean</code></strong> needs to be run as root.</p>
1.118 imil 2247: <p>Considering the <code class="filename">foo/bar</code> package,
2248: DESTDIR full support can be tested using the following commands
2249:
2250: </p>
2251: <pre class="programlisting">
2252: <code class="prompt">$</code> id
2253: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2254: <code class="prompt">$</code> mkdir $HOME/packages
2255: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2256: </pre>
2257: <p>
2258:
2259: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2260: should be needed
2261:
2262: </p>
2263: <pre class="programlisting">
1.174 asau 2264: <code class="prompt">$</code> make stage-install
1.118 imil 2265: </pre>
2266: <p>
2267:
2268: Create a package without root privileges
2269:
2270: </p>
2271: <pre class="programlisting">
1.174 asau 2272: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 2273: </pre>
2274: <p>
2275:
2276: For the following command, you must be able to gain root
1.189 snj 2277: 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 2278:
2279: </p>
2280: <pre class="programlisting">
1.174 asau 2281: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 2282: </pre>
2283: <p>
2284:
2285: Then, as a simple user
2286:
2287: </p>
2288: <pre class="programlisting">
2289: <code class="prompt">$</code> make clean
2290: </pre>
2291: <p>
2292:
2293: </p>
1.103 wiz 2294: </div>
1.148 asau 2295: <div class="sect1">
1.103 wiz 2296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2297: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 2298: <div class="sect2">
1.78 rillig 2299: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2300: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2301: <p>By default, pkgsrc will use GCC to build packages. This may be
2302: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 2303: <div class="variablelist"><dl class="variablelist">
1.89 rillig 2304: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2305: <dd>
2306: <p>This is a list of values specifying the chain of
2307: compilers to invoke when building packages. Valid values
2308: are:</p>
1.148 asau 2309: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 2310: <li class="listitem"><p><code class="varname">ccc</code>:
2311: Compaq C Compilers (Tru64)</p></li>
2312: <li class="listitem"><p><code class="varname">ccache</code>:
2313: compiler cache (chainable)</p></li>
2314: <li class="listitem"><p><code class="varname">clang</code>:
2315: Clang C and Objective-C compiler</p></li>
1.128 wiz 2316: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2317: distributed C/C++ (chainable)</p></li>
1.174 asau 2318: <li class="listitem"><p><code class="varname">f2c</code>:
2319: Fortran 77 to C compiler (chainable)</p></li>
2320: <li class="listitem"><p><code class="varname">icc</code>:
2321: Intel C++ Compiler (Linux)</p></li>
2322: <li class="listitem"><p><code class="varname">ido</code>:
2323: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 2324: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2325: GNU C/C++ Compiler</p></li>
1.174 asau 2326: <li class="listitem"><p><code class="varname">hp</code>:
2327: HP-UX C/aC++ compilers</p></li>
1.128 wiz 2328: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2329: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 2330: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 2331: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2332: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2333: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 2334: <li class="listitem"><p><code class="varname">xlc</code>:
2335: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89 rillig 2336: </ul></div>
2337: <p>The default is
1.128 wiz 2338: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2339: <code class="varname">ccache</code> and/or
2340: <code class="varname">distcc</code> with an appropriate
2341: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2342: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2343: variable should always be terminated with a value for
2344: a real compiler. Note that only one real compiler
1.128 wiz 2345: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2346: is not allowed).</p>
1.89 rillig 2347: </dd>
2348: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2349: <dd><p>This specifies the minimum version of GCC to use
2350: when building packages. If the system GCC doesn't
2351: satisfy this requirement, then pkgsrc will build and
2352: install one of the GCC packages to use instead.</p></dd>
2353: </dl></div>
2354: </div>
1.148 asau 2355: <div class="sect2">
1.89 rillig 2356: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2357: <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 2358: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2359: please make sure to use the <code class="literal">+=</code> operator
2360: instead of the <code class="literal">=</code> operator:</p>
2361: <pre class="programlisting">
1.100 rillig 2362: CFLAGS+= -your -flags
1.78 rillig 2363: </pre>
2364: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2365: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2366: need to add their own flags. You may want to take a look
1.189 snj 2367: 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 2368: package if you're interested in optimization specifically
2369: for the current CPU. </p>
1.78 rillig 2370: </div>
1.148 asau 2371: <div class="sect2">
1.88 wiz 2372: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2373: <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 2374: <p>If you want to pass flags to the linker, both in the configure
2375: step and the build step, you can do this in two ways. Either set
2376: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2377: between the two is that <code class="varname">LIBS</code> will be appended to
2378: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2379: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2380: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2381: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2382: <code class="varname">CFLAGS</code>, if you do not wish to override these
2383: settings, use the <code class="literal">+=</code> operator:</p>
2384: <pre class="programlisting">
1.100 rillig 2385: LDFLAGS+= -your -linkerflags
1.88 wiz 2386: </pre>
2387: </div>
1.78 rillig 2388: </div>
1.148 asau 2389: <div class="sect1">
1.78 rillig 2390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2391: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 2392: <p>
1.75 rillig 2393: </p>
1.148 asau 2394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2395: <li class="listitem">
1.75 rillig 2396: <p><code class="varname">PKG_DEVELOPER</code>:
2397: Run some sanity checks that package developers want:
2398: </p>
1.148 asau 2399: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2400: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2401: fuzz</p></li>
1.128 wiz 2402: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2403: binaries will find their shared libs.</p></li>
1.75 rillig 2404: </ul></div>
2405: <p>
1.87 wiz 2406: </p>
1.75 rillig 2407: </li>
1.128 wiz 2408: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2409: of debugging output which is displayed whilst making and
2410: installing the package. The default value for this is 0,
2411: which will not display the commands as they are executed
2412: (normal, default, quiet operation); the value 1 will display
2413: all shell commands before their invocation, and the value 2
2414: will display both the shell commands before their invocation,
1.110 hubertf 2415: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2416: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2417: </ul></div>
2418: <p>
2419: </p>
2420: </div>
1.148 asau 2421: <div class="sect1">
1.75 rillig 2422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2423: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2424: <p>Some packages have build time options, usually to select
2425: between different dependencies, enable optional support for big
2426: dependencies or enable experimental features.</p>
1.75 rillig 2427: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2428: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2429: show-options</strong></span>, for example:</p>
1.75 rillig 2430: <pre class="programlisting">
2431: The following options are supported by this package:
2432: ssl Enable SSL support.
2433: Exactly one of the following gecko options is required:
2434: firefox Use firefox as gecko rendering engine.
2435: mozilla Use mozilla as gecko rendering engine.
2436: At most one of the following database options may be selected:
2437: mysql Enable support for MySQL database.
2438: pgsql Enable support for PostgreSQL database.
1.1 grant 2439:
1.75 rillig 2440: These options are enabled by default: firefox
2441: These options are currently enabled: mozilla ssl
1.1 grant 2442: </pre>
1.75 rillig 2443: <p>The following variables can be defined in
1.110 hubertf 2444: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2445: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2446: which can be used to select or disable options for all packages
2447: that support them, and
2448: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2449: which can be used to select or disable options specifically for
2450: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2451: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2452: are disabled. A few examples:</p>
1.75 rillig 2453: <pre class="screen">
1.110 hubertf 2454: <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 2455: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2456: PKG_OPTIONS.kdebase= debug -sasl
2457: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2458: <p>It is important to note that options that were specifically
1.120 snj 2459: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2460: you do not wish to include the option. If you are unsure you can view
2461: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2462: <p>The following settings are consulted in the order given, and
2463: the last setting that selects or disables an option is
2464: used:</p>
1.128 wiz 2465: <div class="orderedlist"><ol class="orderedlist" type="1">
2466: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2467: maintainer</p></li>
1.128 wiz 2468: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2469: variables (see below)</p></li>
1.128 wiz 2470: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2471: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2472: </ol></div>
2473: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2474: selected is used, all others are automatically disabled. If an
2475: option of the group is explicitly disabled, the previously
2476: selected option, if any, is used. It is an error if no option
2477: from a required group of options is selected, and building the
2478: package will fail.</p>
2479: <p>Before the options framework was introduced, build options
2480: were selected by setting a variable (often named
2481: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2482: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2483: transition to the options framework for the user, these legacy
2484: variables are converted to the appropriate options setting
2485: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2486: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2487: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2488: directly. Support for the legacy variables will be removed
2489: eventually.</p>
1.75 rillig 2490: </div>
2491: </div>
1.148 asau 2492: <div class="chapter">
1.75 rillig 2493: <div class="titlepage"><div><div><h2 class="title">
2494: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2495: <div class="toc">
2496: <p><b>Table of Contents</b></p>
1.195 wiz 2497: <dl class="toc">
1.75 rillig 2498: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2499: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2500: </dl>
2501: </div>
1.148 asau 2502: <div class="sect1">
1.75 rillig 2503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2504: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2505: <p>Once you have built and installed a package, you can create
2506: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.189 snj 2507: 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 2508: the same package on a group of hosts and wasting CPU time. It also
2509: provides a simple means for others to install your package, should
2510: you distribute it.</p>
2511: <p>To create a binary package, change into the appropriate
1.110 hubertf 2512: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2513: package</strong></span>:</p>
2514: <pre class="screen">
2515: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2516: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2517: </pre>
2518: <p>This will build and install your package (if not already done),
2519: and then build a binary package from what was installed. You can
1.110 hubertf 2520: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2521: it. Binary packages are created by default in
2522: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2523: 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 2524: 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 2525: <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 2526: such a binary package.</p>
1.75 rillig 2527: </div>
1.148 asau 2528: <div class="sect1">
1.75 rillig 2529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2530: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2531: <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 2532: </div>
2533: </div>
1.148 asau 2534: <div class="chapter">
1.106 rillig 2535: <div class="titlepage"><div><div><h2 class="title">
2536: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2537: builds)</h2></div></div></div>
2538: <div class="toc">
2539: <p><b>Table of Contents</b></p>
1.195 wiz 2540: <dl class="toc">
1.180 wiz 2541: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2542: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2543: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2544: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 2545: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2546: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2547: </dl>
2548: </div>
1.180 wiz 2549: <p>For a number of reasons you may want to build binary packages
2550: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2551: For instance, when you have multiple machines that should run the same software,
2552: it is wasted time if they all build their packages themselves from source.
2553: Or you may want to build a list of packages you want and check them before
2554: deploying onto production system.
2555: There is a way of getting a set of binary packages:
1.174 asau 2556: The bulk build system, or pbulk ("p" stands for "parallel).
2557: This chapter describes how to set it up so that the packages
1.106 rillig 2558: are most likely to be usable later.</p>
1.148 asau 2559: <div class="sect1">
1.106 rillig 2560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2561: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2562: <p>First of all, you have to decide whether you build all packages
2563: or a limited set of them. Full bulk builds usually consume a lot more resources,
2564: both space and time, than builds for some practical sets of packages.
2565: There exists a number of particularly heavy packages that are not actually
2566: interesting to a wide audience.
2567:
2568: For a limited bulk builds you need to make a list of packages you want to build.
2569: Note, that all their dependencies will be built, so you don't need to track them manually.
2570: </p>
2571: <p>During bulk builds various packages are installed and deinstalled
2572: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2573: so make sure that you don't need any package during the builds.
2574: Essentially, you should provide fresh system, either a chroot environment
2575: or something even more restrictive, depending on what the operating system provides,
2576: or dedicate the whole physical machine.
2577: As a useful side effect this makes sure that bulk builds cannot
2578: break anything in your system. There have been numerous cases where
1.106 rillig 2579: certain packages tried to install files outside the
2580: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2581: <code class="filename">/etc</code>.
2582: </p>
1.106 rillig 2583: </div>
1.148 asau 2584: <div class="sect1">
1.106 rillig 2585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2586: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2587: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2588: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2589: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2590: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2591: </ul></div>
1.148 asau 2592: <div class="sect2">
1.116 rillig 2593: <div class="titlepage"><div><div><h3 class="title">
1.180 wiz 2594: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.178 asau 2595: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2596: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2597: Configure network access to fetch distribution files.
2598: Create user with name "pbulk".</p>
2599: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2600: <pre class="screen">
1.181 wiz 2601: <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>
2602: <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>
2603: <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 2604: </pre>
2605: <p>Or any other way that fits (e.g., curl, wget).</p>
2606: <p>Deploy and configure pbulk tools, e.g.:</p>
2607: <pre class="screen">
2608: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2609: <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>
2610: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2611: </pre>
2612: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2613: <h3 class="title">Note</h3>
2614: <p><code class="filename">mk.conf.frag</code> is a fragment of
2615: <code class="filename">mk.conf</code> that contains settings you want to
2616: apply to packages you build. For instance,</p>
2617: <pre class="programlisting">
2618: PKG_DEVELOPER= yes # perform more checks
2619: X11_TYPE= modular # use pkgsrc X11
2620: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2621: </pre>
2622: </div>
2623: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2624: with your list of packages one per line without empty lines or comments. E.g.:</p>
2625: <pre class="programlisting">
2626: www/firefox
2627: mail/thunderbird
2628: misc/libreoffice4
2629: </pre>
1.179 asau 2630: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2631: and make final amendments, if wanted.</p>
1.178 asau 2632: <p>Start it:</p>
2633: <pre class="screen">
2634: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2635: </pre>
2636: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2637: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2638: </p>
2639: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2640: <h3 class="title">Note</h3>
2641: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2642: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2643: The script is kept small enough for better understanding.</p>
2644: </div>
2645: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2646: <h3 class="title">Note</h3>
2647: <p>The <code class="filename">pbulk.sh</code> script supports running
2648: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2649: </div>
1.106 rillig 2650: </div>
2651: </div>
1.148 asau 2652: <div class="sect1">
1.106 rillig 2653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2654: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2655: <p>A complete bulk build requires lots of disk space. Some of the
2656: disk space can be read-only, some other must be writable. Some can be on
2657: remote filesystems (such as NFS) and some should be local. Some can be
2658: temporary filesystems, others must survive a sudden reboot.</p>
2659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2660: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2661: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2662: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2663: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2664: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2665: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2666: </ul></div>
2667: </div>
2668: <div class="sect1">
2669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2670: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2671: <p>After your pkgsrc bulk-build has completed, you may wish to
2672: create a CD-ROM set of the resulting binary packages to assist
2673: in installing packages on other machines. The
1.189 snj 2674: <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 2675: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2676: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2677: way that keeps all the dependencies for a given package on the same
2678: CD as that package.</p>
1.148 asau 2679: <div class="sect2">
1.75 rillig 2680: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2681: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2682: <p>Complete documentation for cdpack is found in the cdpack(1)
2683: man page. The following short example assumes that the binary
2684: packages are left in
2685: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2686: sufficient disk space exists in <code class="filename">/u2</code> to
2687: hold the ISO 9660 images.</p>
2688: <pre class="screen">
2689: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2690: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2691: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2692: </pre>
2693: <p>If you wish to include a common set of files
2694: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2695: etc.) on each CD in the collection, then you need to create a
2696: directory which contains these files. e.g.</p>
2697: <pre class="screen">
2698: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2699: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2700: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2701: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2702: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2703: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2704: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2705: </pre>
1.75 rillig 2706: <p>Now create the images:</p>
2707: <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 2708: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2709: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2710: in their root directories.</p>
1.75 rillig 2711: </div>
2712: </div>
2713: </div>
1.148 asau 2714: <div class="chapter">
1.75 rillig 2715: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2716: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2717: <div class="toc">
2718: <p><b>Table of Contents</b></p>
1.195 wiz 2719: <dl class="toc">
1.128 wiz 2720: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2721: <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 2722: </dl>
2723: </div>
2724: <p>The files that are installed by pkgsrc are organized in a way that
2725: is similar to what you find in the <code class="filename">/usr</code> directory
2726: of the base system. But some details are different. This is because
2727: pkgsrc initially came from FreeBSD and had adopted its file system
2728: hierarchy. Later it was largely influenced by NetBSD. But no matter
2729: which operating system you are using pkgsrc with, you can expect the
2730: same layout for pkgsrc.</p>
1.91 rillig 2731: <p>There are mainly four root directories for pkgsrc, which are all
2732: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2733: When pkgsrc has been installed as root, the default locations
2734: are:</p>
2735: <pre class="programlisting">
1.100 rillig 2736: LOCALBASE= /usr/pkg
2737: PKG_SYSCONFBASE= /usr/pkg/etc
2738: VARBASE= /var
2739: PKG_DBDIR= /var/db/pkg
1.91 rillig 2740: </pre>
2741: <p>In unprivileged mode (when pkgsrc has been installed as any other
2742: user), the default locations are:</p>
2743: <pre class="programlisting">
1.100 rillig 2744: LOCALBASE= ${HOME}/pkg
2745: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2746: VARBASE= ${HOME}/pkg/var
2747: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 2748: </pre>
2749: <p>What these four directories are for, and what they look like is
2750: explained below.</p>
1.148 asau 2751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2752: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2753: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2754: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2755: the well-known subdirectories like <code class="filename">bin</code>,
2756: <code class="filename">include</code>, <code class="filename">lib</code>,
2757: <code class="filename">share</code> and
2758: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2759: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2760: <code class="filename">/var</code> in the base system. Some programs (especially
2761: games, network daemons) need write access to it during normal
2762: operation.</p></li>
1.128 wiz 2763: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2764: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2765: 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 2766: itself.</p></li>
2767: </ul></div>
1.148 asau 2768: <div class="sect1">
1.90 rillig 2769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2770: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2771: </h2></div></div></div>
1.90 rillig 2772: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2773: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2774: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2775: <dt><span class="term"><code class="filename">bin</code></span></dt>
2776: <dd><p>Contains executable programs that are intended to be
2777: directly used by the end user.</p></dd>
2778: <dt><span class="term"><code class="filename">emul</code></span></dt>
2779: <dd><p>Contains files for the emulation layers of various other
2780: operating systems, especially for
2781: NetBSD.</p></dd>
2782: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2783: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2784: <dd><p>Contains
2785: the configuration files.</p></dd>
2786: <dt><span class="term"><code class="filename">include</code></span></dt>
2787: <dd><p>Contains headers for the C and C++ programming
2788: languages.</p></dd>
2789: <dt><span class="term"><code class="filename">info</code></span></dt>
2790: <dd><p>Contains GNU info files of various
2791: packages.</p></dd>
2792: <dt><span class="term"><code class="filename">lib</code></span></dt>
2793: <dd><p>Contains shared and static
2794: libraries.</p></dd>
2795: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2796: <dd><p>Contains data files that don't change after
2797: installation. Other data files belong into
2798: <code class="filename">${VARBASE}</code>.</p></dd>
2799: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2800: <dd><p>Contains programs that are not intended to be used by
2801: end users, such as helper programs or network
2802: daemons.</p></dd>
2803: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2804: <dd><p>Contains programs that are intended to be executed as
2805: CGI scripts by a web server.</p></dd>
2806: <dt><span class="term"><code class="filename">man</code> (the usual value of
2807: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2808: <dd><p>Contains brief
2809: documentation in form of manual pages.</p></dd>
2810: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2811: <dd><p>Contains programs that are intended to be used only by
2812: the super-user.</p></dd>
2813: <dt><span class="term"><code class="filename">share</code></span></dt>
2814: <dd><p>Contains platform-independent data files that don't
2815: change after installation.</p></dd>
2816: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2817: <dd><p>Contains documentation files provided by the
2818: packages.</p></dd>
2819: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2820: <dd><p>Contains example files provided by the packages. Among
2821: others, the original configuration files are saved here and copied to
2822: <code class="filename">${PKG_SYSCONFDIR}</code> during
2823: installation.</p></dd>
2824: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2825: <dd><p>Contains the original files for rc.d
2826: scripts.</p></dd>
2827: <dt><span class="term"><code class="filename">var</code> (the usual location of
2828: <code class="filename">${VARBASE}</code>)</span></dt>
2829: <dd><p>Contains files
2830: that may be modified after
2831: installation.</p></dd>
2832: </dl></div>
2833: </div>
1.148 asau 2834: <div class="sect1">
1.90 rillig 2835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2836: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2837: </h2></div></div></div>
1.148 asau 2838: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2839: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2840: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2841: <dd><p>Contains
2842: information about the currently installed
2843: packages.</p></dd>
2844: <dt><span class="term"><code class="filename">games</code></span></dt>
2845: <dd><p>Contains highscore
2846: files.</p></dd>
2847: <dt><span class="term"><code class="filename">log</code></span></dt>
2848: <dd><p>Contains log files.</p></dd>
2849: <dt><span class="term"><code class="filename">run</code></span></dt>
2850: <dd><p>Contains informational files about daemons that are
2851: currently running.</p></dd>
2852: </dl></div>
2853: </div>
2854: </div>
1.148 asau 2855: <div class="chapter">
1.90 rillig 2856: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2857: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2858: <div class="toc">
2859: <p><b>Table of Contents</b></p>
1.195 wiz 2860: <dl class="toc">
1.106 rillig 2861: <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 2862: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2863: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2864: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2865: <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>
2866: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2867: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2868: <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>
2869: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2870: <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 2871: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 2872: <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>
2873: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2874: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2875: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2876: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2877: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2878: <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 2879: </dl>
2880: </div>
2881: <p>This section contains hints, tips & tricks on special things in
2882: pkgsrc that we didn't find a better place for in the previous chapters, and
2883: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2884: <div class="sect1">
1.75 rillig 2885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2886: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2887: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2888: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2889: <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 2890: This is a general purpose list for most issues regarding
2891: pkgsrc, regardless of platform, e.g. soliciting user help
2892: for pkgsrc configuration, unexpected build failures, using
2893: particular packages, upgrading pkgsrc installations,
2894: questions regarding the pkgsrc release branches, etc. General announcements or
2895: proposals for changes that impact the pkgsrc user community,
2896: e.g. major infrastructure changes, new features, package
2897: removals, etc., may also be posted.</p></li>
1.128 wiz 2898: <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 2899: A list where the results of pkgsrc bulk builds are sent and
2900: discussed.</p></li>
1.128 wiz 2901: <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 2902: This list is for those who are interested in getting a
2903: commit message for every change committed to pkgsrc. It is
2904: also available in digest form, meaning one daily message
2905: containing all commit messages for changes to the package
2906: source tree in that 24 hour period.</p></li>
2907: </ul></div>
2908: <p>To subscribe, do:</p>
2909: <pre class="programlisting">
1.100 rillig 2910: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2911: </pre>
2912: <p>Archives for all these mailing lists are available from
1.110 hubertf 2913: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2914: </div>
1.148 asau 2915: <div class="sect1">
1.75 rillig 2916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2917: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2918: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2919: a number of useful utilities for both users and developers of pkgsrc. This
2920: section attempts only to make the reader aware of the utilities and when
2921: they might be useful, and not to duplicate the documentation that comes
2922: with each package.</p>
2923: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.189 snj 2924: <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 2925: Symlinks for use by buildlink.</p></li></ul></div>
2926: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2927: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2928: <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 2929: Calculates various kinds of checksums (including SHA1).</p></li>
1.189 snj 2930: <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 2931: Compatibility library for pkgsrc tools.</p></li>
1.189 snj 2932: <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 2933: non-BSD systems due to lack of native mtree.</p></li>
1.189 snj 2934: <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 2935: Up-to-date replacement for
1.76 rillig 2936: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2937: systems where pkg_install is not present.</p></li>
2938: </ul></div>
2939: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2941: <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 2942: Create a binary package from an
1.110 hubertf 2943: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2944: save the old package.</p></li>
1.189 snj 2945: <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 2946: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2947: from multiple locations. It currently supports the following
2948: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.189 snj 2949: <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 2950: the best compiler flags to optimise code for your current
1.128 wiz 2951: CPU and compiler. </p></li>
1.75 rillig 2952: </ul></div>
2953: <p>Utilities for keeping track of installed packages, being up to date,
2954: etc:</p>
1.148 asau 2955: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2956: <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 2957: update tool similar to apt(1). Download, install, and upgrade
2958: binary packages easily.</p></li>
1.189 snj 2959: <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 2960: packages whose installed versions do not match the latest pkgsrc
2961: entries.</p></li>
1.189 snj 2962: <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 2963: dependency graphs of packages, to aid in choosing a strategy for
2964: updating.</p></li>
1.189 snj 2965: <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
2966: 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>
2967: <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 2968: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.189 snj 2969: <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 2970: does various checks on the complete pkgsrc system.</p></li>
1.189 snj 2971: <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 2972: packages you have installed.</p></li>
2973: </ul></div>
2974: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2975: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2976: <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 2977: making and maintaining patches for a package (includes pkgdiff,
2978: pkgvi, mkpatches, etc.).</p></li>
1.189 snj 2979: <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 2980: converting to pkgsrc.</p></li>
2981: </ul></div>
2982: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2983: utilities)</p>
1.148 asau 2984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2985: <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 2986: packages in a chrooted area.</p></li>
1.189 snj 2987: <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 2988: kernel version for chrooted cross builds.</p></li>
2989: </ul></div>
2990: </div>
1.148 asau 2991: <div class="sect1">
1.75 rillig 2992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2993: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 2994: <p>If you want to use pkgsrc as non-root user, you can set some
2995: variables to make pkgsrc work under these conditions. At the very least,
1.128 wiz 2996: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 2997: will turn on unprivileged mode and set multiple related variables to allow
2998: installation of packages as non-root.</p>
2999: <p>In case the defaults are not enough, you may want to tune some other
3000: variables used. For example, if the automatic user/group detection leads
3001: to incorrect values (or not the ones you would like to use), you can change
3002: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3003: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3004: <p>As regards bootstrapping, please note that the
1.110 hubertf 3005: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3006: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3007: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3008: installation targets. These directories can be overridden by the
1.128 wiz 3009: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3010: that allow finer tuning of the tree layout.</p>
3011: </div>
1.148 asau 3012: <div class="sect1">
1.75 rillig 3013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3014: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3015: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3016: enable this feature by adding the option
3017: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3018: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3019: distfile is found, pkgsrc will try to resume it.</p>
3020: <p>You can also
1.168 wiz 3021: use a different program than the platform default program by changing the
1.117 jnemeth 3022: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3023: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3024: by using the value manual. A value of custom disables the system defaults
3025: and dependency tracking for the fetch program. In that case you have to
3026: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3027: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3028: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3029: <p>For example, if you want to use
1.117 jnemeth 3030: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3031: like:</p>
3032: <pre class="programlisting">
1.117 jnemeth 3033: FETCH_USING= wget
1.1 grant 3034: </pre>
1.75 rillig 3035: </div>
1.148 asau 3036: <div class="sect1">
1.75 rillig 3037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3038: <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 3039: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3040: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3041: you will have to add the following line into
1.110 hubertf 3042: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3043: <pre class="programlisting">
1.103 wiz 3044: X11_TYPE=modular
1.1 grant 3045: </pre>
1.148 asau 3046: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3047: <h3 class="title">Note</h3>
1.103 wiz 3048: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3049: </p>
1.75 rillig 3050: </div>
3051: </div>
1.148 asau 3052: <div class="sect1">
1.75 rillig 3053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3054: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3055: <p>If you are sitting behind a firewall which does not allow direct
3056: connections to Internet hosts (i.e. non-NAT), you may specify the
3057: relevant proxy hosts. This is done using an environment variable in the
3058: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 3059: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3060: port 80 as the proxy port number. So the proxy environment variables
3061: are:</p>
3062: <pre class="programlisting">
1.100 rillig 3063: ftp_proxy=ftp://orpheus.amdahl.com:80/
3064: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3065: </pre>
1.75 rillig 3066: </div>
1.148 asau 3067: <div class="sect1">
1.75 rillig 3068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3069: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 3070: <p>Some fetch tools are not prepared to support HTTPS by default
3071: (for example, the one in NetBSD 6.0), or the one installed by the
3072: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3073: dependency graph).</p>
3074: <p>Usually you won't notice, because distribution files are
3075: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3076: be often enough if you are following pkgsrc-current. In that case, set
3077: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3078: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3079: with HTTPS support by default. Of course, these tools need to be
3080: installed before you can use them this way.</p>
3081: </div>
3082: <div class="sect1">
3083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3084: <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 3085: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3086: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3087: the first available command from the following list:</p>
1.148 asau 3088: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3089: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3090: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3091: </ul></div>
3092: <p>On a default NetBSD installation, this will be
1.76 rillig 3093: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3094: connections first, and falls back to active connections if the server
3095: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3096: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3097: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3098: <p>Having that option present will prevent
1.76 rillig 3099: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3100: transfers.</p>
3101: </div>
1.148 asau 3102: <div class="sect1">
1.75 rillig 3103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3104: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3105: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3106: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3107: 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 3108: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3109: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3110: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3111: resulting list to your machine at work/school and use it there. If you
1.189 snj 3112: 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 3113: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3114: URL:</p>
3115: <p>At home:</p>
3116: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3117: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3118: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3119: <p>At work:</p>
3120: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3121: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3122: home.</p>
3123: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3124: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3125: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3126: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3127: directly by running:</p>
1.75 rillig 3128: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3129: <p>If you even decide to ignore
3130: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3131: by running:</p>
3132: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3133: </div>
1.148 asau 3134: <div class="sect1">
1.75 rillig 3135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3136: <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 3137: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.189 snj 3138: <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 3139: package, you get the error from make that it doesn't know how to make
1.76 rillig 3140: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3141: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3142: the NetBSD base distribution on your machine. It is recommended to do
3143: that to format man pages.</p>
1.189 snj 3144: <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 3145: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3146: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3147: </div>
1.148 asau 3148: <div class="sect1">
1.75 rillig 3149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3150: <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 3151: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3152: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3153: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3154: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3155: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3156: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3157: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3158: -r</strong></span>).</p>
3159: </div>
1.148 asau 3160: <div class="sect1">
1.75 rillig 3161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3162: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3163: <p>When installing packages as non-root user and using the just-in-time
1.189 snj 3164: <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 3165: password for each required package installed. To avoid this, the sudo
3166: package can be used, which does password caching over a limited time. To
3167: use it, install sudo (either as binary package or from
1.189 snj 3168: <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 3169: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3170: <span class="emphasis"><em>after</em></span> the definition of the
3171: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3172: <pre class="programlisting">
1.100 rillig 3173: .if exists(${LOCALBASE}/bin/sudo)
3174: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3175: .endif
1.1 grant 3176: </pre>
1.75 rillig 3177: </div>
1.148 asau 3178: <div class="sect1">
1.75 rillig 3179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3180: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3181: <p>As the system administrator, you can choose where configuration files
3182: are installed. The default settings make all these files go into
1.76 rillig 3183: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3184: be suboptimal depending on your expectations (e.g., a read-only,
3185: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3186: configuration of the provided packages).</p>
3187: <p>In order to change the defaults, you can modify the
3188: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3189: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3190: directory; some common examples include <code class="filename">/etc</code> or
3191: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3192: <p>Furthermore, you can change this value on a per-package basis by
3193: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3194: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3195: package you would like to modify, that is, the contents of
3196: <code class="varname">PKGBASE</code>.</p>
3197: <p>Note that after changing these settings, you must rebuild and
3198: reinstall any affected packages.</p>
3199: </div>
1.148 asau 3200: <div class="sect1">
1.75 rillig 3201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3202: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3203: <p>Please be aware that there can often be bugs in third-party software,
3204: and some of these bugs can leave a machine vulnerable to exploitation by
3205: attackers. In an effort to lessen the exposure, the NetBSD packages team
3206: maintains a database of known-exploits to packages which have at one time
3207: been included in pkgsrc. The database can be downloaded automatically, and
3208: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3209: do this, refer to the following two tools (installed as part of the
1.189 snj 3210: <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 3211: <div class="orderedlist"><ol class="orderedlist" type="1">
3212: <li class="listitem">
1.122 reed 3213: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3214: download a list of the security vulnerabilities information. This list
1.132 spz 3215: is kept up to date by the pkgsrc security team, and is distributed
3216: from the NetBSD ftp server:</p>
3217: <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 3218: </li>
1.128 wiz 3219: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3220: current machine, checking each known vulnerability. If a
1.75 rillig 3221: vulnerable package is installed, it will be shown by output to stdout,
3222: including a description of the type of vulnerability, and a URL
3223: containing more information.</p></li>
3224: </ol></div>
1.114 jmcneill 3225: <p>Use of these tools is strongly recommended! After
1.128 wiz 3226: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3227: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3228: pkg_install</code></strong>.</p>
1.87 wiz 3229: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3230: 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 3231: check.</p>
1.75 rillig 3232: </div>
1.148 asau 3233: <div class="sect1">
1.75 rillig 3234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3235: <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 3236: <p>When you add your own preferences to the
3237: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3238: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3239: environment variables to the <code class="filename">./configure</code>
1.189 snj 3240: 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 3241: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3242: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3243: package.</p>
3244: <p>Currently there is no solution to this problem. If you
3245: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3246: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3247: directory and then inspect any <code class="filename">Makefile</code> and
3248: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3249: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3250: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3251: programmers write so bad code that it only works for the
3252: specific combination of <code class="varname">CFLAGS</code> they have
3253: chosen.</p>
3254: </div>
1.148 asau 3255: <div class="sect1">
1.80 rillig 3256: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3257: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3258: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3259: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3260: case that occurs often is that people only update pkgsrc in
3261: parts, because of performance reasons. Since pkgsrc is one large
3262: system, not a collection of many small systems, there are
3263: sometimes changes that only work when the whole pkgsrc tree is
3264: updated.</p></li>
1.148 asau 3265: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3266: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3267: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3268: files.</p></li>
1.148 asau 3269: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3270: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3271: verify this.</p></li>
1.148 asau 3272: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3273: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3274: </ol></div>
3275: </div>
1.148 asau 3276: <div class="sect1">
1.88 wiz 3277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3278: <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 3279: <p>You have modified a file from pkgsrc, and someone else has
3280: modified that same file afterwards in the CVS repository. Both changes
3281: are in the same region of the file, so when you updated pkgsrc, the
3282: <code class="literal">cvs</code> command marked the conflicting changes in the
3283: file. Because of these markers, the file is no longer a valid
3284: <code class="filename">Makefile</code>.</p>
3285: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3286: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3287: -dP</strong></span> in that directory to download the current version.</p>
3288: </div>
1.75 rillig 3289: </div>
3290: </div>
1.148 asau 3291: <div class="part">
1.75 rillig 3292: <div class="titlepage"><div><div><h1 class="title">
3293: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3294: <div class="partintro">
1.77 rillig 3295: <div></div>
3296: <p>This part of the book deals with creating and
1.128 wiz 3297: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3298: guide on creating a new package. The remaining chapters are more
3299: like a reference manual for pkgsrc.</p>
1.75 rillig 3300: <div class="toc">
3301: <p><b>Table of Contents</b></p>
1.195 wiz 3302: <dl class="toc">
1.106 rillig 3303: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3304: <dd><dl>
1.106 rillig 3305: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3306: <dd><dl>
1.106 rillig 3307: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3308: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3309: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3310: </dl></dd>
1.106 rillig 3311: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3312: <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>
3313: </dl></dd>
3314: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3315: <dd><dl>
1.128 wiz 3316: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3317: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3318: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3319: <dd><dl>
3320: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3321: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3322: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3323: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3324: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3325: </dl></dd>
3326: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3327: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3328: <dd><dl>
3329: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3330: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3331: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3332: </dl></dd>
1.128 wiz 3333: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3334: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3335: </dl></dd>
1.128 wiz 3336: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3337: <dd><dl>
3338: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3339: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3340: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3341: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3342: <dd><dl>
3343: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3344: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3345: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3346: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3347: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3348: </dl></dd>
3349: </dl></dd>
3350: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3351: <dd><dl>
3352: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 3353: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3354: <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 3355: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3356: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 3357: <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 3358: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3359: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3360: </dl></dd>
3361: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3362: <dd><dl>
3363: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 3364: <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 3365: <dd><dl>
3366: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 3367: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3368: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3369: and
3370: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3371: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3372: </dl></dd>
1.128 wiz 3373: <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 3374: <dd><dl>
1.128 wiz 3375: <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 3376: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3377: </dl></dd>
3378: </dl></dd>
3379: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3380: <dd><dl>
3381: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3382: <dd><dl>
3383: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3384: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3385: </dl></dd>
3386: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3387: <dd><dl>
1.128 wiz 3388: <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 3389: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3390: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3391: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3392: </dl></dd>
3393: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3394: <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>
3395: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3396: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3397: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3398: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3399: <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>
3400: </dl></dd>
3401: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3402: <dd><dl>
3403: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3404: <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 3405: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3406: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3407: </dl></dd>
3408: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3409: <dd><dl>
3410: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3411: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3412: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3413: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3414: <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 3415: <dd><dl>
3416: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3417: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3418: </dl></dd>
1.128 wiz 3419: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3420: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3421: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3422: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3423: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3424: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3425: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3426: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3427: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3428: <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 3429: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3430: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3431: </dl></dd>
3432: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3433: <dd><dl>
3434: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3435: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3436: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3437: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3438: </dl></dd>
3439: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3440: <dd><dl>
3441: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3442: <dd><dl>
3443: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3444: <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 3445: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3446: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3447: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3448: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3449: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3450: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3451: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3452: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3453: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3454: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3455: </dl></dd>
1.128 wiz 3456: <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 3457: <dd><dl>
3458: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3459: <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>
3460: </dl></dd>
1.128 wiz 3461: <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 3462: <dd><dl>
3463: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3464: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3465: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3466: </dl></dd>
3467: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3468: <dd><dl>
3469: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3470: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3471: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 3472: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3473: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 3474: </dl></dd>
1.128 wiz 3475: <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 3476: <dd><dl>
3477: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3478: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3479: <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 3480: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3481: </dl></dd>
1.128 wiz 3482: <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 3483: <dd><dl>
3484: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3485: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3486: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3487: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3488: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3489: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3490: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3491: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3492: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3493: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3494: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3495: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3496: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3497: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3498: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3499: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3500: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3501: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3502: emulation</a></span></dt>
1.106 rillig 3503: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3504: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3505: </dl></dd>
1.106 rillig 3506: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3507: </dl></dd>
1.106 rillig 3508: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3509: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3510: <dd><dl>
1.106 rillig 3511: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3512: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3513: <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 3514: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3515: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3516: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3517: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3518: </dl></dd>
3519: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3520: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3521: <dd><dl>
3522: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3523: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3524: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3525: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3526: </dl></dd>
1.75 rillig 3527: </dl>
3528: </div>
1.77 rillig 3529: </div>
1.148 asau 3530: <div class="chapter">
1.77 rillig 3531: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3532: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3533: <div class="toc">
3534: <p><b>Table of Contents</b></p>
1.195 wiz 3535: <dl class="toc">
1.106 rillig 3536: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3537: <dd><dl>
1.106 rillig 3538: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3539: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3540: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3541: </dl></dd>
1.106 rillig 3542: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3543: <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 3544: </dl>
3545: </div>
1.77 rillig 3546: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3547: most likely have a URL from where you can download the source
3548: code. Starting with this URL, creating a package involves only a
3549: few steps.</p>
1.128 wiz 3550: <div class="procedure"><ol class="procedure" type="1">
1.189 snj 3551: <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 3552: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3553: category in which you want to place your package. You can also create a
3554: directory of your own (maybe called <code class="filename">local</code>). In that
3555: category directory, create another directory for your package and change
3556: into it.</p></li>
1.148 asau 3557: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3558: you for a URL. Enter the URL of the distribution file (in most cases a
3559: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3560: of your package are created automatically. The distribution file is
3561: extracted automatically to fill in some details in the
3562: <code class="filename">Makefile</code> that would otherwise have to be done
3563: manually.</p></li>
1.148 asau 3564: <li class="step">
1.91 rillig 3565: <p>Examine the extracted files to determine the dependencies of
3566: your package. Ideally, this is mentioned in some
3567: <code class="filename">README</code> file, but things may differ. For each of
3568: these dependencies, look where it exists in pkgsrc, and if there is a
3569: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3570: line to your package <code class="filename">Makefile</code> which includes that
3571: file just before the last line. If the
1.132 spz 3572: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3573: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3574: <p>If you just need binaries from a package, add a
1.91 rillig 3575: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3576: version of the dependency and where it can be found in pkgsrc. This line
3577: should be placed in the third paragraph. If the dependency is only
3578: needed for building the package, but not when using it, use
3579: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3580: Your package may then look like this:</p>
1.77 rillig 3581: <pre class="programlisting">
1.100 rillig 3582: [...]
1.77 rillig 3583:
1.174 asau 3584: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3585: DEPENDS+= screen-[0-9]*:../../misc/screen
3586: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3587:
1.100 rillig 3588: [...]
1.77 rillig 3589:
1.100 rillig 3590: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3591: .include "../../devel/glib2/buildlink3.mk"
3592: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3593: </pre>
3594: </li>
1.148 asau 3595: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3596: 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 3597: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3598: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3599: -e</strong></span>, which outputs additional
3600: explanations.</p></li>
1.148 asau 3601: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3602: 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 3603: over there, you can hopefully continue here.</p></li>
1.148 asau 3604: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3605: directory from the extracted files. Besides these files, a lot of cache
3606: files and other system information has been saved in the working
3607: directory, which may become wrong after you edited the
3608: <code class="filename">Makefile</code>.</p></li>
1.148 asau 3609: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3610: 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 3611: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3612: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3613: everything works.</p></li>
1.148 asau 3614: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3615: contains a list of the files that are installed by the package, is
1.110 hubertf 3616: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3617: >PLIST</strong></span> to generate a probably correct list. Check
3618: the file using your preferred text editor to see if the list of
3619: files looks plausible.</p></li>
1.148 asau 3620: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3621: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3622: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3623: has been registered in the database of installed files, but with an
1.110 hubertf 3624: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3625: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3626: registered with the list of files from
3627: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3628: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3629: package from the set of installed files.</p></li>
1.77 rillig 3630: </ol></div>
1.148 asau 3631: <div class="sect1">
1.91 rillig 3632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3633: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3634: <div class="sect2">
1.91 rillig 3635: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3636: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3637: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3638: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3639: </div>
1.148 asau 3640: <div class="sect2">
1.91 rillig 3641: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 3642: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3643: <p>KDE3 applications should always include
1.91 rillig 3644: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174 asau 3645: settings that are typical of KDE3 packages.</p>
1.91 rillig 3646: </div>
1.148 asau 3647: <div class="sect2">
1.118 imil 3648: <div class="titlepage"><div><div><h3 class="title">
3649: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3650: <p>Python modules and programs packages are easily created using a
3651: set of predefined variables.</p>
3652: <p>
1.171 wiz 3653: If some Python versions are not supported by the software, set the
3654: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3655: that are not supported, e.g.
1.118 imil 3656: </p>
3657: <pre class="programlisting">
1.172 wiz 3658: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.118 imil 3659: </pre>
3660: <p>
3661: If the packaged software is a Python module, include
1.128 wiz 3662: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3663: In this case, the package directory should be called
1.128 wiz 3664: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3665: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3666: </p>
3667: <pre class="programlisting">
3668: DISTNAME= foopymodule-1.2.10
3669: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3670: </pre>
1.171 wiz 3671: <p>If it is an application, include
3672: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3673: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3674: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3675: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3676: For example:
1.118 imil 3677: </p>
3678: <pre class="programlisting">
1.142 wiz 3679: REPLACE_PYTHON= *.py
1.118 imil 3680: </pre>
1.171 wiz 3681: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3682: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3683: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3684: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3685: so pkgsrc will use this framework.
3686: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3687: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3688: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3689: to the name of the script.</p>
3690: <p>Otherwise, if the packaged software is egg-aware, you only need
3691: to include
3692: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3693: <p>Some Python modules have separate distributions for Python-2.x
3694: and Python-3.x support. In pkgsrc this is handled by the
3695: <code class="filename">versioned_dependencies.mk</code> file. Set
3696: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3697: packages that should be depended upon and include
3698: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3699: then the pkgsrc infrastructure will depend on the appropriate package
3700: version. For example:
3701: </p>
3702: <pre class="programlisting">
3703: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3704: </pre>
3705: <p>
3706: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3707: of supported packages.</p>
1.118 imil 3708: </div>
1.91 rillig 3709: </div>
1.148 asau 3710: <div class="sect1">
1.91 rillig 3711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3712: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3713: <div class="sect2">
1.91 rillig 3714: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3715: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3716: <div class="sect3">
1.91 rillig 3717: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3718: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3719: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3720: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3721: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3722: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3723: <pre class="programlisting">
1.100 rillig 3724: <code class="prompt">$</code> mkdir www/nvu
3725: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3726: </pre>
3727: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3728: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3729: <pre class="programlisting">
1.100 rillig 3730: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3731: </pre>
3732: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3733: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3734: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3735: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3736: <code class="varname">COMMENT</code> fields. Then the package
3737: <code class="filename">Makefile</code> looked like that:</p>
3738: <pre class="programlisting">
1.100 rillig 3739: # $NetBSD$
3740: #
1.91 rillig 3741:
1.100 rillig 3742: DISTNAME= nvu-1.0-sources
3743: PKGNAME= nvu-1.0
3744: CATEGORIES= www
3745: MASTER_SITES= http://cvs.nvu.com/download/
3746: EXTRACT_SUFX= .tar.bz2
3747:
3748: MAINTAINER= rillig@NetBSD.org
3749: HOMEPAGE= http://cvs.nvu.com/
3750: COMMENT= Web Authoring System
1.91 rillig 3751:
1.100 rillig 3752: # url2pkg-marker (please do not remove this line.)
3753: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3754: </pre>
3755: <p>Then, I quit the editor and watched pkgsrc downloading a large
3756: source archive:</p>
3757: <pre class="programlisting">
1.100 rillig 3758: url2pkg> Running "make makesum" ...
3759: => Required installed package digest>=20010302: digest-20060826 found
3760: => Fetching nvu-1.0-sources.tar.bz2
3761: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3762: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3763: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3764: url2pkg> Running "make extract" ...
3765: => Required installed package digest>=20010302: digest-20060826 found
3766: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3767: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3768: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3769: ===> Installing dependencies for nvu-1.0
3770: ===> Overriding tools for nvu-1.0
3771: ===> Extracting for nvu-1.0
3772: url2pkg> Adjusting the Makefile.
1.91 rillig 3773:
1.100 rillig 3774: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3775:
1.100 rillig 3776: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3777: </pre>
3778: </div>
1.148 asau 3779: <div class="sect3">
1.91 rillig 3780: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3781: <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 3782: <p>Now that the package has been extracted, let's see what's inside
3783: it. The package has a <code class="filename">README.txt</code>, but that only
3784: says something about mozilla, so it's probably useless for seeing what
3785: dependencies this package has. But since there is a GNU configure script
3786: in the package, let's hope that it will complain about everything it
3787: needs.</p>
3788: <pre class="programlisting">
1.100 rillig 3789: <code class="prompt">$</code> bmake
3790: => Required installed package digest>=20010302: digest-20060826 found
3791: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3792: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3793: ===> Patching for nvu-1.0
3794: ===> Creating toolchain wrappers for nvu-1.0
3795: ===> Configuring for nvu-1.0
3796: [...]
3797: configure: error: Perl 5.004 or higher is required.
3798: [...]
3799: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3800: [...]
1.91 rillig 3801: </pre>
3802: <p>That worked quite well. So I opened the package Makefile in my
3803: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3804: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3805: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3806: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3807: from scratch.</p>
3808: <pre class="programlisting">
1.100 rillig 3809: <code class="prompt">$</code> bmake clean
3810: ===> Cleaning for nvu-1.0
3811: <code class="prompt">$</code> bmake
3812: [...]
3813: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3814: GNU Make. You will not be able to build Mozilla without GNU Make.
3815: [...]
1.91 rillig 3816: </pre>
1.128 wiz 3817: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3818: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3819: <pre class="programlisting">
1.100 rillig 3820: [...]
3821: checking for GTK - version >= 1.2.0... no
3822: *** Could not run GTK test program, checking why...
3823: [...]
1.91 rillig 3824: </pre>
3825: <p>Now to the other dependencies. The first question is: Where is the
3826: GTK package hidden in pkgsrc?</p>
3827: <pre class="programlisting">
1.100 rillig 3828: <code class="prompt">$</code> echo ../../*/gtk*
3829: [many packages ...]
3830: <code class="prompt">$</code> echo ../../*/gtk
3831: ../../x11/gtk
3832: <code class="prompt">$</code> echo ../../*/gtk2
3833: ../../x11/gtk2
3834: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3835: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3836: </pre>
3837: <p>The first try was definitely too broad. The second one had exactly
3838: one result, which is very good. But there is one pitfall with GNOME
3839: packages. Before GNOME 2 had been released, there were already many
3840: GNOME 1 packages in pkgsrc. To be able to continue to use these
3841: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3842: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3843: whether this was the case here, and indeed it was.</p>
3844: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3845: file, adding the dependency is very easy. I just inserted an
3846: <code class="literal">.include</code> line before the last line of the package
3847: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3848: <pre class="programlisting">
1.100 rillig 3849: [...]
3850: .include "../../x11/gtk2/buildlink3.mk"
3851: .include "../../mk/bsd.pkg.mk
1.91 rillig 3852: </pre>
1.110 hubertf 3853: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3854: was:</p>
3855: <pre class="programlisting">
1.100 rillig 3856: [...]
3857: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3858: checking for GTK - version >= 1.2.0... no
3859: *** Could not run GTK test program, checking why...
3860: *** The test program failed to compile or link. See the file config.log for the
3861: *** exact error that occured. This usually means GTK was incorrectly installed
3862: *** or that you have moved GTK since it was installed. In the latter case, you
3863: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3864: configure: error: Test for GTK failed.
3865: [...]
1.91 rillig 3866: </pre>
1.128 wiz 3867: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3868: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3869: told me that this package really wanted to have the GNOME 1 version of
3870: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3871: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3872: So I changed the <code class="literal">x11/gtk2</code> to
3873: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3874: and tried again.</p>
3875: <pre class="programlisting">
1.100 rillig 3876: [...]
1.166 jnemeth 3877: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3878: In file included from xpidl.c:42:
3879: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3880: In file included from xpidl.c:42:
3881: xpidl.h:132: error: parse error before "IDL_ns"
3882: [...]
1.91 rillig 3883: </pre>
3884: <p>The package still does not find all of its dependencies. Now the
3885: question is: Which package provides the
3886: <code class="filename">libIDL/IDL.h</code> header file?</p>
3887: <pre class="programlisting">
1.100 rillig 3888: <code class="prompt">$</code> echo ../../*/*idl*
3889: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3890: <code class="prompt">$</code> echo ../../*/*IDL*
3891: ../../net/libIDL
1.91 rillig 3892: </pre>
3893: <p>Let's take the one from the second try. So I included the
3894: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3895: again. But the error didn't change. After digging through some of the
3896: code, I concluded that the build process of the package was broken and
3897: couldn't have ever worked, but since the Mozilla source tree is quite
3898: large, I didn't want to fix it. So I added the following to the package
3899: <code class="filename">Makefile</code> and tried again:</p>
3900: <pre class="programlisting">
1.100 rillig 3901: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3902: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 3903: </pre>
3904: <p>The latter line is needed because the package expects the library
3905: <code class="filename">libIDL.so</code>, but only
3906: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3907: wrapper to rewrite that on the fly.</p>
3908: <p>The next problem was related to a recent change of the FreeType
1.189 snj 3909: 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 3910: which patch files were relevant for this issue and copied them to the
3911: <code class="filename">patches</code> directory. Then I retried, fixed the
3912: patches so that they applied cleanly and retried again. This time,
3913: everything worked.</p>
3914: </div>
1.148 asau 3915: <div class="sect3">
1.91 rillig 3916: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3917: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3918: <pre class="programlisting">
1.100 rillig 3919: <code class="prompt">$</code> bmake CHECK_FILES=no install
3920: [...]
3921: <code class="prompt">$</code> bmake print-PLIST >PLIST
3922: <code class="prompt">$</code> bmake deinstall
3923: <code class="prompt">$</code> bmake install
1.91 rillig 3924: </pre>
3925: </div>
3926: </div>
3927: </div>
1.77 rillig 3928: </div>
1.148 asau 3929: <div class="chapter">
1.75 rillig 3930: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3931: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3932: <div class="toc">
3933: <p><b>Table of Contents</b></p>
1.195 wiz 3934: <dl class="toc">
1.128 wiz 3935: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3936: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3937: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3938: <dd><dl>
3939: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3940: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3941: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3942: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3943: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3944: </dl></dd>
3945: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3946: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3947: <dd><dl>
3948: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3949: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3950: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3951: </dl></dd>
1.128 wiz 3952: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3953: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 3954: </dl>
3955: </div>
1.87 wiz 3956: <p>Whenever you're preparing a package, there are a number of
3957: files involved which are described in the following
3958: sections.</p>
1.148 asau 3959: <div class="sect1">
1.75 rillig 3960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3961: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 3962: </h2></div></div></div>
1.75 rillig 3963: <p>Building, installation and creation of a binary package are all
1.87 wiz 3964: controlled by the package's <code class="filename">Makefile</code>.
3965: The <code class="filename">Makefile</code> describes various things about
3966: a package, for example from where to get it, how to configure,
3967: build, and install it.</p>
1.76 rillig 3968: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3969: sections that describe the package.</p>
1.75 rillig 3970: <p>In the first section there are the following variables, which
1.87 wiz 3971: should appear exactly in the order given here. The order and
3972: grouping of the variables is mostly historical and has no further
3973: meaning.</p>
1.148 asau 3974: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3975: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3976: distribution file to be downloaded from the package's
3977: website.</p></li>
1.128 wiz 3978: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3979: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3980: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 3981: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3982: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 3983: directory name together with the version number. It must match the
3984: regular expression
3985: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3986: starts with a letter or digit, and contains only letters, digits,
3987: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 3988: <li class="listitem">
1.75 rillig 3989: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 3990: which the package fits in. You can choose any of the top-level
3991: directories of pkgsrc for it.</p>
1.75 rillig 3992: <p>Currently the following values are available for
1.87 wiz 3993: <code class="varname">CATEGORIES</code>. If more than
3994: one is used, they need to be separated by spaces:</p>
1.75 rillig 3995: <pre class="programlisting">
1.100 rillig 3996: archivers cross geography meta-pkgs security
3997: audio databases graphics misc shells
3998: benchmarks devel ham multimedia sysutils
3999: biology editors inputmethod net textproc
4000: cad emulators lang news time
4001: chat finance mail parallel wm
4002: comms fonts math pkgtools www
4003: converters games mbone print x11
4004: </pre>
1.75 rillig 4005: </li>
1.128 wiz 4006: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4007: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4008: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4009: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4010: <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 4011: </ul></div>
4012: <p>The second section contains information about separately
1.87 wiz 4013: downloaded patches, if any.
4014: </p>
1.148 asau 4015: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190 wiz 4016: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87 wiz 4017: Name(s) of additional files that contain distribution patches.
4018: There is no default. pkgsrc will look for them at
4019: <code class="varname">PATCH_SITES</code>.
4020: They will automatically be uncompressed before patching if
4021: the names end with <code class="filename">.gz</code> or
4022: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4023: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4024: Primary location(s) for distribution patch files (see
1.190 wiz 4025: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
4026: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
4027: 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
4028: help find the correct files to patch. It defaults to
4029: <span class="command"><strong>-p0</strong></span>.</p></li>
1.75 rillig 4030: </ul></div>
4031: <p>The third section contains the following variables.
1.87 wiz 4032: </p>
1.148 asau 4033: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4034: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4035: address of the person who feels responsible for this package,
4036: and who is most likely to look at problems or questions regarding
1.189 snj 4037: 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 4038: Other developers may contact the <code class="varname">MAINTAINER</code>
4039: before making changes to the package, but are not required to
4040: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4041: to yourself. If you really can't maintain the package for future
4042: updates, set it to
1.110 hubertf 4043: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4044: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4045: of <code class="varname">MAINTAINER</code> when you do not want other
4046: developers to update or change the package without contacting
4047: you first. A package Makefile should contain one of
4048: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4049: not both. </p></li>
1.128 wiz 4050: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4051: find more information about the package.</p></li>
1.128 wiz 4052: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4053: description of the package (should not include the package
4054: name).</p></li>
1.75 rillig 4055: </ul></div>
4056: <p>Other variables that affect the build:
1.87 wiz 4057: </p>
1.148 asau 4058: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4059: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4060: interesting distribution files of the package are found. The
4061: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4062: works for most packages.</p>
1.75 rillig 4063: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4064: (most GNU software does, for instance), but extracts itself in
4065: the current directory, you should set
4066: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4067: <p>If a package doesn't create a subdirectory with the
4068: name of <code class="varname">DISTNAME</code> but some different name,
4069: set <code class="varname">WRKSRC</code> to point to the proper name in
4070: <code class="filename">${WRKDIR}</code>, for example
4071: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.189 snj 4072: <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 4073: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4074: taken from the <code class="varname">WRKDIR_BASENAME</code>
4075: variable. By default, its value is
4076: <code class="filename">work</code>. If you want to use the same
4077: pkgsrc tree for building different kinds of binary packages,
4078: you can change the variable according to your needs. Two
4079: other variables handle common cases of setting
4080: <code class="varname">WRKDIR_BASENAME</code> individually. If
4081: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4082: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4083: the host's name is attached to the directory name. If
4084: <code class="varname">OBJMACHINE</code> is defined, the platform name
4085: is attached, which might look like
4086: <code class="filename">work.i386</code> or
4087: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4088: </li></ul></div>
4089: <p>Please pay attention to the following gotchas:</p>
1.148 asau 4090: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4091: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4092: installed in compressed form by the package. For packages using
4093: BSD-style makefiles which honor MANZ, there is
4094: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4095: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4096: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4097: below).</p></li>
1.128 wiz 4098: <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 4099: </ul></div>
4100: </div>
1.148 asau 4101: <div class="sect1">
1.75 rillig 4102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4103: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4104: </h2></div></div></div>
1.76 rillig 4105: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4106: digest, or checksum, of each distfile needed for the package. This
4107: ensures that the distfiles retrieved from the Internet have not been
4108: corrupted during transfer or altered by a malign force to introduce
4109: a security hole. Due to recent rumor about weaknesses of digest
4110: algorithms, all distfiles are protected using both SHA1 and RMD160
4111: message digests, as well as the file size.</p>
1.76 rillig 4112: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4113: checksums for all the patches found in the
1.110 hubertf 4114: <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 4115: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4116: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4117: command.</p>
1.75 rillig 4118: <p>Some packages have different sets of distfiles depending on
1.189 snj 4119: 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 4120: <code class="filename">distinfo</code> file and care should be taken when
4121: upgrading such a package to ensure distfile information is not
4122: lost.</p>
1.75 rillig 4123: </div>
1.148 asau 4124: <div class="sect1">
1.75 rillig 4125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4126: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4127: <p>Many packages still don't work out-of-the box on the various
4128: platforms that are supported by pkgsrc. Therefore, a number of custom
4129: patch files are needed to make the package work. These patch files are
4130: found in the <code class="filename">patches/</code> directory.</p>
4131: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4132: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4133: 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 4134: order</a>.</p>
1.148 asau 4135: <div class="sect2">
1.93 rillig 4136: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4137: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4138: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4139: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4140: problems. (To force patches to apply with fuzz you can set
4141: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4142: should contain only changes for a single file, and no file should be
1.93 rillig 4143: patched by more than one patch file. This helps to keep future
4144: modifications simple.</p>
4145: <p>Each patch file is structured as follows: In the first line,
4146: there is the RCS Id of the patch itself. The second line should be
4147: empty for aesthetic reasons. After that, there should be a comment for
4148: each change that the patch does. There are a number of standard
4149: cases:</p>
1.148 asau 4150: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4151: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4152: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4153: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4154: platform and other environment (for example, the compiler) that the
4155: patch is needed for.</p></li>
4156: </ul></div>
1.130 wiz 4157: <p>In all, the patch should be commented so that any
1.93 rillig 4158: developer who knows the code of the application can make some use of
4159: the patch. Special care should be taken for the upstream developers,
4160: since we generally want that they accept our patches, so we have less
4161: work in the future.</p>
4162: </div>
1.148 asau 4163: <div class="sect2">
1.93 rillig 4164: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4165: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4166: <p>One important thing to mention is to pay attention that no RCS
4167: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4168: later checked into the NetBSD CVS tree. Use the
1.189 snj 4169: <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 4170: problems.</p>
1.87 wiz 4171: <p>For even more automation, we recommend using
1.110 hubertf 4172: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4173: whole set of patches. You just have to backup files before you
4174: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4175: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4176: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4177: you upgrade a package this way, you can easily compare the new
4178: set of patches with the previously existing one with
1.130 wiz 4179: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4180: are replaced by new files, so carefully check if you want to take all
4181: the changes.</p>
1.87 wiz 4182: <p>When you have finished a package, remember to generate
1.110 hubertf 4183: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4184: 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 4185: <p>When adding a patch that corrects a problem in the
4186: distfile (rather than e.g. enforcing pkgsrc's view of where
4187: man pages should go), send the patch as a bug report to the
4188: maintainer. This benefits non-pkgsrc users of the package,
4189: and usually makes it possible to remove the patch in future
4190: version.</p>
1.101 rillig 4191: <p>The file names of the patch files are usually of the form
1.130 wiz 4192: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4193: Many packages still use the previous convention
4194: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4195: but new patches should be of the form containing the filename.
1.189 snj 4196: <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 4197: automatically.</p>
1.93 rillig 4198: </div>
1.148 asau 4199: <div class="sect2">
1.93 rillig 4200: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4201: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4202: <p>If you want to share patches between multiple packages
4203: in pkgsrc, e.g. because they use the same distfiles, set
4204: <code class="varname">PATCHDIR</code> to the path where the patch files
4205: can be found, e.g.:</p>
4206: <pre class="programlisting">
1.100 rillig 4207: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4208: </pre>
1.75 rillig 4209: <p>Patch files that are distributed by the author or other
1.87 wiz 4210: maintainers can be listed in
4211: <code class="varname">PATCHFILES</code>.</p>
4212: <p>If it is desired to store any patches that should not be
4213: committed into pkgsrc, they can be kept outside the pkgsrc
4214: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4215: directory tree there is expected to have the same
1.128 wiz 4216: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4217: patches are expected to be stored inside these dirs (also
4218: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4219: example, if you want to keep a private patch for
4220: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4221: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4222: files in the named directory are expected to be patch files,
4223: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4224: applied</em></span>.</p>
1.93 rillig 4225: </div>
1.148 asau 4226: <div class="sect2">
1.85 jmmv 4227: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4228: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4229: <p>When fixing a portability issue in the code do not use
4230: preprocessor magic to check for the current operating system nor
4231: platform. Doing so hurts portability to other platforms because
4232: the OS-specific details are not abstracted appropriately.</p>
4233: <p>The general rule to follow is: instead of checking for the
4234: operating system the application is being built on, check for the
4235: specific <span class="emphasis"><em>features</em></span> you need. For example,
4236: instead of assuming that kqueue is available under NetBSD and
4237: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4238: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4239: yes, this generally involves patching the
1.110 hubertf 4240: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4241: that prevents some OSes from adopting interfaces from other OSes
4242: (e.g. Linux implementing kqueue), something that the above checks
4243: cannot take into account.</p>
4244: <p>Of course, checking for features generally involves more
4245: work on the developer's side, but the resulting changes are
1.87 wiz 4246: cleaner and there are chances they will work on many other
1.85 jmmv 4247: platforms. Not to mention that there are higher chances of being
4248: later integrated into the mainstream sources. Remember:
4249: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4250: <p>Some typical examples:</p>
4251: <div class="table">
1.106 rillig 4252: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4253: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4254: <colgroup>
4255: <col>
4256: <col>
4257: <col>
4258: </colgroup>
4259: <thead><tr>
4260: <th>Where</th>
4261: <th>Incorrect</th>
4262: <th>Correct</th>
4263: </tr></thead>
4264: <tbody>
4265: <tr>
4266: <td>configure script</td>
4267: <td>
1.100 rillig 4268: <pre class="programlisting">
4269: case ${target_os} in
4270: netbsd*) have_kvm=yes ;;
4271: *) have_kvm=no ;;
4272: esac
4273: </pre>
1.85 jmmv 4274: </td>
4275: <td>
1.100 rillig 4276: <pre class="programlisting">
4277: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4278: </pre>
1.85 jmmv 4279: </td>
4280: </tr>
4281: <tr>
4282: <td>C source file</td>
4283: <td>
1.100 rillig 4284: <pre class="programlisting">
4285: #if defined(__NetBSD__)
4286: # include <sys/event.h>
4287: #endif
4288: </pre>
1.85 jmmv 4289: </td>
4290: <td>
1.100 rillig 4291: <pre class="programlisting">
4292: #if defined(HAVE_SYS_EVENT_H)
4293: # include <sys/event.h>
4294: #endif
4295: </pre>
1.85 jmmv 4296: </td>
4297: </tr>
4298: <tr>
4299: <td>C source file</td>
4300: <td>
1.100 rillig 4301: <pre class="programlisting">
4302: int
4303: monitor_file(...)
4304: {
4305: #if defined(__NetBSD__)
4306: int fd = kqueue();
4307: ...
4308: #else
4309: ...
4310: #endif
4311: }
4312: </pre>
1.85 jmmv 4313: </td>
4314: <td>
1.100 rillig 4315: <pre class="programlisting">
4316: int
4317: monitor_file(...)
4318: {
4319: #if defined(HAVE_KQUEUE)
4320: int fd = kqueue();
4321: ...
4322: #else
4323: ...
4324: #endif
4325: }
4326: </pre>
1.85 jmmv 4327: </td>
4328: </tr>
4329: </tbody>
1.91 rillig 4330: </table></div>
1.85 jmmv 4331: </div>
1.91 rillig 4332: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4333: 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
4334: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4335: 2</a>). It summarizes multiple details on how to make
4336: software easier to package; all the suggestions in it were
4337: collected from our experience in pkgsrc work, so they are possibly
4338: helpful when creating patches too.</p>
4339: </div>
1.148 asau 4340: <div class="sect2">
1.85 jmmv 4341: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4342: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4343: <p>Always, always, <span class="strong"><strong>always</strong></span>
4344: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4345: improvements you do to a package to the mainstream developers.
4346: This is the only way to get their attention on portability issues
4347: and to ensure that future versions can be built out-of-the box on
4348: NetBSD. Furthermore, any user that gets newer distfiles will get
4349: the fixes straight from the packaged code.</p>
1.93 rillig 4350: <p>This generally involves cleaning up the patches
4351: (because sometimes the patches that are
1.147 wiz 4352: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4353: appropriate trackers for the projects and working with the
4354: mainstream authors to accept your changes. It is
4355: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4356: the packages in pkgsrc are kept simple and thus further changes
4357: can be done without much hassle.</p>
1.130 wiz 4358: <p>When you have done this, please add a URL to the upstream
4359: bug report to the patch comment.</p>
1.85 jmmv 4360: <p>Support the idea of free software!</p>
4361: </div>
1.75 rillig 4362: </div>
1.148 asau 4363: <div class="sect1">
1.75 rillig 4364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4365: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 4366: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4367: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4368: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4369: any credits where they are due. Please bear in mind that others do not
4370: share your sense of humour (or spelling idiosyncrasies), and that others
4371: will read everything that you write here.</p></dd>
1.76 rillig 4372: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4373: <dd><p>This file governs the files that are installed on your
4374: system: all the binaries, manual pages, etc. There are other
4375: directives which may be entered in this file, to control the
4376: creation and deletion of directories, and the location of
1.110 hubertf 4377: 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 4378: information.</p></dd>
1.75 rillig 4379: </dl></div>
4380: </div>
1.148 asau 4381: <div class="sect1">
1.75 rillig 4382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4383: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 4384: <div class="sect2">
1.78 rillig 4385: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4386: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 4387: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4388: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4389: <dd>
1.189 snj 4390: <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 4391: First time after package extraction and before files are
4392: moved in place, the second time after the files to install
4393: are moved in place. This can be used to do any custom
4394: procedures not possible with @exec commands in
1.189 snj 4395: <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
4396: <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 4397: Please note that you can modify variables in it easily by using
4398: <code class="varname">FILES_SUBST</code> in the package's
4399: <code class="filename">Makefile</code>:</p>
4400: <pre class="programlisting">
4401: FILES_SUBST+= SOMEVAR="somevalue"
4402: </pre>
4403: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4404: <code class="filename">INSTALL</code>. By default, substitution is
4405: performed for <code class="varname">PREFIX</code>,
4406: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4407: <code class="varname">VARBASE</code>, and a few others, type
4408: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4409: complete list.</p>
4410: </dd>
1.76 rillig 4411: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4412: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4413: this script's responsibility to clean up any additional messy details
4414: around the package's installation, since all pkg_delete knows is how to
4415: delete the files created in the original distribution.
1.189 snj 4416: 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>
4417: 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 4418: The same methods to replace variables can be used as for
4419: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4420: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4421: <dd>
4422: <p>This file is displayed after installation of the package.
1.87 wiz 4423: Useful for things like legal notices on almost-free
4424: software and hints for updating config files after
4425: installing modules for apache, PHP etc.
4426: Please note that you can modify variables in it easily by using
4427: <code class="varname">MESSAGE_SUBST</code> in the package's
4428: <code class="filename">Makefile</code>:</p>
1.75 rillig 4429: <pre class="programlisting">
1.100 rillig 4430: MESSAGE_SUBST+= SOMEVAR="somevalue"
4431: </pre>
1.128 wiz 4432: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4433: <code class="filename">MESSAGE</code>. By default, substitution is
4434: performed for <code class="varname">PKGNAME</code>,
4435: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4436: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4437: <code class="varname">X11BASE</code>,
4438: <code class="varname">PKG_SYSCONFDIR</code>,
4439: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4440: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4441: <p>You can display a different or additional files by
4442: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4443: default is <code class="filename">MESSAGE</code>, if the file
4444: exists.</p>
1.75 rillig 4445: </dd>
1.78 rillig 4446: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 4447: <dd>
4448: <p>This file is used by the alternatives framework.
4449: It creates, configures, and destroys generic wrappers used to
4450: run programs with similar interfaces.
4451: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4452: for more information.</p>
4453: <p>Each line of the file contains two filenames, first
4454: the wrapper and then the alternative provided by the package.
4455: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4456: </dd>
1.78 rillig 4457: </dl></div>
4458: </div>
1.148 asau 4459: <div class="sect2">
1.78 rillig 4460: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4461: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4462: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4463: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4464: <dd><p>This file contains arbitrary things that could
4465: also go into a <code class="filename">Makefile</code>, but its purpose is
4466: to be used by more than one package. This file should only be
4467: used when the packages that will use the file are known in
4468: advance. For other purposes it is often better to write a
4469: <code class="filename">*.mk</code> file and give it a good name that
4470: describes what it does.</p></dd>
4471: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4472: <dd><p>This file contains the dependency information
1.110 hubertf 4473: 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 4474: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4475: <dd><p>This file contains workarounds for compiler bugs
4476: and similar things. It is included automatically by the pkgsrc
4477: infrastructure, so you don't need an extra
4478: <code class="literal">.include</code> line for
4479: it.</p></dd>
4480: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4481: <dd><p>This file contains the code for the
1.110 hubertf 4482: 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 4483: selected by the user. If a package has only one or two options,
4484: it is equally acceptable to put the code directly into the
4485: <code class="filename">Makefile</code>.</p></dd>
4486: </dl></div>
4487: </div>
1.148 asau 4488: <div class="sect2">
1.78 rillig 4489: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4490: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4491: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4492: <dt><span class="term"><code class="filename">README*</code></span></dt>
4493: <dd><p>These files do not take place in the creation of
4494: a package and thus are purely informative to the package
4495: developer.</p></dd>
4496: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4497: <dd><p>This file contains things that need to be done
4498: to make the package even
4499: better.</p></dd>
1.75 rillig 4500: </dl></div>
4501: </div>
1.78 rillig 4502: </div>
1.148 asau 4503: <div class="sect1">
1.75 rillig 4504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4505: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4506: </h2></div></div></div>
1.110 hubertf 4507: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4508: unpacked into the directory denoted by
4509: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4510: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4511: directory is also used to keep various timestamp files.
4512: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4513: The default is <code class="filename">${.CURDIR}/work</code>
4514: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4515: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4516: </div>
1.148 asau 4517: <div class="sect1">
1.75 rillig 4518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4519: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4520: </h2></div></div></div>
1.75 rillig 4521: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4522: to configuration or building, you could place these files here and use
1.110 hubertf 4523: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4524: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4525: this. Alternatively, you could simply diff the file against
4526: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4527: the creation of this file.</p>
4528: <p>If you want to share files in this way with other
4529: packages, set the <code class="varname">FILESDIR</code> variable to point
4530: to the other package's <code class="filename">files</code> directory,
4531: e.g.:</p>
4532: <pre class="programlisting">
1.100 rillig 4533: FILESDIR=${.CURDIR}/../xemacs/files
4534: </pre>
1.75 rillig 4535: </div>
4536: </div>
1.148 asau 4537: <div class="chapter">
1.75 rillig 4538: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4539: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4540: <div class="toc">
4541: <p><b>Table of Contents</b></p>
1.195 wiz 4542: <dl class="toc">
1.106 rillig 4543: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4544: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4545: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4546: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4547: <dd><dl>
4548: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4549: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4550: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4551: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4552: <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 4553: </dl></dd>
4554: </dl>
4555: </div>
1.76 rillig 4556: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4557: each of which forms a well-defined part of the pkgsrc system. Using
1.189 snj 4558: 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 4559: like pkgsrc requires some discipline to keep the code correct and
4560: understandable.</p>
1.76 rillig 4561: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4562: programming are variables (which are actually macros) and shell
4563: commands. Among these shell commands may even be more complex ones
1.189 snj 4564: 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 4565: as intended it is necessary to quote all variables correctly when they
4566: are used.</p>
4567: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4568: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4569: with them.</p>
1.148 asau 4570: <div class="sect1">
1.75 rillig 4571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4572: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4573: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4574: <p>When you are creating a file as a
4575: target of a rule, always write the data to a temporary file first
4576: and finally rename that file. Otherwise there might occur an error
4577: in the middle of generating the file, and when the user runs
1.189 snj 4578: <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 4579: regenerated properly. Example:</p>
4580: <pre class="programlisting">
1.100 rillig 4581: wrong:
4582: @echo "line 1" > ${.TARGET}
4583: @echo "line 2" >> ${.TARGET}
4584: @false
4585:
4586: correct:
4587: @echo "line 1" > ${.TARGET}.tmp
4588: @echo "line 2" >> ${.TARGET}.tmp
4589: @false
4590: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4591: </pre>
1.110 hubertf 4592: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4593: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4594: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4595: correct</strong></span> gives an error message twice, as expected.</p>
1.189 snj 4596: <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 4597: <code class="literal">${.TARGET}</code> in case of error, but this only
4598: happens when it is interrupted, for example by pressing
4599: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.189 snj 4600: 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 4601: </li></ul></div>
4602: </div>
1.148 asau 4603: <div class="sect1">
1.97 rillig 4604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4605: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4606: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4607: can be processed using the five operators ``='', ``+='', ``?='',
1.189 snj 4608: ``:='', 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 4609: page.</p>
4610: <p>When a variable's value is parsed from a
1.76 rillig 4611: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4612: backslash character ``\'' are handled specially. If a backslash is
4613: followed by a newline, any whitespace immediately in front of the
4614: backslash, the backslash, the newline, and any whitespace
4615: immediately behind the newline are replaced with a single space. A
4616: backslash character and an immediately following hash character are
4617: replaced with a single hash character. Otherwise, the backslash is
4618: passed as is. In a variable assignment, any hash character that is
4619: not preceded by a backslash starts a comment that continues upto the
4620: end of the logical line.</p>
4621: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4622: the only way to create a variable consisting of a single backslash
4623: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4624: <p>So far for defining variables. The other thing you can do with
4625: variables is evaluating them. A variable is evaluated when it is
4626: part of the right side of the ``:='' or the ``!='' operator, or
4627: directly before executing a shell command which the variable is part
1.189 snj 4628: 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 4629: is, variables are not evaluated until there's no other way. The
4630: ``modifiers'' mentioned in the man page also evaluate the
4631: variable.</p>
4632: <p>Some of the modifiers split the string into words and then
4633: operate on the words, others operate on the string as a whole. When
4634: a string is split into words, it is split as you would expect
1.189 snj 4635: 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 4636: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4637: loop does not follow the shell quoting rules but splits at sequences
4638: of whitespace.</p>
4639: <p>There are several types of variables that should be handled
4640: differently. Strings and two types of lists.</p>
1.148 asau 4641: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4642: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4643: characters. Nevertheless, you should restrict yourself to only
4644: using printable characters. Examples are
4645: <code class="varname">PREFIX</code> and
4646: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4647: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4648: are never exported to any shell command. Their elements are
4649: separated by whitespace. Therefore, the elements themselves cannot
4650: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4651: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4652: Examples are <code class="varname">DEPENDS</code> and
4653: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4654: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4655: may be exported to a shell command. Their elements can contain any
4656: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4657: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4658: <code class="varname">DISTFILES</code> and
4659: <code class="varname">MASTER_SITES</code>.</p></li>
4660: </ul></div>
1.148 asau 4661: <div class="sect2">
1.75 rillig 4662: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4663: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4664: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4665: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4666: are reserved for use by the pkgsrc infrastructure. They shall
4667: not be used by package
1.76 rillig 4668: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4669: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4670: lowercase variable names for the iteration
4671: variables.</p></li>
1.128 wiz 4672: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4673: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4674: <code class="varname">DISTFILES</code>.</p></li>
4675: </ul></div>
4676: </div>
4677: </div>
1.148 asau 4678: <div class="sect1">
1.75 rillig 4679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4680: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4681: <p>This section presents you with some code snippets you should
4682: use in your own code. If you don't find anything appropriate here,
4683: you should test your code and add it here.</p>
1.148 asau 4684: <div class="sect2">
1.75 rillig 4685: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4686: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4687: <pre class="programlisting">
1.100 rillig 4688: STRING= foo * bar `date`
4689: INT_LIST= # empty
4690: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4691: EXT_LIST= # empty
4692: ANOTHER_EXT_LIST= a=b c=d
4693:
4694: INT_LIST+= ${STRING} # 1
4695: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4696: EXT_LIST+= ${STRING:Q} # 3
4697: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4698: </pre>
1.75 rillig 4699: <p>When you add a string to an external list (example 3), it
4700: must be quoted. In all other cases, you must not add a quoting
4701: level. You must not merge internal and external lists, unless you
4702: are sure that all entries are correctly interpreted in both
4703: lists.</p>
4704: </div>
1.148 asau 4705: <div class="sect2">
1.75 rillig 4706: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4707: <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 4708: <pre class="programlisting">
1.100 rillig 4709: EXT_LIST= # empty
4710: .for i in ${INT_LIST}
4711: EXT_LIST+= ${i:Q}""
4712: .endfor
1.1 grant 4713: </pre>
1.75 rillig 4714: <p>This code converts the internal list
4715: <code class="varname">INT_LIST</code> into the external list
4716: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4717: are unquoted they must be quoted here. The reason for appending
4718: <code class="varname">""</code> is explained below.</p>
4719: </div>
1.148 asau 4720: <div class="sect2">
1.75 rillig 4721: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4722: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4723: <p>Sometimes you may want to print an arbitrary string. There
4724: are many ways to get it wrong and only few that can handle every
4725: nastiness.</p>
1.75 rillig 4726: <pre class="programlisting">
1.100 rillig 4727: STRING= foo bar < > * `date` $$HOME ' "
4728: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4729:
1.100 rillig 4730: all:
4731: echo ${STRING} # 1
4732: echo "${STRING}" # 2
4733: echo "${STRING:Q}" # 3
4734: echo ${STRING:Q} # 4
4735: echo x${STRING:Q} | sed 1s,.,, # 5
4736: printf "%s\\n" ${STRING:Q}"" # 6
4737: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4738: </pre>
1.75 rillig 4739: <p>Example 1 leads to a syntax error in the shell, as the
4740: characters are just copied.</p>
4741: <p>Example 2 leads to a syntax error too, and if you leave out
4742: the last " character from <code class="varname">${STRING}</code>,
1.189 snj 4743: <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 4744: variable would be evaluated, too.</p>
4745: <p>Example 3 outputs each space character preceded by a
4746: backslash (or not), depending on the implementation of the
1.189 snj 4747: <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 4748: <p>Example 4 handles correctly every string that does not start
4749: with a dash. In that case, the result depends on the
1.189 snj 4750: 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 4751: guarantee that your input does not start with a dash, this form is
4752: appropriate.</p>
4753: <p>Example 5 handles even the case of a leading dash
4754: correctly.</p>
1.79 rillig 4755: <p>Example 6 also works with every string and is the
4756: light-weight solution, since it does not involve a pipe, which has
4757: its own problems.</p>
1.75 rillig 4758: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4759: because the quoting has already been done when adding elements to
4760: the list.</p>
4761: <p>As internal lists shall not be passed to the shell, there is
4762: no example for it.</p>
4763: </div>
1.148 asau 4764: <div class="sect2">
1.75 rillig 4765: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4766: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4767: <p>There are many possible sources of wrongly quoted variables.
4768: This section lists some of the commonly known ones.</p>
1.148 asau 4769: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4770: <li class="listitem">
1.75 rillig 4771: <p>Whenever you use the value of a list, think
4772: about what happens to leading or trailing whitespace. If the
4773: list is a well-formed shell expression, you can apply the
4774: <code class="varname">:M*</code> modifier to strip leading and trailing
4775: whitespace from each word. The <code class="varname">:M</code> operator
4776: first splits its argument according to the rules of the shell,
4777: and then creates a new list consisting of all words that match
4778: the shell glob expression <code class="varname">*</code>, that is: all.
4779: One class of situations where this is needed is when adding a
4780: variable like <code class="varname">CPPFLAGS</code> to
4781: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4782: invokes other configure scripts, it strips the leading and
4783: trailing whitespace from the variable and then passes it to the
4784: other configure scripts. But these configure scripts expect the
4785: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4786: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4787: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4788: here is how we do it:</p>
4789: <pre class="programlisting">
1.100 rillig 4790: CPPFLAGS= # empty
4791: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4792: CPPFLAGS+= ${MY_CPPFLAGS}
4793:
4794: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4795:
4796: all:
4797: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4798: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4799: </pre>
1.75 rillig 4800: </li>
1.128 wiz 4801: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 4802: <code class="varname">${PREFIX}</code> is a properly quoted shell
4803: expression, but there is the C compiler after it, which also
4804: expects a properly quoted string (this time in C syntax). The
4805: version above is therefore only correct if
4806: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4807: or double quotes. If you want to allow these, you have to add
4808: another layer of quoting to each variable that is used as a C
4809: string literal. You cannot use the <code class="varname">:Q</code>
4810: operator for it, as this operator only works for the
4811: shell.</p></li>
1.128 wiz 4812: <li class="listitem">
1.75 rillig 4813: <p>Whenever a variable can be empty, the
4814: <code class="varname">:Q</code> operator can have surprising results. Here
4815: are two completely different cases which can be solved with the
4816: same trick.</p>
4817: <pre class="programlisting">
1.100 rillig 4818: EMPTY= # empty
4819: empty_test:
4820: for i in a ${EMPTY:Q} c; do \
4821: echo "$$i"; \
4822: done
4823:
4824: for_test:
4825: .for i in a:\ a:\test.txt
4826: echo ${i:Q}
4827: echo "foo"
4828: .endfor
1.1 grant 4829: </pre>
1.75 rillig 4830: <p>The first example will only print two of the three lines
4831: we might have expected. This is because
4832: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4833: the shell cannot see. The workaround is to write
4834: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4835: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4836: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4837: <p>The second example will only print three lines instead of
4838: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4839: This is because the backslash of the value
4840: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.189 snj 4841: <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
4842: <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 4843: <code class="varname">${i:Q}""</code>.</p>
4844: </li>
4845: </ul></div>
4846: </div>
1.148 asau 4847: <div class="sect2">
1.75 rillig 4848: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4849: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 4850: <p>The pkgsrc bmake program does not handle the following
4851: assignment correctly. In case <code class="varname">_othervar_</code>
4852: contains a ``-'' character, one of the closing braces is included
4853: in <code class="varname">${VAR}</code> after this code executes.</p>
4854: <pre class="programlisting">
1.100 rillig 4855: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 4856: </pre>
1.75 rillig 4857: <p>For a more complex code snippet and a workaround, see the
1.189 snj 4858: 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 4859: <code class="varname">bug1</code>.</p>
4860: </div>
4861: </div>
4862: </div>
1.148 asau 4863: <div class="chapter">
1.75 rillig 4864: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4865: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4866: <div class="toc">
4867: <p><b>Table of Contents</b></p>
1.195 wiz 4868: <dl class="toc">
1.106 rillig 4869: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4870: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4871: <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 4872: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4873: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4874: <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 4875: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
4876: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 4877: </dl>
4878: </div>
1.87 wiz 4879: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4880: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4881: the package (relative to the <code class="filename">${PREFIX}</code>
4882: directory it's been installed in) plus some additional statements
1.189 snj 4883: - 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 4884: This chapter addresses some issues that need attention when
4885: dealing with the <code class="filename">PLIST</code> file (or files, see
4886: below!).</p>
1.148 asau 4887: <div class="sect1">
1.75 rillig 4888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4889: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4890: <p>Be sure to add a RCS ID line as the first thing in any
4891: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4892: <pre class="programlisting">
1.100 rillig 4893: @comment $NetBSD$
1.87 wiz 4894: </pre>
1.75 rillig 4895: </div>
1.148 asau 4896: <div class="sect1">
1.75 rillig 4897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4898: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4899: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4900: to output a PLIST that matches any new files since the package
1.110 hubertf 4901: 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 4902: more information on this target.</p>
1.75 rillig 4903: </div>
1.148 asau 4904: <div class="sect1">
1.75 rillig 4905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 4906: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4907: </h2></div></div></div>
1.87 wiz 4908: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 4909: <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, “Sharing directories between packages”</a>, you may have noticed that
4910: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 4911: <code class="varname">@comment</code>s instead of real
4912: <code class="varname">@dirrm</code> lines. You can also do this for
4913: specific directories and files, so that the results of that
4914: command are very close to reality. This helps <span class="emphasis"><em>a
4915: lot</em></span> during the update of packages.</p>
4916: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4917: of AWK patterns and actions that are used to filter the output of
4918: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4919: scripting you like to it, but be careful with quoting.</p>
4920: <p>For example, to get all files inside the
4921: <code class="filename">libdata/foo</code> directory removed from the
4922: resulting PLIST:</p>
4923: <pre class="programlisting">
1.100 rillig 4924: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 4925: </pre>
4926: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4927: to a specific (shared) directory converted to
4928: <code class="varname">@comment</code>s:</p>
1.75 rillig 4929: <pre class="programlisting">
1.100 rillig 4930: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 4931: </pre>
1.75 rillig 4932: </div>
1.148 asau 4933: <div class="sect1">
1.75 rillig 4934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4935: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4936: <p>A number of variables are substituted automatically in
4937: PLISTs when a package is installed on a system. This includes the
4938: following variables:</p>
1.148 asau 4939: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4940: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4941: <dd>
4942: <p>Some packages like emacs and perl embed information
1.87 wiz 4943: about which architecture they were built on into the
4944: pathnames where they install their files. To handle this
4945: case, PLIST will be preprocessed before actually used, and
4946: the symbol
1.128 wiz 4947: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4948: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4949: same is done if the string
4950: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4951: PLIST somewhere - use this on packages that have GNU
4952: autoconf-created configure scripts.</p>
1.148 asau 4953: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4954: <h3 class="title">Legacy note</h3>
4955: <p>There used to be a symbol
1.128 wiz 4956: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4957: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4958: -m</strong></span>, but that's no longer supported and has
4959: been removed.</p>
1.75 rillig 4960: </div>
4961: </dd>
4962: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4963: <dd>
4964: <p>Some packages want to embed the OS name and version
1.87 wiz 4965: into some paths. To do this, use these variables in the
4966: <code class="filename">PLIST</code>:
4967: </p>
1.148 asau 4968: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4969: <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>
4970: <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>
4971: <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 4972: </ul></div>
4973: </dd>
4974: </dl></div>
1.87 wiz 4975: <p>For a complete list of values which are replaced by
4976: default, please look in <code class="filename">bsd.pkg.mk</code> (and
4977: search for <code class="varname">PLIST_SUBST</code>).</p>
4978: <p>If you want to change other variables not listed above, you
4979: can add variables and their expansions to this variable in the
1.110 hubertf 4980: 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 4981: <pre class="programlisting">
1.100 rillig 4982: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 4983: </pre>
1.128 wiz 4984: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4985: in the <code class="filename">PLIST</code> with
1.128 wiz 4986: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4987: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4988: the common case of conditionally including some
4989: <code class="filename">PLIST</code> entries. It can be done by adding
4990: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 4991: setting the corresponding <code class="varname">PLIST.foo</code> variable
4992: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 4993: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 4994: in the <code class="filename">PLIST</code> with either
1.128 wiz 4995: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4996: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 4997: For example, in <code class="filename">Makefile</code>:</p>
4998: <pre class="programlisting">
4999: PLIST_VARS+= foo
5000: .if <em class="replaceable"><code>condition</code></em>
5001: PLIST.foo= yes
5002: .else
5003: </pre>
5004: <p>And then in <code class="filename">PLIST</code>:</p>
5005: <pre class="programlisting">
5006: @comment $NetBSD$
5007: bin/bar
5008: man/man1/bar.1
5009: ${PLIST.foo}bin/foo
5010: ${PLIST.foo}man/man1/foo.1
5011: ${PLIST.foo}share/bar/foo.data
5012: ${PLIST.foo}@dirrm share/bar
5013: </pre>
1.75 rillig 5014: </div>
1.148 asau 5015: <div class="sect1">
1.75 rillig 5016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5017: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5018: <p>Man pages should be installed in compressed form if
1.87 wiz 5019: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5020: and uncompressed otherwise. To handle this in the
1.128 wiz 5021: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5022: appended/removed automatically for man pages according to
5023: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5024: or not, see above for details. This modification of the
5025: <code class="filename">PLIST</code> file is done on a copy of it, not
5026: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5027: </div>
1.148 asau 5028: <div class="sect1">
1.75 rillig 5029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5030: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5031: </h2></div></div></div>
1.76 rillig 5032: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5033: in generating the binary package, set the variable
5034: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.189 snj 5035: 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 5036: important. The default for <code class="varname">PLIST_SRC</code> is
5037: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5038: </div>
1.148 asau 5039: <div class="sect1">
1.75 rillig 5040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5041: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5042: <p>Some packages decide to install a different set of files based on
1.87 wiz 5043: the operating system being used. These differences can be
5044: automatically handled by using the following files:</p>
1.148 asau 5045: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5046: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5047: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5048: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5049: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5050: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5051: </ul></div>
5052: </div>
1.148 asau 5053: <div class="sect1">
1.75 rillig 5054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5055: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5056: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5057: multiple (and unrelated) packages install files. These
1.125 wiz 5058: directories were problematic because you had to add special
5059: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5060: centralized package handle them.</p>
1.125 wiz 5061: <p>In pkgsrc, it is now easy: Each package should create
5062: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5063: will remove any directories left empty after uninstalling a
5064: package.</p>
5065: <p>If a package needs an empty directory to work, create
5066: the directory during installation as usual, and also add an
5067: entry to the PLIST:
5068: </p>
1.87 wiz 5069: <pre class="programlisting">
1.125 wiz 5070: @pkgdir path/to/empty/directory
1.87 wiz 5071: </pre>
1.125 wiz 5072: <p>
5073: </p>
1.75 rillig 5074: </div>
5075: </div>
1.148 asau 5076: <div class="chapter">
1.75 rillig 5077: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5078: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5079: <div class="toc">
5080: <p><b>Table of Contents</b></p>
1.195 wiz 5081: <dl class="toc">
1.106 rillig 5082: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5083: <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 5084: <dd><dl>
1.106 rillig 5085: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5086: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5087: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5088: and
5089: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5090: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5091: </dl></dd>
1.128 wiz 5092: <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 5093: <dd><dl>
1.128 wiz 5094: <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 5095: <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 5096: </dl></dd>
5097: </dl>
5098: </div>
5099: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5100: are seen by a package's configure and build processes. This is implemented
5101: in a two step process:</p>
1.128 wiz 5102: <div class="orderedlist"><ol class="orderedlist" type="1">
5103: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5104: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5105: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5106: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5107: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5108: <code class="option">-L${LOCALBASE}/lib</code> into references to
5109: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5110: native compiler on some operating systems look like GCC, so that
5111: packages that expect GCC won't require modifications to build with
5112: those native compilers.</p></li>
1.75 rillig 5113: </ol></div>
5114: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5115: package may be built consistently despite what other software may be
5116: installed. Please note that the normal system header and library paths,
5117: e.g. <code class="filename">/usr/include</code>,
5118: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5119: designed to insulate the package build from non-system-supplied
5120: software.</p>
1.148 asau 5121: <div class="sect1">
1.75 rillig 5122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5123: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5124: <p>The process of converting packages to use the buildlink3
1.128 wiz 5125: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5126: The things to keep in mind are:</p>
1.128 wiz 5127: <div class="orderedlist"><ol class="orderedlist" type="1">
5128: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5129: instead of the actual toolchain. Some packages are tricky,
5130: and the only way to know for sure is the check
5131: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5132: wrappers are being invoked.</p></li>
1.128 wiz 5133: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5134: the package Makefile, e.g. Java VMs, standalone shells,
5135: etc., because the code to symlink files into
5136: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5137: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5138: </p></li>
1.128 wiz 5139: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5140: <code class="filename">buildlink3.mk</code> files that you list in a
5141: package's Makefile are added as dependencies for that package.
5142: </p></li>
1.75 rillig 5143: </ol></div>
1.87 wiz 5144: <p>If a dependency on a particular package is required for its libraries and
5145: headers, then we replace:</p>
1.75 rillig 5146: <pre class="programlisting">
1.100 rillig 5147: DEPENDS+= foo>=1.1.0:../../category/foo
5148: </pre>
1.75 rillig 5149: <p>with</p>
5150: <pre class="programlisting">
1.100 rillig 5151: .include "../../category/foo/buildlink3.mk"
5152: </pre>
1.75 rillig 5153: <p>The buildlink3.mk files usually define the required dependencies.
5154: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5155: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5156: <pre class="programlisting">
1.100 rillig 5157: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5158: .include "../../category/foo/buildlink3.mk"
5159: </pre>
1.76 rillig 5160: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5161: files in <code class="filename">pkgsrc/mk</code>
5162: that handle special package issues:</p>
1.148 asau 5163: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5164: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5165: the native or a pkgsrc Berkeley DB implementation based on
5166: the values of <code class="varname">BDB_ACCEPTED</code> and
5167: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5168: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5169: comes with neither Curses nor NCurses, this will take care
1.189 snj 5170: 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 5171: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5172: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5173: adding a dependency on Heimdal or MIT-krb5 for packages that
5174: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5175: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5176: system-provided Motif installation or adds a dependency on
1.189 snj 5177: <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 5178: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.151 obache 5179: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5180: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5181: which Motif version will be used.</p></li>
1.161 ryoon 5182: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 5183: system-provided GNU readline or editline (libedit) installation,
1.189 snj 5184: 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>,
5185: <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 5186: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5187: If your package really needs GNU readline library, its Makefile
5188: should include <code class="filename">devel/readline/buildlink3.mk</code>
5189: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 5190: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5191: variables that may be used by packages that use the
5192: Open Sound System (OSS) API.</p></li>
1.128 wiz 5193: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5194: any of the Postgres versions in the variable
5195: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5196: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5197: the file for more information.</p></li>
1.128 wiz 5198: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5199: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.189 snj 5200: 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 5201: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5202: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5203: library.</p></li>
1.75 rillig 5204: </ul></div>
1.76 rillig 5205: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5206: files provide a more complete
5207: description of how to use them properly.</p>
1.75 rillig 5208: </div>
1.148 asau 5209: <div class="sect1">
1.75 rillig 5210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5211: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5212: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5213: included by Makefiles to indicate the need to compile and link
5214: against header files and libraries provided by the package. A
5215: <code class="filename">buildlink3.mk</code> file should always provide
5216: enough information to add the correct type of dependency
5217: relationship and include any other
5218: <code class="filename">buildlink3.mk</code> files that it needs to find
5219: headers and libraries that it needs in turn.</p>
5220: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.189 snj 5221: 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 5222: package is highly recommended. For most packages, the following
5223: command will generate a good starting point for
5224: <code class="filename">buildlink3.mk</code> files:</p>
5225: <pre class="screen">
5226: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5227: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5228: </pre>
1.148 asau 5229: <div class="sect2">
1.75 rillig 5230: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5231: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5232: <p>The following real-life example
1.87 wiz 5233: <code class="filename">buildlink3.mk</code> is taken
5234: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5235: <pre class="programlisting">
1.120 snj 5236: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5237:
1.120 snj 5238: BUILDLINK_TREE+= tiff
1.1 grant 5239:
1.120 snj 5240: .if !defined(TIFF_BUILDLINK3_MK)
5241: TIFF_BUILDLINK3_MK:=
1.87 wiz 5242:
1.120 snj 5243: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5244: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5245: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5246:
1.100 rillig 5247: .include "../../devel/zlib/buildlink3.mk"
5248: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5249: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5250:
1.120 snj 5251: BUILDLINK_TREE+= -tiff
1.100 rillig 5252: </pre>
1.87 wiz 5253: <p>The header and footer manipulate
1.120 snj 5254: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5255: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5256: the dependency tree.</p>
5257: <p>The main section is protected from multiple inclusion
1.87 wiz 5258: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5259: added. Several important variables are set in the section:</p>
1.148 asau 5260: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5261: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5262: is the actual dependency recorded in the installed
5263: package; this should always be set using
1.110 hubertf 5264: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5265: we're appending to any pre-existing list of values. This
5266: variable should be set to the first version of the
1.133 wiz 5267: package that had an backwards-incompatible API change.
1.87 wiz 5268: </p></li>
1.128 wiz 5269: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5270: is the location of the <em class="replaceable"><code>pkg</code></em>
5271: pkgsrc directory.</p></li>
1.128 wiz 5272: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5273: (not shown above) controls whether we use
5274: <code class="varname">BUILD_DEPENDS</code> or
5275: <code class="varname">DEPENDS</code> to add the dependency on
5276: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5277: selected by setting
5278: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5279: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5280: used.</p></li>
1.128 wiz 5281: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5282: and
5283: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5284: (not shown above) are lists of subdirectories of
1.76 rillig 5285: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5286: to add to the header and library search paths. These
1.128 wiz 5287: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5288: respectively.</p></li>
1.128 wiz 5289: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5290: (not shown above) is the list of preprocessor flags to add
5291: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5292: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5293: should be avoided and instead be handled using
5294: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5295: above.</p></li>
1.75 rillig 5296: </ul></div>
1.87 wiz 5297: <p>The following variables are all optionally defined within
5298: this second section (protected against multiple inclusion) and
5299: control which package files are symlinked into
5300: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5301: transformed during the symlinking:</p>
1.148 asau 5302: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5303: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5304: (not shown above) is a shell glob pattern relative to
1.76 rillig 5305: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5306: to be symlinked into
1.76 rillig 5307: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5308: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5309: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5310: (not shown above) is a shell pipeline that
5311: outputs to stdout a list of files relative to
5312: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5313: The resulting files are to be symlinked
5314: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5315: this takes the <code class="filename">+CONTENTS</code> of a
5316: <em class="replaceable"><code>pkg</code></em> and filters it through
5317: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5318: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5319: (not shown above) is a filter command that filters
1.76 rillig 5320: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5321: relative to
1.76 rillig 5322: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194 bsiegert 5323: on stdout. By default,
1.75 rillig 5324: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5325: outputs the contents of the <code class="filename">include</code>
5326: and <code class="filename">lib</code> directories in the package
1.194 bsiegert 5327: <code class="filename">+CONTENTS</code>.</p></li>
1.128 wiz 5328: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5329: (not shown above) is a list of sed arguments used to
5330: transform the name of the source filename into a
1.110 hubertf 5331: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5332: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5333: </ul></div>
1.120 snj 5334: <p>This section can additionally include any
1.87 wiz 5335: <code class="filename">buildlink3.mk</code> needed for
5336: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5337: Including these <code class="filename">buildlink3.mk</code> files
5338: means that the headers and libraries for these
5339: dependencies are also symlinked into
5340: <code class="filename">${BUILDLINK_DIR}</code>
5341: whenever the <em class="replaceable"><code>pkg</code></em>
5342: <code class="filename">buildlink3.mk</code>
1.120 snj 5343: file is included. Dependencies are only added for directly
5344: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 5345: <p>When providing a <code class="filename">buildlink3.mk</code> and
5346: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 5347: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 5348: header files are automatically exposed when the package is
5349: use.</p>
5350: <p>In particular, if only an executable
5351: (<code class="filename">bin/foo</code>) is linked against a library, that
5352: library does not need to be propagated in the
5353: <code class="filename">buildlink3.mk</code> file.</p>
5354: <p>The following steps should help you decide if a
5355: <code class="filename">buildlink3.mk</code> file needs to be included:
5356: </p>
5357: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5358: <li class="listitem"><p>Look at the installed header files: What
5359: headers do they include? The packages providing these files
5360: must be buildlinked.</p></li>
1.155 wiz 5361: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5362: libraries and look against what other libraries they link.
5363: Some of the packages providing these probably need to be
5364: buildlinked; however, it's not automatic, since e.g. GTK on
5365: some systems pulls in the X libraries, so they will show up in
5366: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 5367: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 5368: used as a hint.</p></li>
1.153 wiz 5369: </ul></div>
5370: <p>
5371: </p>
1.75 rillig 5372: </div>
1.148 asau 5373: <div class="sect2">
1.75 rillig 5374: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5375: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5376: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5377: and
5378: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5379: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5380: <p>These two variables differ in that one describes source
5381: compatibility (API) and the other binary compatibility (ABI).
5382: The difference is that a change in the API breaks compilation of
5383: programs while changes in the ABI stop compiled programs from
5384: running.</p>
5385: <p>Changes to the
1.134 wiz 5386: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5387: variable in a <code class="filename">buildlink3.mk</code> file happen
5388: very rarely. One possible reason is that all packages depending
5389: on this already need a newer version. In case it is bumped see
5390: the description below.</p>
5391: <p>The most common example of an ABI change is that the major
5392: version of a shared library is increased. In this case,
5393: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5394: should be adjusted to require at least the new package version.
5395: Then the packages that depend on this package need their
5396: <code class="varname">PKGREVISION</code>s increased and, if they have
5397: <code class="filename">buildlink3.mk</code> files, their
5398: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5399: adjusted, too. This is needed so pkgsrc will require the correct
5400: package dependency and not settle for an older one when building
5401: the source.</p>
1.110 hubertf 5402: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5403: more information about dependencies on other packages,
5404: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5405: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5406: <p>Please take careful consideration before adjusting
5407: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5408: or
5409: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5410: as we don't want to cause unneeded package deletions and
5411: rebuilds. In many cases, new versions of packages work just
5412: fine with older dependencies.</p>
5413: <p>Also it is not needed to set
1.133 wiz 5414: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5415: when it is identical to
1.87 wiz 5416: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5417: </div>
5418: </div>
1.148 asau 5419: <div class="sect1">
1.75 rillig 5420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5421: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5422: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5423: coincide with headers and libraries present in the base system.
1.76 rillig 5424: Aside from a <code class="filename">buildlink3.mk</code> file, these
5425: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5426: file that includes the necessary checks to decide whether using
5427: the built-in software or the pkgsrc software is
1.87 wiz 5428: appropriate.</p>
5429: <p>The only requirements of a builtin.mk file for
5430: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5431: <div class="orderedlist"><ol class="orderedlist" type="1">
5432: <li class="listitem"><p>It should set
1.87 wiz 5433: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5434: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5435: after it is included.</p></li>
1.128 wiz 5436: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5437: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5438: which is already set before the
5439: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5440: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5441: is <span class="emphasis"><em>very</em></span> important and takes careful
5442: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5443: </ol></div>
1.148 asau 5444: <div class="sect2">
1.75 rillig 5445: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5446: <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 5447: <p>The following is the recommended template for builtin.mk
1.87 wiz 5448: files:</p>
1.75 rillig 5449: <pre class="programlisting">
1.100 rillig 5450: .if !defined(IS_BUILTIN.foo)
5451: #
5452: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5453: # genuinely exists in the system or not.
5454: #
5455: IS_BUILTIN.foo?= no
5456:
5457: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5458: # version can be determined.
5459: #
5460: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5461: BUILTIN_PKG.foo?= foo-1.0
5462: . endif
5463: .endif # IS_BUILTIN.foo
5464:
5465: .if !defined(USE_BUILTIN.foo)
5466: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5467: . if defined(BUILTIN_PKG.foo)
5468: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5469: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5470: USE_BUILTIN.foo!= \
5471: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5472: && ${ECHO} "yes" || ${ECHO} "no"
5473: . endif
5474: . endfor
5475: . endif
5476: .endif # USE_BUILTIN.foo
5477:
5478: CHECK_BUILTIN.foo?= no
5479: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5480: #
5481: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5482: # "yes" or "no".
5483: #
5484: .endif # CHECK_BUILTIN.foo
5485: </pre>
1.87 wiz 5486: <p>The first section sets
5487: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5488: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5489: in the base system. This should not be a base system software
5490: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5491: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5492: included as part of the base system. This variable is only
5493: used internally within the <code class="filename">builtin.mk</code>
5494: file.</p>
5495: <p>The second section sets
5496: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5497: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5498: system if it exists (if
5499: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5500: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5501: within the <code class="filename">builtin.mk</code> file.</p>
5502: <p>The third section sets
5503: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5504: and is <span class="emphasis"><em>required</em></span> in all
5505: <code class="filename">builtin.mk</code> files. The code in this
5506: section must make the determination whether the built-in
5507: software is adequate to satisfy the dependencies listed in
5508: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5509: This is typically done by comparing
5510: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5511: against each of the dependencies in
5512: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5513: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5514: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5515: end of the <code class="filename">builtin.mk</code> file. Note that
5516: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5517: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5518: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5519: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5520: that the built-in version of the software is similar enough to
5521: be used as a replacement.</p>
5522: <p>The last section is guarded by
5523: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5524: and includes code that uses the value of
5525: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5526: set in the previous section. This typically includes, e.g.,
5527: adding additional dependency restrictions and listing additional
5528: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5529: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5530: </div>
1.148 asau 5531: <div class="sect2">
1.75 rillig 5532: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5533: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5534: <p>When building packages, it's possible to choose whether to set
5535: a global preference for using either the built-in (native)
5536: version or the pkgsrc version of software to satisfy a
5537: dependency. This is controlled by setting
5538: <code class="varname">PREFER_PKGSRC</code> and
5539: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5540: 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 5541: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5542: use the pkgsrc versions of software, while
5543: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5544: built-in versions. Preferences are determined by the most
5545: specific instance of the package in either
5546: <code class="varname">PREFER_PKGSRC</code> or
5547: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5548: in neither or in both variables, then
5549: <code class="varname">PREFER_PKGSRC</code> has precedence over
5550: <code class="varname">PREFER_NATIVE</code>. For example, to require
5551: using pkgsrc versions of software for all but the most basic
5552: bits on a NetBSD system, you can set:</p>
5553: <pre class="programlisting">
1.100 rillig 5554: PREFER_PKGSRC= yes
5555: PREFER_NATIVE= getopt skey tcp_wrappers
5556: </pre>
1.87 wiz 5557: <p>A package <span class="emphasis"><em>must</em></span> have a
5558: <code class="filename">builtin.mk</code>
5559: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5560: otherwise it is simply ignored in that list.</p>
1.75 rillig 5561: </div>
5562: </div>
5563: </div>
1.148 asau 5564: <div class="chapter">
1.75 rillig 5565: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5566: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5567: <div class="toc">
5568: <p><b>Table of Contents</b></p>
1.195 wiz 5569: <dl class="toc">
1.106 rillig 5570: <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 5571: <dd><dl>
1.106 rillig 5572: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5573: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5574: </dl></dd>
1.106 rillig 5575: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5576: <dd><dl>
1.128 wiz 5577: <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 5578: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5579: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5580: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5581: </dl></dd>
5582: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5583: <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>
5584: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5585: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5586: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5587: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5588: <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 5589: </dl>
5590: </div>
5591: <p>This chapter describes the framework known as
5592: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5593: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5594: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5595: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5596: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5597: provided that packages are correctly designed.</p></li>
1.128 wiz 5598: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5599: <li class="listitem"><p>Registration of system users and groups.</p></li>
5600: <li class="listitem"><p>Registration of system shells.</p></li>
5601: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5602: </ul></div>
5603: <p>The following sections inspect each of the above points in detail.</p>
5604: <p>You may be thinking that many of the things described here could be
5605: easily done with simple code in the package's post-installation target
5606: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5607: as the code in them is only executed when building from source. Machines
5608: using binary packages could not benefit from it at all (as the code itself
5609: could be unavailable). Therefore, the only way to achieve any of the items
5610: described above is by means of the installation scripts, which are
5611: automatically generated by pkginstall.</p>
1.148 asau 5612: <div class="sect1">
1.75 rillig 5613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5614: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5615: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5616: of files and directories that belong to a package. The names used in it
1.76 rillig 5617: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5618: which means that it cannot register files outside this directory (absolute
5619: path names are not allowed). Despite this restriction, some packages need
5620: to install files outside this location; e.g., under
1.76 rillig 5621: <code class="filename">${VARBASE}</code> or
1.87 wiz 5622: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5623: is to create such files during installation time by using
5624: installation scripts.</p>
5625: <p>The generic installation scripts are shell scripts that can
5626: contain arbitrary code. The list of scripts to execute is taken from
5627: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5628: <code class="filename">INSTALL</code>. A similar variable exists for package
5629: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5630: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5631: commands, so they have the potential to create and manage files
5632: anywhere in the file system.</p>
5633: <p>Using these general installation files is not recommended, but
5634: may be needed in some special cases. One reason for avoiding them is
5635: that the user has to trust the packager that there is no unwanted or
5636: simply erroneous code included in the installation script. Also,
5637: previously there were many similar scripts for the same functionality,
5638: and fixing a common error involved finding and changing all of
5639: them.</p>
5640: <p>The pkginstall framework offers another, standardized way. It
5641: provides generic scripts to abstract the manipulation of such files
5642: and directories based on variables set in the package's
5643: <code class="filename">Makefile</code>. The rest of this section describes
5644: these variables.</p>
1.148 asau 5645: <div class="sect2">
1.75 rillig 5646: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5647: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5648: <p>The following variables can be set to request the creation of
5649: directories anywhere in the file system:</p>
1.148 asau 5650: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5651: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5652: contain a list of directories that should be created and should attempt
5653: to be destroyed by the installation scripts. The difference between
5654: the two is that the latter prompts the administrator to remove any
5655: directories that may be left after deinstallation (because they were
5656: not empty), while the former does not.</p></li>
1.128 wiz 5657: <li class="listitem">
1.75 rillig 5658: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5659: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5660: which directories should be created and should attempt to be destroyed
5661: by the installation scripts. Each tuple holds the following values,
5662: separated by spaces: the directory name, its owner, its group and its
5663: numerical mode. For example:</p>
5664: <pre class="programlisting">
1.100 rillig 5665: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5666: </pre>
1.75 rillig 5667: <p>The difference between the two is exactly the same as their
5668: non-<code class="varname">PERMS</code> counterparts.</p>
5669: </li>
5670: </ul></div>
5671: </div>
1.148 asau 5672: <div class="sect2">
1.75 rillig 5673: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5674: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5675: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5676: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5677: To overcome this problem, the only solution is to extract the file in the
5678: known place (i.e., inside the installation prefix) and copy it to the
5679: appropriate location during installation (done by the installation scripts
5680: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5681: file</em></span> in the following paragraphs, which describe the variables
5682: that can be used to automatically and consistently handle files outside the
5683: installation prefix:</p>
1.148 asau 5684: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5685: <li class="listitem">
1.75 rillig 5686: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5687: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5688: During installation time, the master file is copied to the target one
5689: if and only if the latter does not exist. Upon deinstallation, the
5690: target file is removed provided that it was not modified by the
5691: installation.</p>
5692: <p>The difference between the two is that the latter prompts the
5693: administrator to remove any files that may be left after
5694: deinstallation (because they were not empty), while the former does
5695: not.</p>
5696: </li>
1.128 wiz 5697: <li class="listitem">
1.75 rillig 5698: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5699: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5700: files as well as their target locations. For each of them, it also
5701: specifies their owner, their group and their numeric permissions, in
5702: this order. For example:</p>
5703: <pre class="programlisting">
1.137 wiz 5704: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5705: </pre>
1.75 rillig 5706: <p>The difference between the two is exactly the same as their
5707: non-<code class="varname">PERMS</code> counterparts.</p>
5708: </li>
5709: </ul></div>
5710: </div>
5711: </div>
1.148 asau 5712: <div class="sect1">
1.75 rillig 5713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5714: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5715: <p>Configuration files are special in the sense that they are installed
5716: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5717: need special treatment during installation (most of which is automated by
5718: pkginstall). The main concept you must bear in mind is that files marked
5719: as configuration files are automatically copied to the right place (somewhere
5720: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5721: and only if</em></span> they didn't exist before. Similarly, they will not
5722: be removed if they have local modifications. This ensures that
5723: administrators never lose any custom changes they may have made.</p>
1.148 asau 5724: <div class="sect2">
1.75 rillig 5725: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5726: <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 5727: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5728: specifies where configuration files shall be installed. Its contents are
5729: set based upon the following variables:</p>
1.148 asau 5730: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5731: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5732: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5733: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5734: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5735: Packages must not use it directly.</p></li>
1.128 wiz 5736: <li class="listitem">
1.75 rillig 5737: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5738: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5739: for the package being built shall be installed. The definition of this
5740: variable only makes sense in the package's
1.76 rillig 5741: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5742: <p>As an example, consider the Apache package,
1.189 snj 5743: <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 5744: configuration files under the
1.76 rillig 5745: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5746: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5747: Makefile.</p>
5748: </li>
1.128 wiz 5749: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5750: variable that holds this package's configuration directory (if
5751: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5752: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5753: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5754: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5755: directory where the configuration files for the package identified by
5756: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5757: </ul></div>
5758: <p>Based on the above variables, pkginstall determines the value of
5759: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5760: variable that can be used within a package to refer to its configuration
5761: directory. The algorithm used to set its value is basically the
5762: following:</p>
1.128 wiz 5763: <div class="orderedlist"><ol class="orderedlist" type="1">
5764: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5765: its value is used.</p></li>
1.128 wiz 5766: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5767: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5768: <code class="filename">Makefile</code>, the resulting value is
5769: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5770: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5771: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5772: </ol></div>
1.76 rillig 5773: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5774: 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
5775: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5776: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5777: </div>
1.148 asau 5778: <div class="sect2">
1.75 rillig 5779: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5780: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5781: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5782: known place, you need to teach each package where it shall install its
5783: files. In some cases you will have to patch the package Makefiles to
5784: achieve it. If you are lucky, though, it may be as easy as passing an
5785: extra flag to the configuration script; this is the case of GNU Autoconf-
5786: generated files:</p>
5787: <pre class="programlisting">
1.100 rillig 5788: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5789: </pre>
1.75 rillig 5790: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5791: for</em></span> its configuration files, not where they will be originally
5792: installed (although the difference is never explicit,
5793: unfortunately).</p>
5794: </div>
1.148 asau 5795: <div class="sect2">
1.75 rillig 5796: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5797: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5798: <p>As said before, pkginstall automatically handles configuration files.
5799: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5800: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5801: directly</strong></span>. Bad news is that many software installation scripts
5802: will, out of the box, mess with the contents of that directory. So what is
5803: the correct procedure to fix this issue?</p>
5804: <p>You must teach the package (usually by manually patching it) to
5805: install any configuration files under the examples hierarchy,
1.76 rillig 5806: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5807: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5808: has the original copies available.</p>
5809: <p>Once the required configuration files are in place (i.e., under the
5810: examples hierarchy), the pkginstall framework can use them as master copies
5811: during the package installation to update what is in
1.76 rillig 5812: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5813: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5814: 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 5815: about their syntax and their purpose. Here is an example, taken from the
1.189 snj 5816: <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 5817: <pre class="programlisting">
1.100 rillig 5818: EGDIR= ${PREFIX}/share/doc/mutt/samples
5819: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5820: </pre>
1.75 rillig 5821: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5822: package and has no meaning outside it.</p>
5823: </div>
1.148 asau 5824: <div class="sect2">
1.75 rillig 5825: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5826: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5827: <p>The automatic copying of config files can be toggled by setting the
5828: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5829: installation.</p>
5830: </div>
5831: </div>
1.148 asau 5832: <div class="sect1">
1.75 rillig 5833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5834: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5835: <p>System startup scripts are special files because they must be
5836: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5837: 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 5838: can be used. However, pkginstall provides a special mechanism to handle
5839: these files.</p>
5840: <p>In order to provide system startup scripts, the package has
5841: to:</p>
1.128 wiz 5842: <div class="orderedlist"><ol class="orderedlist" type="1">
5843: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5844: the <code class="literal">.sh</code> suffix appended. Considering the
1.189 snj 5845: <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 5846: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5847: <li class="listitem">
1.75 rillig 5848: <p>Tell pkginstall to handle it, appending the name of the script,
5849: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5850: Continuing the previous example:</p>
5851: <pre class="programlisting">
1.100 rillig 5852: RCD_SCRIPTS+= cupsd
1.1 grant 5853: </pre>
1.75 rillig 5854: </li>
5855: </ol></div>
5856: <p>Once this is done, pkginstall will do the following steps for each
5857: script in an automated fashion:</p>
1.128 wiz 5858: <div class="orderedlist"><ol class="orderedlist" type="1">
5859: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5860: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5861: variable.</p></li>
1.128 wiz 5862: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5863: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5864: that this master file must be explicitly registered in the
1.76 rillig 5865: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5866: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5867: from the examples hierarchy into the system-wide startup scripts
5868: directory.</p></li>
5869: </ol></div>
1.148 asau 5870: <div class="sect2">
1.75 rillig 5871: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5872: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5873: <p>The automatic copying of config files can be toggled by setting the
5874: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5875: installation. Note that the scripts will be always copied inside the
1.76 rillig 5876: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5877: matter what the value of this variable is.</p>
5878: </div>
5879: </div>
1.148 asau 5880: <div class="sect1">
1.75 rillig 5881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5882: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5883: <p>If a package needs to create special users and/or groups during
5884: installation, it can do so by using the pkginstall framework.</p>
5885: <p>Users can be created by adding entries to the
5886: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5887: syntax:</p>
5888: <pre class="programlisting">
1.100 rillig 5889: user:group
1.1 grant 5890: </pre>
1.87 wiz 5891: <p>Further specification of user details may be done by setting
5892: per-user variables.
5893: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5894: numeric UID for the user.
5895: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5896: user's description or comment.
5897: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5898: user's home directory, and defaults to
5899: <code class="filename">/nonexistent</code> if not specified.
5900: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5901: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5902: not specified.</p>
1.75 rillig 5903: <p>Similarly, groups can be created by adding entries to the
5904: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5905: <pre class="programlisting">
1.100 rillig 5906: group
1.1 grant 5907: </pre>
1.93 rillig 5908: <p>The numeric GID of the group may be set by defining
1.75 rillig 5909: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5910: <p>If a package needs to create the users and groups at an earlier
5911: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5912: either <code class="literal">configure</code> or <code class="literal">build</code> to
5913: indicate the phase before which the users and groups are created. In
5914: this case, the numeric UIDs and GIDs of the created users and groups
5915: are automatically hardcoded into the final installation scripts.</p>
5916: </div>
1.148 asau 5917: <div class="sect1">
1.75 rillig 5918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5919: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5920: <p>Packages that install system shells should register them in the shell
1.76 rillig 5921: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5922: administrator. This must be done from the installation scripts to keep
5923: binary packages working on any system. pkginstall provides an easy way to
5924: accomplish this task.</p>
5925: <p>When a package provides a shell interpreter, it has to set the
5926: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5927: add some hooks to the installation scripts to handle it. Consider the
1.189 snj 5928: 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 5929: <pre class="programlisting">
1.100 rillig 5930: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5931: </pre>
1.148 asau 5932: <div class="sect2">
1.75 rillig 5933: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5934: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5935: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5936: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5937: environment variable to <code class="literal">NO</code>.</p>
5938: </div>
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="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5943: <p>Packages that install X11 fonts should update the database files
5944: that index the fonts within each fonts directory. This can easily be
5945: accomplished within the pkginstall framework.</p>
5946: <p>When a package installs X11 fonts, it must list the directories in
5947: which fonts are installed in the
5948: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5949: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5950: <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 5951: installation scripts to run the appropriate commands to update the fonts
5952: database files within each of those directories. For convenience, if the
5953: directory path is relative, it is taken to be relative to the package's
1.189 snj 5954: 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 5955: <pre class="programlisting">
1.175 wiz 5956: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5957: </pre>
1.148 asau 5958: <div class="sect2">
1.75 rillig 5959: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5960: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5961: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5962: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5963: environment variable to <code class="literal">NO</code>.</p>
5964: </div>
5965: </div>
5966: </div>
1.148 asau 5967: <div class="chapter">
1.75 rillig 5968: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5969: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 5970: <div class="toc">
5971: <p><b>Table of Contents</b></p>
1.195 wiz 5972: <dl class="toc">
1.106 rillig 5973: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 5974: <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 5975: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 5976: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 5977: </dl>
5978: </div>
5979: <p>Many packages have the ability to be built to support different
1.76 rillig 5980: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 5981: in pkgsrc that provides generic handling of those options that
5982: determine different ways in which the packages can be built. It's
5983: possible for the user to specify exactly which sets of options will be
5984: built into a package or to allow a set of global default options
5985: apply.</p>
1.107 rillig 5986: <p>There are two broad classes of behaviors that one might want to
5987: control via options. One is whether some particular feature is
5988: enabled in a program that will be built anyway, often by including or
5989: not including a dependency on some other package. The other is
5990: whether or not an additional program will be built as part of the
5991: package. Generally, it is better to make a split package for such
5992: additional programs instead of using options, because it enables
5993: binary packages to be built which can then be added separately. For
5994: example, the foo package might have minimal dependencies (those
5995: packages without which foo doesn't make sense), and then the foo-gfoo
5996: package might include the GTK frontend program gfoo. This is better
5997: than including a gtk option to foo that adds gfoo, because either that
5998: option is default, in which case binary users can't get foo without
5999: gfoo, or not default, in which case they can't get gfoo. With split
6000: packages, they can install foo without having GTK, and later decide to
6001: install gfoo (pulling in GTK at that time). This is an advantage to
6002: source users too, avoiding the need for rebuilds.</p>
6003: <p>Plugins with widely varying dependencies should usually be split
6004: instead of options.</p>
6005: <p>It is often more work to maintain split packages, especially if
6006: the upstream package does not support this. The decision of split
6007: vs. option should be made based on the likelihood that users will want
6008: or object to the various pieces, the size of the dependencies that are
6009: included, and the amount of work.</p>
6010: <p>A further consideration is licensing. Non-free parts, or parts
6011: that depend on non-free dependencies (especially plugins) should
6012: almost always be split if feasible.</p>
1.148 asau 6013: <div class="sect1">
1.75 rillig 6014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6015: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6016: <p>Global default options are listed in
6017: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6018: that should be built into every package if that option is supported.
1.110 hubertf 6019: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6020: </div>
1.148 asau 6021: <div class="sect1">
1.75 rillig 6022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6023: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6024: </h2></div></div></div>
1.75 rillig 6025: <p>The following example shows how
1.76 rillig 6026: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6027: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6028: <code class="filename">Makefile</code>, or in a file,
6029: e.g. <code class="filename">options.mk</code>, that is included by the
6030: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6031: <pre class="programlisting">
1.100 rillig 6032: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6033: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6034: PKG_OPTIONS_OPTIONAL_GROUPS= database
6035: PKG_OPTIONS_GROUP.database= mysql pgsql
6036: PKG_SUGGESTED_OPTIONS= wibble-foo
6037: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6038: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6039:
6040: .include "../../mk/bsd.prefs.mk"
6041:
6042: # this package was previously named wibble2
6043: .if defined(PKG_OPTIONS.wibble2)
6044: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6045: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6046: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6047: .endif
6048:
6049: .include "../../mk/bsd.options.mk"
6050:
6051: # Package-specific option-handling
6052:
6053: ###
6054: ### FOO support
6055: ###
6056: .if !empty(PKG_OPTIONS:Mwibble-foo)
6057: CONFIGURE_ARGS+= --enable-foo
6058: .endif
6059:
6060: ###
6061: ### LDAP support
6062: ###
6063: .if !empty(PKG_OPTIONS:Mldap)
6064: . include "../../databases/openldap-client/buildlink3.mk"
6065: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6066: .endif
6067:
6068: ###
6069: ### database support
6070: ###
6071: .if !empty(PKG_OPTIONS:Mmysql)
6072: . include "../../mk/mysql.buildlink3.mk"
6073: .endif
6074: .if !empty(PKG_OPTIONS:Mpgsql)
6075: . include "../../mk/pgsql.buildlink3.mk"
6076: .endif
1.75 rillig 6077: </pre>
6078: <p>The first section contains the information about which build
6079: options are supported by the package, and any default options settings
6080: if needed.</p>
1.128 wiz 6081: <div class="orderedlist"><ol class="orderedlist" type="1">
6082: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.189 snj 6083: <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 6084: options. It should be set to
1.78 rillig 6085: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6086: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6087: at the point where the options are processed.</p></li>
1.128 wiz 6088: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6089: build options supported by the package.</p></li>
1.128 wiz 6090: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6091: list of names of groups of mutually exclusive options. The options in
6092: each group are listed in
6093: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6094: The most specific setting of any option from the group takes
6095: precedence over all other options in the group. Options from the
6096: groups will be automatically added to
6097: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6098: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6099: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6100: packages will fail if no option from the group is
6101: selected.</p></li>
1.128 wiz 6102: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6103: of names of sets of options. At least one option from each set must
6104: be selected. The options in each set are listed in
6105: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6106: Options from the sets will be automatically added to
6107: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6108: fail if no option from the set is selected.</p></li>
1.128 wiz 6109: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6110: build options which are enabled by default.</p></li>
1.128 wiz 6111: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6112: of
1.128 wiz 6113: <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 6114: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6115: their option counterparts. Pairs should be added with
1.128 wiz 6116: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6117: warning will be issued if the user uses a legacy
6118: variable.</p></li>
1.128 wiz 6119: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6120: of
1.128 wiz 6121: <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 6122: pairs that map options that have been renamed to their new
1.128 wiz 6123: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6124: the listing of global legacy options. A warning will be issued if
6125: the user uses a legacy option.</p></li>
1.128 wiz 6126: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6127: options implied by deprecated variables used. This can be used for
6128: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6129: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6130: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6131: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6132: a list of warnings about deprecated variables or options used, and
6133: what to use instead.</p></li>
6134: </ol></div>
6135: <p>A package should never modify
6136: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6137: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6138: To suggest a default set of options, use
6139: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6140: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6141: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6142: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6143: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6144: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6145: happen with platform-specific options if none of them is supported on
6146: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6147: empty list and the package is otherwise treated as not using the
6148: options framework.</p>
1.76 rillig 6149: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6150: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6151: build options, properly filtered to remove unsupported and duplicate
6152: options.</p>
6153: <p>The remaining sections contain the logic that is specific to
6154: each option. The correct way to check for an option is to check
6155: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6156: <pre class="programlisting">
1.100 rillig 6157: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6158: </pre>
6159: </div>
1.148 asau 6160: <div class="sect1">
1.75 rillig 6161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6162: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6163: <p>Options that enable similar features in different packages (like
6164: optional support for a library) should use a common name in all
6165: packages that support it (like the name of the library). If another
6166: package already has an option with the same meaning, use the same
6167: name.</p>
6168: <p>Options that enable features specific to one package, where it's
6169: unlikely that another (unrelated) package has the same (or a similar)
6170: optional feature, should use a name prefixed with
6171: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6172: <p>If a group of related packages share an optional feature
6173: specific to that group, prefix it with the name of the
1.128 wiz 6174: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6175: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6176: <p>For new options, add a line to
1.76 rillig 6177: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6178: fields, separated by tab. The first field is the option name, the
6179: second its description. The description should be a whole sentence
6180: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6181: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6182: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6183: </div>
1.148 asau 6184: <div class="sect1">
1.107 rillig 6185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6186: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6187: <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 6188: different dependencies based on the options with which the package was
6189: built. For querying these options, the file
6190: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6191: typical example looks like this:</p>
6192: <pre class="programlisting">
6193: pkgbase := libpurple
6194: .include "../../mk/pkg-build-options.mk"
6195:
6196: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6197: ...
6198: .endif
6199: </pre>
6200: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6201: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6202: options of the libpurple package, which can then be queried like
6203: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6204: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6205: details.</p>
6206: </div>
1.75 rillig 6207: </div>
1.148 asau 6208: <div class="chapter">
1.75 rillig 6209: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6210: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6211: <div class="toc">
6212: <p><b>Table of Contents</b></p>
1.195 wiz 6213: <dl class="toc">
1.106 rillig 6214: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6215: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6216: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6217: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6218: <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 6219: <dd><dl>
6220: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6221: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6222: </dl></dd>
1.128 wiz 6223: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6224: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6225: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6226: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6227: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6228: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6229: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6230: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6231: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6232: <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 6233: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6234: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6235: </dl>
6236: </div>
1.148 asau 6237: <div class="sect1">
1.75 rillig 6238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6239: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6240: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6241: built. Building a package is separated into different
6242: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6243: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6244: described in the following sections. Each phase is split into
1.87 wiz 6245: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6246: containing phase, prefixed by one of <code class="varname">pre-</code>,
6247: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6248: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6249: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6250: <p>Never override the regular targets (like
6251: <code class="varname">fetch</code>), if you have to, override the
6252: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6253: <p>The basic steps for building a program are always the same. First
1.87 wiz 6254: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6255: the local system and then extracted. After any pkgsrc-specific patches
6256: to compile properly are applied, the software can be configured, then
6257: built (usually by compiling), and finally the generated binaries, etc.
6258: can be put into place on the system.</p>
1.97 rillig 6259: <p>To get more details about what is happening at each step,
6260: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6261: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6262: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6263: </div>
1.148 asau 6264: <div class="sect1">
1.75 rillig 6265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6266: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6267: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6268: the next section, here's a brief discussion on where programs are
6269: installed, and which variables influence this.</p>
1.75 rillig 6270: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6271: where all files of the final program shall be installed. It is
6272: usually set to <code class="varname">LOCALBASE</code>
6273: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6274: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6275: <code class="varname">PREFIX</code> needs to be put
6276: into the various places in the program's source where paths to
1.110 hubertf 6277: 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 6278: <p>When choosing which of these variables to use,
1.87 wiz 6279: follow the following rules:</p>
1.148 asau 6280: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6281: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6282: where the current pkg will be installed. When referring to a
6283: pkg's own installation path, use
1.128 wiz 6284: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6285: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6286: are installed. If you need to construct a -I or -L argument
6287: to the compiler to find includes and libraries installed by
1.128 wiz 6288: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6289: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6290: installed all packages in <code class="filename">/usr/local</code>. As
6291: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6292: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6293: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6294: distribution (from xsrc, etc.) is installed. When looking for
6295: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6296: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6297: <li class="listitem">
1.88 wiz 6298: <p>X11-based packages are special in that they may be
6299: installed in either <code class="varname">X11BASE</code> or
6300: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6301: <p>Usually, X11 packages should be installed under
1.88 wiz 6302: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6303: will need to include
6304: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6305: request the presence of X11 and to get the right compilation
6306: flags.</p>
1.75 rillig 6307: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6308: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6309: files. These packages are special and they must be placed under
6310: <code class="varname">X11BASE</code>. To accomplish this, set either
6311: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6312: your package.</p>
1.75 rillig 6313: <p>Some notes: If you need
1.87 wiz 6314: to find includes or libraries installed by a pkg that has
6315: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6316: its pkg <code class="filename">Makefile</code>, you need to look in
6317: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6318: <code class="filename">${LOCALBASE}</code>. To force installation of
6319: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.189 snj 6320: <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 6321: is enabled by default.</p>
1.75 rillig 6322: </li>
1.128 wiz 6323: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6324: the installed location of an X11
6325: package. <code class="varname">X11PREFIX</code> will be set to
6326: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6327: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6328: installed.</p></li>
1.128 wiz 6329: <li class="listitem">
1.88 wiz 6330: <p>If xpkgwedge is installed, it is possible to have some
6331: packages installed in <code class="varname">X11BASE</code> and some in
6332: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6333: installed package, the <code class="varname">EVAL_PREFIX</code>
6334: definition can be used. It takes pairs in the format
1.189 snj 6335: <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 6336: variable <code class="varname">DIRNAME</code> will be set to the prefix
6337: of the installed package <package>, or
1.128 wiz 6338: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6339: installed.</p>
1.75 rillig 6340: <p>This is best illustrated by example.</p>
6341: <p>The following lines are taken from
1.87 wiz 6342: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6343: <pre class="programlisting">
1.100 rillig 6344: EVAL_PREFIX+= GTKDIR=gtk+
6345: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6346: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6347: CONFIGURE_ARGS+= --enable-multibyte
6348: </pre>
1.88 wiz 6349: <p>Specific defaults can be defined for the packages
6350: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6351: definition of the form:</p>
1.75 rillig 6352: <pre class="programlisting">
1.100 rillig 6353: GTKDIR_DEFAULT= ${LOCALBASE}
6354: </pre>
1.75 rillig 6355: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6356: to the first definition in
6357: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6358: </li>
1.128 wiz 6359: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.189 snj 6360: 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 6361: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6362: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6363: </ul></div>
6364: </div>
1.148 asau 6365: <div class="sect1">
1.75 rillig 6366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6367: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6368: <p>When building a package, various directories are used to store
1.87 wiz 6369: source files, temporary files, pkgsrc-internal files, and so on. These
6370: directories are explained here.</p>
1.75 rillig 6371: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6372: are two common base directories for these relative directories:
6373: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6374: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6375: inside the package itself.</p>
1.148 asau 6376: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6377: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6378: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6379: root directory. Generally, you don't need
6380: it.</p></dd>
1.97 rillig 6381: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6382: <dd><p>This is an absolute pathname that points to the
6383: current package.</p></dd>
1.75 rillig 6384: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6385: <dd><p>This is a pathname relative to
1.87 wiz 6386: <code class="varname">PKGSRCDIR</code> that points to the current
6387: package.</p></dd>
1.75 rillig 6388: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6389: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6390: where all work takes place. The distfiles are extracted to this
1.87 wiz 6391: directory. It also contains temporary directories and log files used by
6392: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6393: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6394: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6395: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6396: where the distfiles are extracted. It is usually a direct subdirectory
6397: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6398: that isn't hidden. This variable may be changed by a package
6399: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6400: </dl></div>
1.114 jmcneill 6401: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6402: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6403: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6404: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6405: If users would like to have their pkgsrc trees behave in a
6406: read-only manner, then the value of
6407: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6408: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6409: </div>
1.148 asau 6410: <div class="sect1">
1.75 rillig 6411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6412: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6413: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6414: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6415: phase. This will automatically run all phases that are required for this
6416: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6417: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6418: the package will be built, but not installed.</p>
1.75 rillig 6419: </div>
1.148 asau 6420: <div class="sect1">
1.75 rillig 6421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6422: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6423: <p>The first step in building a package is to fetch the
1.88 wiz 6424: distribution files (distfiles) from the sites that are providing
6425: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6426: phase.</p>
1.148 asau 6427: <div class="sect2">
1.81 rillig 6428: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6429: <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 6430: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6431: defines all URLs from where the distfile, whose name is
6432: derived from the <code class="varname">DISTNAME</code> variable, is
6433: fetched. The more complicated cases are described
6434: below.</p>
6435: <p>The variable <code class="varname">DISTFILES</code> specifies
6436: the list of distfiles that have to be fetched. Its value
1.174 asau 6437: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6438: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 6439: so that most packages don't need to define it at all.
6440: <code class="varname">EXTRACT_SUFX</code> is
6441: <code class="literal">.tar.gz</code> by default, but can be changed
6442: freely. Note that if your package requires additional
6443: distfiles to the default one, you cannot just append the
6444: additional filenames using the <code class="literal">+=</code>
6445: operator, but you have write for example:</p>
1.81 rillig 6446: <pre class="programlisting">
1.174 asau 6447: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 6448: </pre>
1.88 wiz 6449: <p>Each distfile is fetched from a list of sites, usually
6450: <code class="varname">MASTER_SITES</code>. If the package has multiple
6451: <code class="varname">DISTFILES</code> or multiple
6452: <code class="varname">PATCHFILES</code> from different sites, you can
6453: set
6454: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6455: to the list of URLs where the file
6456: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6457: (including the suffix) can be found.</p>
6458: <pre class="programlisting">
1.100 rillig 6459: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6460: DISTFILES+= foo-file.tar.gz
6461: SITES.foo-file.tar.gz= \
6462: http://www.somewhere.com/somehow/ \
6463: http://www.somewhereelse.com/mirror/somehow/
6464: </pre>
1.81 rillig 6465: <p>When actually fetching the distfiles, each item from
1.88 wiz 6466: <code class="varname">MASTER_SITES</code> or
6467: <code class="varname">SITES.*</code> gets the name of each distfile
6468: appended to it, without an intermediate slash. Therefore,
6469: all site values have to end with a slash or other separator
6470: character. This allows for example to set
6471: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6472: that gets the name of the distfile as a parameter. In this
6473: case, the definition would look like:</p>
1.81 rillig 6474: <pre class="programlisting">
1.100 rillig 6475: MASTER_SITES= http://www.example.com/download.cgi?file=
6476: </pre>
1.125 wiz 6477: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 6478: In that case the URL is taken as is, fetched and the result
6479: stored under the name of the distfile. You can use this style
6480: for the case when the download URL style does not match the
6481: above common case. For example, if permanent download URL is a
6482: redirector to the real download URL, or the download file name
6483: is offered by an HTTP Content-Disposition header. In the
6484: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6485: created instead of the default
6486: <code class="filename">v1.0.0.tar.gz</code>.</p>
6487: <pre class="programlisting">
6488: DISTNAME= foo-1.0.0
6489: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6490: </pre>
1.81 rillig 6491: <p>There are some predefined values for
1.88 wiz 6492: <code class="varname">MASTER_SITES</code>, which can be used in
6493: packages. The names of the variables should speak for
6494: themselves.</p>
6495: <pre class="programlisting">
1.100 rillig 6496: ${MASTER_SITE_APACHE}
6497: ${MASTER_SITE_BACKUP}
6498: ${MASTER_SITE_CYGWIN}
6499: ${MASTER_SITE_DEBIAN}
6500: ${MASTER_SITE_FREEBSD}
6501: ${MASTER_SITE_FREEBSD_LOCAL}
6502: ${MASTER_SITE_GENTOO}
6503: ${MASTER_SITE_GNOME}
6504: ${MASTER_SITE_GNU}
6505: ${MASTER_SITE_GNUSTEP}
1.174 asau 6506: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 6507: ${MASTER_SITE_IFARCHIVE}
6508: ${MASTER_SITE_KDE}
6509: ${MASTER_SITE_MOZILLA}
1.174 asau 6510: ${MASTER_SITE_MOZILLA_ALL}
6511: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 6512: ${MASTER_SITE_MYSQL}
1.174 asau 6513: ${MASTER_SITE_NETLIB}
1.100 rillig 6514: ${MASTER_SITE_OPENOFFICE}
6515: ${MASTER_SITE_PERL_CPAN}
6516: ${MASTER_SITE_PGSQL}
1.174 asau 6517: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 6518: ${MASTER_SITE_R_CRAN}
6519: ${MASTER_SITE_SOURCEFORGE}
6520: ${MASTER_SITE_SOURCEFORGE_JP}
6521: ${MASTER_SITE_SUNSITE}
6522: ${MASTER_SITE_SUSE}
6523: ${MASTER_SITE_TEX_CTAN}
6524: ${MASTER_SITE_XCONTRIB}
6525: ${MASTER_SITE_XEMACS}
1.174 asau 6526: ${MASTER_SITE_XORG}
1.100 rillig 6527: </pre>
1.88 wiz 6528: <p>Some explanations for the less self-explaining ones:
6529: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6530: 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 6531: 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 6532: <p>If you choose one of these predefined sites, you may
6533: want to specify a subdirectory of that site. Since these
6534: macros may expand to more than one actual site, you
6535: <span class="emphasis"><em>must</em></span> use the following construct to
6536: specify a subdirectory:</p>
1.81 rillig 6537: <pre class="programlisting">
1.100 rillig 6538: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6539: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6540: </pre>
1.81 rillig 6541: <p>Note the trailing slash after the subdirectory
1.88 wiz 6542: name.</p>
1.81 rillig 6543: </div>
1.148 asau 6544: <div class="sect2">
1.81 rillig 6545: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6546: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6547: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6548: all the distfiles exist in a local directory
1.93 rillig 6549: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6550: user). If the files do not exist, they are fetched using
6551: commands of the form</p>
1.75 rillig 6552: <pre class="programlisting">
1.100 rillig 6553: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6554: </pre>
1.88 wiz 6555: <p>where <code class="literal">${site}</code> varies through
6556: several possibilities in turn: first,
6557: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6558: sites specified in either <code class="varname">SITES.file</code> if
6559: defined, else <code class="varname">MASTER_SITES</code> or
6560: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6561: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6562: all except the first and the last can be optionally sorted
6563: by the user, via setting either
6564: <code class="varname">MASTER_SORT_RANDOM</code>, and
6565: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6566: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6567: <p> The specific command and arguments used depend on the
6568: <code class="varname">FETCH_USING</code> parameter. The example above is
6569: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6570: <p>The distfiles mirror run by the NetBSD Foundation uses the
6571: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6572: distfiles, if they are freely distributable. Packages setting
6573: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6574: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6575: mirrored.</p>
1.81 rillig 6576: </div>
1.75 rillig 6577: </div>
1.148 asau 6578: <div class="sect1">
1.75 rillig 6579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6580: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6581: <p>After the distfile(s) are fetched, their checksum is
6582: generated and compared with the checksums stored in the
6583: distinfo file. If the checksums don't match, the build is
6584: aborted. This is to ensure the same distfile is used for
6585: building, and that the distfile wasn't changed, e.g. by some
6586: malign force, deliberately changed distfiles on the master
6587: distribution site or network lossage.</p>
1.75 rillig 6588: </div>
1.148 asau 6589: <div class="sect1">
1.75 rillig 6590: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6591: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6592: <p>When the distfiles are present on the local system, they
1.88 wiz 6593: need to be extracted, as they usually come in the form of some
6594: compressed archive format.</p>
1.75 rillig 6595: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6596: extracted. If you only need some of them, you can set the
6597: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6598: files.</p>
6599: <p>Extracting the files is usually done by a little
1.93 rillig 6600: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6601: already knows how to extract various archive formats, so most
6602: likely you will not need to change anything here. But if you
6603: need, the following variables may help you:</p>
1.148 asau 6604: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6605: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6606: <dd><p>Use these variables to override the default
1.88 wiz 6607: options for an extract command, which are defined in
1.93 rillig 6608: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6609: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6610: <dd><p>This variable can be set to
1.114 jmcneill 6611: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6612: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6613: absolute pathname pointing to the command with which tar
1.114 jmcneill 6614: archives should be extracted. It is preferred to choose bsdtar over gtar
6615: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6616: </dl></div>
1.88 wiz 6617: <p>If the <code class="filename">extract</code> program doesn't
6618: serve your needs, you can also override the
6619: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6620: command used for extracting the files. This command is
6621: executed in the <code class="filename">${WRKSRC}</code>
6622: directory. During execution of this command, the shell
6623: variable <code class="varname">extract_file</code> holds the absolute
6624: pathname of the file that is going to be extracted.</p>
1.75 rillig 6625: <p>And if that still does not suffice, you can override the
1.88 wiz 6626: <code class="varname">do-extract</code> target in the package
6627: Makefile.</p>
1.75 rillig 6628: </div>
1.148 asau 6629: <div class="sect1">
1.75 rillig 6630: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6631: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6632: <p>After extraction, all the patches named by the
1.88 wiz 6633: <code class="varname">PATCHFILES</code>, those present in the patches
6634: subdirectory of the package as well as in
6635: $LOCALPATCHES/$PKGPATH (e.g.
6636: <code class="filename">/usr/local/patches/graphics/png</code>) are
6637: applied. Patchfiles ending in <code class="filename">.Z</code> or
6638: <code class="filename">.gz</code> are uncompressed before they are
6639: applied, files ending in <code class="filename">.orig</code> or
6640: <code class="filename">.rej</code> are ignored. Any special options to
1.189 snj 6641: <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 6642: <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 6643: <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 6644: it fail if the patches apply with some lines of fuzz. Please
6645: fix (regen) the patches so that they apply cleanly. The
6646: rationale behind this is that patches that don't apply cleanly
6647: may end up being applied in the wrong place, and cause severe
6648: harm there.</p>
1.75 rillig 6649: </div>
1.148 asau 6650: <div class="sect1">
1.75 rillig 6651: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6652: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6653: <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 6654: </p>
1.75 rillig 6655: </div>
1.148 asau 6656: <div class="sect1">
1.75 rillig 6657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6658: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6659: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6660: linkers. The following variables can be used to tweak the
6661: wrappers.</p>
1.148 asau 6662: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6663: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6664: <dd><p>The command used to print progress
1.88 wiz 6665: messages. Does nothing by default. Set to
6666: <code class="literal">${ECHO}</code> to see the progress
6667: messages.</p></dd>
1.75 rillig 6668: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6669: <dd><p>This variable can be set to
1.88 wiz 6670: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6671: depending on whether you want additional information in the
6672: wrapper log file.</p></dd>
1.75 rillig 6673: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6674: <dd><p>This variable can be set to
1.88 wiz 6675: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6676: on whether the wrapper should use its cache, which will
6677: improve the speed. The default value is
6678: <code class="literal">yes</code>, but is forced to
6679: <code class="literal">no</code> if the platform does not support
6680: it.</p></dd>
1.75 rillig 6681: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6682: <dd><p>A list of reordering commands. A reordering
6683: command has the form
6684: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6685: It ensures that that
6686: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6687: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6688: </p></dd>
1.75 rillig 6689: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6690: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6691: investigate further]</p></dd>
1.75 rillig 6692: </dl></div>
6693: </div>
1.148 asau 6694: <div class="sect1">
1.75 rillig 6695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6696: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6697: <p>Most pieces of software need information on the header
6698: files, system calls, and library routines which are available
6699: on the platform they run on. The process of determining this
6700: information is known as configuration, and is usually
6701: automated. In most cases, a script is supplied with the
6702: distfiles, and its invocation results in generation of header
6703: files, Makefiles, etc.</p>
6704: <p>If the package contains a configure script, this can be
6705: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6706: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6707: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6708: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6709: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6710: <pre class="programlisting">
1.100 rillig 6711: .for d in ${CONFIGURE_DIRS}
6712: cd ${WRKSRC} \
6713: && cd ${d} \
6714: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6715: .endfor
6716: </pre>
1.88 wiz 6717: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6718: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6719: <code class="varname">WRKSRC</code>. In each of these directories, the
6720: configure script is run with the environment
6721: <code class="varname">CONFIGURE_ENV</code> and arguments
6722: <code class="varname">CONFIGURE_ARGS</code>. The variables
6723: <code class="varname">CONFIGURE_ENV</code>,
6724: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6725: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6726: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6727: package.</p>
1.144 wiz 6728: <p>If the program uses the Perl way of configuration (mainly Perl
6729: modules, but not only), i.e. a file called
6730: <code class="filename">Makefile.PL</code>, it should include
6731: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6732: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6733: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6734: <p>If the program uses an <code class="filename">Imakefile</code>
6735: for configuration, the appropriate steps can be invoked by
6736: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6737: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6738: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6739: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6740: xmkmf's environment by adding them to the
6741: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6742: <p>If the program uses <code class="filename">cmake</code>
6743: for configuration, the appropriate steps can be invoked by
1.128 wiz 6744: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6745: You can add variables to cmake's environment by adding them to the
6746: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6747: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6748: The top directory argument is given by the
6749: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6750: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6751: <p>If there is no configure step at all, set
1.128 wiz 6752: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6753: </div>
1.148 asau 6754: <div class="sect1">
1.75 rillig 6755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6756: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6757: <p>For building a package, a rough equivalent of the
6758: following code is executed.</p>
1.75 rillig 6759: <pre class="programlisting">
1.100 rillig 6760: .for d in ${BUILD_DIRS}
6761: cd ${WRKSRC} \
6762: && cd ${d} \
6763: && env ${MAKE_ENV} \
6764: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6765: -f ${MAKE_FILE} \
6766: ${BUILD_TARGET}
6767: .endfor
6768: </pre>
1.88 wiz 6769: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6770: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6771: <code class="varname">WRKSRC</code>. In each of these directories,
6772: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6773: <code class="varname">MAKE_ENV</code> and arguments
6774: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6775: <code class="varname">MAKE_ENV</code>,
6776: <code class="varname">BUILD_MAKE_FLAGS</code>,
6777: <code class="varname">MAKE_FILE</code> and
6778: <code class="varname">BUILD_TARGET</code> may all be changed by the
6779: package.</p>
1.75 rillig 6780: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6781: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6782: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6783: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6784: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6785: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6786: <p>If there is no build step at all, set
1.128 wiz 6787: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6788: </div>
1.148 asau 6789: <div class="sect1">
1.75 rillig 6790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6791: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6792: <p>[TODO]</p>
6793: </div>
1.148 asau 6794: <div class="sect1">
1.75 rillig 6795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6796: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6797: <p>Once the build stage has completed, the final step is to
1.88 wiz 6798: install the software in public directories, so users can
6799: access the programs and files.</p>
1.75 rillig 6800: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6801: equivalent of the following code is executed. Additionally,
6802: before and after this code, much magic is performed to do
6803: consistency checks, registering the package, and so on.</p>
6804: <pre class="programlisting">
1.100 rillig 6805: .for d in ${INSTALL_DIRS}
6806: cd ${WRKSRC} \
6807: && cd ${d} \
6808: && env ${MAKE_ENV} \
6809: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6810: -f ${MAKE_FILE} \
6811: ${INSTALL_TARGET}
6812: .endfor
6813: </pre>
1.75 rillig 6814: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6815: <span class="emphasis"><em>build</em></span> phase.
6816: <code class="varname">INSTALL_DIRS</code> defaults to
6817: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6818: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6819: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6820: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6821: defined.</p>
1.75 rillig 6822: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6823: variables are useful. They are all variations of the
1.189 snj 6824: <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 6825: permissions preset. <code class="varname">INSTALL</code> is the plain
6826: install command. The specialized variants, together with their
6827: intended use, are:</p>
1.148 asau 6828: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6829: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6830: <dd><p>directories that contain
6831: binaries</p></dd>
1.75 rillig 6832: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6833: <dd><p>directories that contain
6834: scripts</p></dd>
1.75 rillig 6835: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6836: <dd><p>directories that contain shared and static
6837: libraries</p></dd>
1.75 rillig 6838: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6839: <dd><p>directories that contain data
6840: files</p></dd>
1.75 rillig 6841: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6842: <dd><p>directories that contain man
6843: pages</p></dd>
1.75 rillig 6844: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6845: <dd><p>binaries that can be stripped from debugging
6846: symbols</p></dd>
1.75 rillig 6847: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6848: <dd><p>binaries that cannot be
6849: stripped</p></dd>
1.75 rillig 6850: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6851: <dd><p>game
6852: binaries</p></dd>
1.75 rillig 6853: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6854: <dd><p>shared and static
6855: libraries</p></dd>
1.75 rillig 6856: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6857: <dd><p>data files</p></dd>
6858: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6859: <dd><p>data files for
6860: games</p></dd>
1.75 rillig 6861: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6862: <dd><p>man pages</p></dd>
6863: </dl></div>
6864: <p>Some other variables are:</p>
1.148 asau 6865: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6866: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6867: <dd><p>A list of directories relative to
1.88 wiz 6868: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6869: beginning of the <span class="emphasis"><em>install</em></span> phase.
6870: The package is supposed to create all needed directories itself
6871: before installing files to it and list all other directories here.
6872: </p></dd>
1.75 rillig 6873: </dl></div>
1.97 rillig 6874: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6875: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6876: mostly relevant for packages in the <code class="filename">regress</code>
6877: category.</p>
1.75 rillig 6878: </div>
1.148 asau 6879: <div class="sect1">
1.75 rillig 6880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6881: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6882: <p>Once the install stage has completed, a binary package of
6883: the installed files can be built. These binary packages can be
6884: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6885: the <span class="command"><strong>make bin-install</strong></span> or by using
6886: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6887: <p>By default, the binary packages are created in
6888: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6889: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6890: one for each category in the <code class="varname">CATEGORIES</code>
6891: variable. <code class="varname">PACKAGES</code> defaults to
6892: <code class="filename">pkgsrc/packages</code>.</p>
6893: </div>
1.148 asau 6894: <div class="sect1">
1.88 wiz 6895: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6896: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6897: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6898: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6899: to clean the work directories of all dependencies too, use
1.110 hubertf 6900: <span class="command"><strong>make clean-depends</strong></span>.</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.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6905: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6906: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6907: <dd><p>For any of the main targets described in the
6908: previous section, two auxiliary targets exist with
1.128 wiz 6909: <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 6910: prefix for the main target's name. These targets are
1.88 wiz 6911: invoked before and after the main target is called,
6912: allowing extra configuration or installation steps be
6913: performed from a package's Makefile, for example, which
6914: a program's configure script or install target
6915: omitted.</p></dd>
1.75 rillig 6916: <dt><span class="term">do-*</span></dt>
1.88 wiz 6917: <dd><p>Should one of the main targets do the wrong thing,
6918: and should there be no variable to fix this, you can
6919: redefine it with the do-* target. (Note that redefining
6920: the target itself instead of the do-* target is a bad
6921: idea, as the pre-* and post-* targets won't be called
6922: anymore, etc.) You will not usually need to do
6923: this.</p></dd>
1.75 rillig 6924: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6925: <dd>
1.110 hubertf 6926: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6927: you noticed some file was not installed properly, you
6928: can repeat the installation with this target, which will
1.128 wiz 6929: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6930: <p>This is the default value of
6931: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6932: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6933: package</strong></span>, where the defaults are
1.128 wiz 6934: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6935: respectively.</p>
6936: </dd>
1.75 rillig 6937: <dt><span class="term">deinstall</span></dt>
6938: <dd>
1.189 snj 6939: <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 6940: current directory, effectively de-installing the
6941: package. The following variables can be used to tune the
6942: behaviour:</p>
1.148 asau 6943: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6944: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.189 snj 6945: <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 6946: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6947: <dd><p>Remove all packages that require (depend on)
6948: the given package. This can be used to remove any
6949: packages that may have been pulled in by a given
1.110 hubertf 6950: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6951: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6952: <code class="filename">pkgsrc/x11/kde</code>, this is
6953: likely to remove whole KDE. Works by adding
1.189 snj 6954: <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 6955: command line.</p></dd>
1.75 rillig 6956: </dl></div>
6957: </dd>
1.88 wiz 6958: <dt><span class="term">bin-install</span></dt>
6959: <dd><p>Install a binary package from local disk and via FTP
6960: from a list of sites (see the
6961: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6962: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6963: available anywhere. The arguments given to
1.110 hubertf 6964: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6965: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6966: operation, etc.</p></dd>
1.75 rillig 6967: <dt><span class="term">update</span></dt>
6968: <dd>
1.88 wiz 6969: <p>This target causes the current package to be
6970: updated to the latest version. The package and all
6971: depending packages first get de-installed, then current
6972: versions of the corresponding packages get compiled and
6973: installed. This is similar to manually noting which
6974: packages are currently installed, then performing a
1.110 hubertf 6975: series of <span class="command"><strong>make deinstall</strong></span> and
6976: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 6977: <code class="varname">UPDATE_TARGET</code> is set to) for these
6978: packages.</p>
1.128 wiz 6979: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 6980: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 6981: update</strong></span> was interrupted for some reason.
6982: However, in this case, make sure you don't call
1.110 hubertf 6983: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 6984: list of dependent packages in <code class="varname">WRKDIR</code>.
6985: Otherwise, you lose the ability to automatically update
6986: the current package along with the dependent packages
6987: you have installed.</p>
1.110 hubertf 6988: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 6989: update</strong></span> will only work as long as the package
6990: tree remains unchanged. If the source code for one of
6991: the packages to be updated has been changed, resuming
1.110 hubertf 6992: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 6993: fail!</p>
6994: <p>The following variables can be used either on the
1.110 hubertf 6995: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6996: alter the behaviour of <span class="command"><strong>make
1.88 wiz 6997: update</strong></span>:</p>
1.148 asau 6998: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6999: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7000: <dd><p>Install target to recursively use for the
7001: updated package and the dependent packages.
7002: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7003: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7004: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7005: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7006: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7007: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7008: endless loop!</p></dd>
1.75 rillig 7009: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7010: <dd><p>Don't clean up after updating. Useful if
7011: you want to leave the work sources of the updated
7012: packages around for inspection or other purposes.
7013: Be sure you eventually clean up the source tree
1.128 wiz 7014: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7015: or you may run into troubles with old source code
7016: still lying around on your next
1.110 hubertf 7017: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7018: update</strong></span>.</p></dd>
1.75 rillig 7019: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7020: <dd><p>Deinstall each package before installing
7021: (making <code class="varname">DEPENDS_TARGET</code>). This
7022: may be necessary if the
1.128 wiz 7023: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7024: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7025: update</strong></span>.</p></dd>
1.75 rillig 7026: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7027: <dd><p>Allows you to disable recursion and hardcode
7028: the target for packages. The default is
1.128 wiz 7029: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7030: facilitating a recursive update of prerequisite
7031: packages. Only set
7032: <code class="varname">DEPENDS_TARGET</code> if you want to
7033: disable recursive updates. Use
7034: <code class="varname">UPDATE_TARGET</code> instead to just
7035: set a specific target for each package to be
1.110 hubertf 7036: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7037: (see above).</p></dd>
1.75 rillig 7038: </dl></div>
7039: </dd>
7040: <dt><span class="term">clean-update</span></dt>
7041: <dd>
1.88 wiz 7042: <p>Clean the source tree for all packages that would
1.110 hubertf 7043: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7044: from the current directory. This target should not be
7045: used if the current package (or any of its depending
7046: packages) have already been de-installed (e.g., after
1.110 hubertf 7047: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7048: some packages you intended to update. As a rule of
7049: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7050: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7051: and only if you have a dirty package tree (e.g., if you
7052: used <code class="varname">NOCLEAN</code>).</p>
7053: <p>If you are unsure about whether your tree is
1.110 hubertf 7054: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7055: clean</strong></span> at the top of the tree, or use the
7056: following sequence of commands from the directory of the
7057: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7058: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7059: time, otherwise you lose all the packages you wanted to
7060: update!):</p>
1.87 wiz 7061: <pre class="screen">
7062: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7063: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7064: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7065: </pre>
1.88 wiz 7066: <p>The following variables can be used either on the
1.110 hubertf 7067: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7068: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 7069: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7070: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7071: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7072: reconstruct the list of directories to update for
1.110 hubertf 7073: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7074: update</strong></span> successfully installed all
7075: packages you wanted to update. Normally, this is
1.110 hubertf 7076: done automatically on <span class="command"><strong>make
1.88 wiz 7077: update</strong></span>, but may have been suppressed by
7078: the <code class="varname">NOCLEAN</code> variable (see
7079: above).</p></dd>
1.75 rillig 7080: </dl></div>
7081: </dd>
1.88 wiz 7082: <dt><span class="term">replace</span></dt>
7083: <dd>
7084: <p>Update the installation of the current package. This
7085: differs from update in that it does not replace dependent
1.189 snj 7086: 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 7087: target to work.</p>
7088: <p><span class="emphasis"><em>Be careful when using this
7089: target!</em></span> There are no guarantees that dependent
7090: packages will still work, in particular they will most
1.110 hubertf 7091: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7092: library package whose shared library major version changed
7093: between your installed version and the new one. For this
7094: reason, this target is not officially supported and only
7095: recommended for advanced users.</p>
7096: </dd>
1.75 rillig 7097: <dt><span class="term">info</span></dt>
1.189 snj 7098: <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 7099: package. You can use this to check which version of a
7100: package is installed.</p></dd>
7101: <dt><span class="term">index</span></dt>
7102: <dd>
7103: <p>This is a top-level command, i.e. it should be used in
7104: the <code class="filename">pkgsrc</code> directory. It creates a
7105: database of all packages in the local pkgsrc tree, including
7106: dependencies, comment, maintainer, and some other useful
7107: information. Individual entries are created by running
1.110 hubertf 7108: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7109: directories. This index file is saved as
7110: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7111: verbose format by running <span class="command"><strong>make
1.88 wiz 7112: print-index</strong></span>. You can search in it with
1.110 hubertf 7113: <span class="command"><strong>make search
1.88 wiz 7114: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7115: extract a list of all packages that depend on a particular
1.110 hubertf 7116: one by running <span class="command"><strong>make show-deps
1.88 wiz 7117: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7118: <p>Running this command takes a very long time, some
7119: hours even on fast machines!</p>
7120: </dd>
1.75 rillig 7121: <dt><span class="term">readme</span></dt>
1.88 wiz 7122: <dd>
7123: <p>This target generates a
7124: <code class="filename">README.html</code> file, which can be
1.189 snj 7125: 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 7126: contain references to any packages which are in the
7127: <code class="varname">PACKAGES</code> directory on the local
7128: host. The generated files can be made to refer to URLs
7129: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7130: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7131: wanted to generate <code class="filename">README.html</code>
7132: files which pointed to binary packages on the local
7133: machine, in the directory
7134: <code class="filename">/usr/packages</code>, set
7135: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7136: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7137: <code class="varname">${PACKAGES}</code> directory and its
7138: subdirectories will be searched for all the binary
7139: packages.</p>
7140: <p>The target can be run at the toplevel or in category
7141: directories, in which case it descends recursively.</p>
7142: </dd>
1.75 rillig 7143: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7144: <dd><p>This is a top-level command, run it in
7145: <code class="filename">pkgsrc</code>. Use this target to create a
7146: file <code class="filename">README-all.html</code> which contains a
7147: list of all packages currently available in the NetBSD
7148: Packages Collection, together with the category they belong
7149: to and a short description. This file is compiled from the
7150: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7151: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7152: readme</strong></span>.</p></dd>
1.75 rillig 7153: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7154: <dd><p>This is very much the same as the
1.128 wiz 7155: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7156: used when generating a pkgsrc tree to be written to a
7157: CD-ROM. This target also produces
7158: <code class="filename">README.html</code> files, and can be made
7159: to refer to URLs based on
7160: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7161: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7162: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7163: <dd><p>This target shows which distfiles and patchfiles
7164: are needed to build the package
7165: (<code class="varname">ALLFILES</code>, which contains all
7166: <code class="varname">DISTFILES</code> and
1.87 wiz 7167: <code class="varname">PATCHFILES</code>, but not
7168: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7169: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7170: <dd><p>This target shows nothing if the package is not
7171: installed. If a version of this package is installed,
7172: but is not the version provided in this version of
7173: pkgsrc, then a warning message is displayed. This target
7174: can be used to show which of your installed packages are
7175: downlevel, and so the old versions can be deleted, and
7176: the current ones added.</p></dd>
1.75 rillig 7177: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7178: <dd><p>This target shows the directory in the pkgsrc
7179: hierarchy from which the package can be built and
7180: installed. This may not be the same directory as the one
7181: from which the package was installed. This target is
7182: intended to be used by people who may wish to upgrade
7183: many packages on a single host, and can be invoked from
7184: the top-level pkgsrc Makefile by using the
1.128 wiz 7185: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7186: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7187: <dd><p>This target shows which installed packages match
7188: the current package's <code class="varname">DEPENDS</code>. Useful
7189: if out of date dependencies are causing build
7190: problems.</p></dd>
1.75 rillig 7191: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7192: <dd><p>After a package is installed, check all its
7193: binaries and (on ELF platforms) shared libraries to see
7194: if they find the shared libs they need. Run by default
1.110 hubertf 7195: 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 7196: <dt><span class="term">print-PLIST</span></dt>
7197: <dd>
1.128 wiz 7198: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7199: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7200: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7201: -newer work/.extract_done</strong></span>. An attempt is made
7202: to care for shared libs etc., but it is
1.87 wiz 7203: <span class="emphasis"><em>strongly</em></span> recommended to review the
7204: result before putting it into
7205: <code class="filename">PLIST</code>. On upgrades, it's useful to
7206: diff the output of this command against an already
7207: existing <code class="filename">PLIST</code> file.</p>
1.189 snj 7208: <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 7209: other methods that don't update file access times, be
7210: sure to add these files manually to your
1.128 wiz 7211: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7212: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7213: them!</p>
1.128 wiz 7214: <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 7215: information on this target.</p>
1.75 rillig 7216: </dd>
7217: <dt><span class="term">bulk-package</span></dt>
7218: <dd>
1.88 wiz 7219: <p>Used to do bulk builds. If an appropriate binary
7220: package already exists, no action is taken. If not, this
7221: target will compile, install and package it (and its
7222: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 7223: 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
7224: builds)</i></a>).
1.88 wiz 7225: After creating the binary package, the sources, the
7226: just-installed package and its required packages are
7227: removed, preserving free disk space.</p>
7228: <p><span class="emphasis"><em>Beware that this target may deinstall
7229: all packages installed on a system!</em></span></p>
1.75 rillig 7230: </dd>
7231: <dt><span class="term">bulk-install</span></dt>
7232: <dd>
1.88 wiz 7233: <p>Used during bulk-installs to install required
7234: packages. If an up-to-date binary package is available,
1.189 snj 7235: 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 7236: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7237: but the installed binary won't be removed.</p>
1.88 wiz 7238: <p>A binary package is considered
1.128 wiz 7239: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.189 snj 7240: <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 7241: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7242: <li class="listitem"><p>None of the package's files
1.88 wiz 7243: (<code class="filename">Makefile</code>, ...) were modified
7244: since it was built.</p></li>
1.128 wiz 7245: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7246: packages were modified since it was built.</p></li>
1.75 rillig 7247: </ul></div>
1.88 wiz 7248: <p><span class="emphasis"><em>Beware that this target may deinstall
7249: all packages installed on a system!</em></span></p>
1.75 rillig 7250: </dd>
7251: </dl></div>
7252: </div>
7253: </div>
1.148 asau 7254: <div class="chapter">
1.75 rillig 7255: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7256: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7257: <div class="toc">
7258: <p><b>Table of Contents</b></p>
1.195 wiz 7259: <dl class="toc">
1.106 rillig 7260: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7261: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7262: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7263: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7264: </dl>
7265: </div>
1.87 wiz 7266: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7267: by pkgsrc and also for individual packages to define what commands
7268: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7269: or for later run-time of an installed packaged (such as
7270: <code class="varname">DEPENDS</code>).
7271: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7272: package will not be used.</p>
7273: <p>When building a package, the replacement tools are
1.75 rillig 7274: made available in a directory (as symlinks or wrapper scripts)
7275: that is early in the executable search path. Just like the buildlink
1.87 wiz 7276: system, this helps with consistent builds.</p>
7277: <p>A tool may be needed to help build a specific package. For example,
7278: perl, GNU make (gmake) or yacc may be needed.</p>
7279: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7280: tool may be inefficient for building a package with pkgsrc.
7281: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7282: yacc) or a better sed.</p>
7283: <p>The tools used by a package can be listed by running
1.110 hubertf 7284: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 7285: <div class="sect1">
1.75 rillig 7286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7287: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7288: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7289: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7290: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7291: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7292: These can be seen by running:
1.110 hubertf 7293: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7294: <p>If a package needs a specific program to build
1.75 rillig 7295: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7296: to define the tools needed.</p>
1.75 rillig 7297: </div>
1.148 asau 7298: <div class="sect1">
1.75 rillig 7299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7300: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7301: <p>In the following examples, the :run means that it is needed at
7302: run-time (and becomes a DEPENDS).
1.75 rillig 7303: The default is a build dependency which can be set with
7304: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7305: and pkg-config:build.)</p>
1.75 rillig 7306: <pre class="programlisting">
7307: USE_TOOLS+= gmake perl:run pkg-config
7308: </pre>
1.87 wiz 7309: <p>When using the tools framework, a
1.75 rillig 7310: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7311: which contains the full path to the appropriate tool. For example,
1.128 wiz 7312: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7313: on Linux systems.</p>
7314: <p>If you always need a pkgsrc version of the
1.75 rillig 7315: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7316: </p>
7317: </div>
1.148 asau 7318: <div class="sect1">
1.75 rillig 7319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7320: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7321: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7322: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7323: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7324: the name of the common tools. For example:</p>
7325: <pre class="programlisting">
7326: .if exists(/usr/bin/bzcat)
7327: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7328: .elif exists(/usr/bin/bzip2)
7329: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7330: .endif
1.69 rillig 7331:
1.75 rillig 7332: TOOLS_PLATFORM.true?= true # shell builtin
7333: </pre>
7334: </div>
1.148 asau 7335: <div class="sect1">
1.97 rillig 7336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7337: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 asau 7338: <div class="qandaset">
1.196 ! wiz 7339: <a name="idm75787664"></a><dl>
1.106 rillig 7340: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7341: </dt>
1.106 rillig 7342: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7343: tools?</a>
7344: </dt>
1.106 rillig 7345: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7346: package is using while being built? I want to know whether it
7347: uses sed or not.</a>
7348: </dt>
7349: </dl>
1.148 asau 7350: <table border="0" style="width: 100%;">
7351: <colgroup>
1.97 rillig 7352: <col align="left" width="1%">
1.128 wiz 7353: <col>
1.148 asau 7354: </colgroup>
1.97 rillig 7355: <tbody>
1.148 asau 7356: <tr class="question">
1.97 rillig 7357: <td align="left" valign="top">
1.196 ! wiz 7358: <a name="tools.new"></a><a name="idm75787280"></a><p><b>18.4.1.</b></p>
1.97 rillig 7359: </td>
7360: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7361: </tr>
7362: <tr class="answer">
7363: <td align="left" valign="top"></td>
7364: <td align="left" valign="top"><p>TODO</p></td>
7365: </tr>
1.148 asau 7366: <tr class="question">
1.97 rillig 7367: <td align="left" valign="top">
1.196 ! wiz 7368: <a name="tools.listall"></a><a name="idm75786256"></a><p><b>18.4.2.</b></p>
1.97 rillig 7369: </td>
7370: <td align="left" valign="top"><p>How do I get a list of all available
7371: tools?</p></td>
7372: </tr>
7373: <tr class="answer">
7374: <td align="left" valign="top"></td>
7375: <td align="left" valign="top"><p>TODO</p></td>
7376: </tr>
1.148 asau 7377: <tr class="question">
1.97 rillig 7378: <td align="left" valign="top">
1.196 ! wiz 7379: <a name="tools.used"></a><a name="idm75785104"></a><p><b>18.4.3.</b></p>
1.97 rillig 7380: </td>
7381: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7382: package is using while being built? I want to know whether it
7383: uses sed or not.</p></td>
7384: </tr>
7385: <tr class="answer">
7386: <td align="left" valign="top"></td>
7387: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7388: to do it.)</p></td>
7389: </tr>
7390: </tbody>
7391: </table>
7392: </div>
7393: </div>
1.75 rillig 7394: </div>
1.148 asau 7395: <div class="chapter">
1.75 rillig 7396: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7397: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7398: <div class="toc">
7399: <p><b>Table of Contents</b></p>
1.195 wiz 7400: <dl class="toc">
1.106 rillig 7401: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7402: <dd><dl>
1.106 rillig 7403: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7404: <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 7405: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7406: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7407: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7408: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7409: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7410: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7411: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7412: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7413: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7414: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7415: </dl></dd>
1.128 wiz 7416: <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 7417: <dd><dl>
7418: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7419: <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>
7420: </dl></dd>
1.128 wiz 7421: <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 7422: <dd><dl>
7423: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7424: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7425: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7426: </dl></dd>
7427: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7428: <dd><dl>
7429: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7430: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7431: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7432: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7433: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7434: </dl></dd>
1.128 wiz 7435: <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 7436: <dd><dl>
7437: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7438: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7439: <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 7440: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7441: </dl></dd>
1.128 wiz 7442: <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 7443: <dd><dl>
7444: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7445: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7446: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7447: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7448: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7449: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7450: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7451: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7452: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7453: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7454: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7455: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7456: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7457: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7458: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7459: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7460: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7461: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7462: emulation</a></span></dt>
1.106 rillig 7463: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7464: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7465: </dl></dd>
1.106 rillig 7466: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7467: </dl>
7468: </div>
1.148 asau 7469: <div class="sect1">
1.75 rillig 7470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7471: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 asau 7472: <div class="sect2">
1.75 rillig 7473: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7474: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7475: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7476: different platforms. As a result, it is important to ensure,
7477: where possible, that packages in pkgsrc are portable. This
7478: chapter mentions some particular details you should pay
7479: attention to while working on pkgsrc.</p>
1.78 rillig 7480: </div>
1.148 asau 7481: <div class="sect2">
1.78 rillig 7482: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7483: <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 7484: </h3></div></div></div>
1.78 rillig 7485: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7486: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7487: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7488: want to use those variables in the preprocessor directives of
1.189 snj 7489: <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 7490: <code class="literal">.for</code>), you need to include the file
7491: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7492: loads the user preferences.</p>
1.78 rillig 7493: <p>But note that some variables may not be completely defined
1.87 wiz 7494: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7495: included, as they may contain references to variables that are
7496: not yet defined. In shell commands this is no problem, since
7497: variables are actually macros, which are only expanded when they
7498: are used. But in the preprocessor directives mentioned above and
7499: in dependency lines (of the form <code class="literal">target:
7500: dependencies</code>) the variables are expanded at load
7501: time.</p>
1.148 asau 7502: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7503: <h3 class="title">Note</h3>
7504: <p>Currently there is no exhaustive list of all
1.87 wiz 7505: variables that tells you whether they can be used at load time
7506: or only at run time, but it is in preparation.</p>
1.78 rillig 7507: </div>
7508: </div>
1.148 asau 7509: <div class="sect2">
1.78 rillig 7510: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7511: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7512: <p>Occasionally, packages require interaction from the user,
7513: and this can be in a number of ways:</p>
1.148 asau 7514: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7515: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7516: interaction such as entering username/password or accepting a
7517: license on a web page.</p></li>
1.128 wiz 7518: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7519: passwords.</p></li>
1.128 wiz 7520: <li class="listitem"><p>help to configure the package before it is built</p></li>
7521: <li class="listitem"><p>help during the build process</p></li>
7522: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7523: </ul></div>
1.88 wiz 7524: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7525: provided to notify the pkgsrc mechanism of an interactive stage
7526: which will be needed, and this should be set in the package's
7527: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7528: <pre class="programlisting">
1.100 rillig 7529: INTERACTIVE_STAGE= build
1.87 wiz 7530: </pre>
1.78 rillig 7531: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7532: <pre class="programlisting">
1.100 rillig 7533: INTERACTIVE_STAGE= configure install
1.87 wiz 7534: </pre>
1.88 wiz 7535: <p>The user can then decide to skip this package by setting the
7536: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7537: </div>
1.148 asau 7538: <div class="sect2">
1.75 rillig 7539: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7540: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7541: <p>Authors of software can choose the licence under which
7542: software can be copied. This is due to copyright law, and reasons
7543: for license choices are outside the scope of pkgsrc. The pkgsrc
7544: system recognizes that there are a number of licenses which some
7545: users may find objectionable or difficult or impossible to comply
7546: with. The Free Software Foundation has declared some licenses
7547: "Free", and the Open Source Initiative has a definition of "Open
7548: Source". The pkgsrc system, as a policy choice, does not label
7549: packages which have licenses that are Free or Open Source.
7550: However, packages without a license meeting either of those tests
7551: are labeled with a license tag denoting the license. Note that a
7552: package with no license to copy trivially does not meet either the
7553: Free or Open Source test.</p>
7554: <p>For packages which are not Free or Open Source, pkgsrc will
7555: not build the package unless the user has indicated to pkgsrc that
7556: packages with that particular license may be built. Note that
7557: this documentation avoids the term "accepted the license". The
7558: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7559: accidentally building a package with a non-free license;
1.98 wiz 7560: judgement and responsibility remain with the user. (Installation
7561: of binary packages are not currently subject to this mechanism;
7562: this is a bug.)</p>
7563: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7564: or the GPL, and not the other. The free licenses are added to the
7565: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7566: user can override the default by setting the
7567: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7568: of "+=". The licenses accepted by default are:
7569: </p>
7570: <pre class="programlisting">
1.154 rodent 7571: apache-1.1 apache-2.0
7572: arphic-public
7573: artistic artistic-2.0
7574: boost-license
7575: cc-by-sa-v3.0
1.161 ryoon 7576: cc0-1.0-universal
1.154 rodent 7577: cddl-1.0
7578: cpl-1.0
7579: epl-v1.0
7580: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7581: gnu-gpl-v1
7582: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7583: gnu-gpl-v3 gnu-lgpl-v3
7584: ibm-public-license-1.0
7585: ipafont
7586: isc
7587: lppl-1.3c
7588: lucent
7589: miros
7590: mit
7591: mpl-1.0 mpl-1.1 mpl-2.0
7592: mplusfont
7593: ofl-v1.0 ofl-v1.1
7594: original-bsd modified-bsd 2-clause-bsd
7595: php
7596: png-license
7597: postgresql-license
7598: public-domain
7599: python-software-foundation
7600: qpl-v1.0
1.158 rodent 7601: sgi-free-software-b-v2.0
1.154 rodent 7602: sleepycat-public
7603: unlicense
7604: x11
7605: zlib
7606: zpl
1.121 jnemeth 7607: </pre>
7608: <p>
7609: </p>
1.78 rillig 7610: <p>The license tag mechanism is intended to address
1.87 wiz 7611: copyright-related issues surrounding building, installing and
7612: using a package, and not to address redistribution issues (see
7613: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7614: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7615: Packages with redistribution restrictions should set these
7616: tags.</p>
1.98 wiz 7617: <p>Denoting that a package may be copied according to a
7618: particular license is done by placing the license in
1.87 wiz 7619: <code class="filename">pkgsrc/licenses</code> and setting the
7620: <code class="varname">LICENSE</code> variable to a string identifying the
1.189 snj 7621: 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 7622: <pre class="programlisting">
1.100 rillig 7623: LICENSE= xv-license
1.87 wiz 7624: </pre>
7625: <p>When trying to build, the user will get a notice that the
1.98 wiz 7626: package is covered by a license which has not been placed in the
7627: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7628: <pre class="programlisting">
1.100 rillig 7629: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7630: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7631: ===> To view the license, enter "/usr/bin/make show-license".
7632: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7633: ===> ACCEPTABLE_LICENSES+=xv-license
7634: *** Error code 1
1.87 wiz 7635: </pre>
1.110 hubertf 7636: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7637: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7638: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7639: convey to pkgsrc that it should not in the future fail because of
7640: that license:</p>
1.78 rillig 7641: <pre class="programlisting">
1.100 rillig 7642: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7643: </pre>
1.154 rodent 7644: <p>When adding a package with a new license, the following steps
7645: are required:</p>
7646: <div class="orderedlist"><ol class="orderedlist" type="1">
7647: <li class="listitem">
7648: <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>
7649: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7650: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7651: <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 7652: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154 rodent 7653: </ul></div>
7654: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7655: </li>
7656: <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>
7657: </ol></div>
1.98 wiz 7658: <p>When the license changes (in a way other than formatting),
7659: please make sure that the new license has a different name (e.g.,
7660: append the version number if it exists, or the date). Just
7661: because a user told pkgsrc to build programs under a previous
7662: version of a license does not mean that pkgsrc should build
1.99 rillig 7663: programs under the new licenses. The higher-level point is that
1.98 wiz 7664: pkgsrc does not evaluate licenses for reasonableness; the only
7665: test is a mechanistic test of whether a particular text has been
7666: approved by either of two bodies.</p>
1.78 rillig 7667: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7668: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7669: is deprecated because it does not crisply refer to a particular
7670: license text. Another problem with such usage is that it does not
7671: enable a user to tell pkgsrc to proceed for a single package
7672: without also telling pkgsrc to proceed for all packages with that
7673: tag.</p>
1.75 rillig 7674: </div>
1.148 asau 7675: <div class="sect2">
1.75 rillig 7676: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7677: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7678: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7679: Because a license tag is required unless the package is Free or
7680: Open Source, all packages with restrictions should have license
7681: tags. By declaring the restrictions, package tools can
7682: automatically refrain from e.g. placing binary packages on FTP
7683: sites.</p>
7684: <p>There are four restrictions that may be encoded, which are
7685: the cross product of sources (distfiles) and binaries not being
7686: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7687: language in any license, and because non-Free licenses tend to be
7688: different from each other, pkgsrc adopts a definition of FTP and
7689: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7690: should not be made available over the Internet at no charge.
7691: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7692: made available on some kind of media, together with other source
7693: and binary packages, and which is sold for a distribution charge.
7694: </p>
7695: <p>In order to encode these restrictions, the package system
1.87 wiz 7696: defines five make variables that can be set to note these
7697: restrictions:</p>
1.148 asau 7698: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7699: <li class="listitem">
1.75 rillig 7700: <p><code class="varname">RESTRICTED</code></p>
7701: <p>This variable should be set whenever a restriction
1.87 wiz 7702: exists (regardless of its kind). Set this variable to a
1.98 wiz 7703: string containing the reason for the restriction. It should
7704: be understood that those wanting to understand the restriction
7705: will have to read the license, and perhaps seek advice of
7706: counsel.</p>
1.75 rillig 7707: </li>
1.128 wiz 7708: <li class="listitem">
1.75 rillig 7709: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7710: <p>Binaries may not be placed on CD-ROM containing other
7711: binary packages, for which a distribution charge may be made.
7712: In this case, set this variable to
7713: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7714: </li>
1.128 wiz 7715: <li class="listitem">
1.75 rillig 7716: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7717: <p>Binaries may not made available on the Internet without
7718: charge. In this case, set this variable to
7719: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7720: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7721: </li>
1.128 wiz 7722: <li class="listitem">
1.75 rillig 7723: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7724: <p>Distfiles may not be placed on CD-ROM, together with
7725: other distfiles, for which a fee may be charged. In this
7726: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7727: </p>
1.75 rillig 7728: </li>
1.128 wiz 7729: <li class="listitem">
1.75 rillig 7730: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7731: <p>Distfiles may not made available via FTP at no charge.
7732: In this case, set this variable to
7733: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7734: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7735: </li>
7736: </ul></div>
1.139 wiz 7737: <p>Please note that packages will to be removed from pkgsrc
7738: when the distfiles are not distributable and cannot be obtained
7739: for a period of one full quarter branch. Packages with manual /
7740: interactive fetch must have a maintainer and it is his/her
7741: responsibility to ensure this.</p>
1.75 rillig 7742: </div>
1.148 asau 7743: <div class="sect2">
1.75 rillig 7744: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7745: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7746: <p>Your package may depend on some other package being present
1.88 wiz 7747: - and there are various ways of expressing this dependency.
7748: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7749: <code class="varname">DEPENDS</code> definitions, the
7750: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7751: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7752: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7753: 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 7754: <p>The basic difference between the two variables is as
1.87 wiz 7755: follows: The <code class="varname">DEPENDS</code> definition registers
7756: that pre-requisite in the binary package so it will be pulled in
7757: when the binary package is later installed, whilst the
7758: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7759: dependency that is only needed for building the package.</p>
1.75 rillig 7760: <p>This means that if you only need a package present whilst
1.87 wiz 7761: you are building, it should be noted as a
7762: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7763: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7764: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7765: <pre class="programlisting">
1.100 rillig 7766: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7767: </pre>
1.128 wiz 7768: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7769: may include any of the wildcard version numbers recognized by
1.189 snj 7770: <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 7771: <div class="orderedlist"><ol class="orderedlist" type="1">
7772: <li class="listitem">
1.75 rillig 7773: <p>If your package needs another package's binaries or
1.160 wiz 7774: libraries to build and run, and if that package has a
1.87 wiz 7775: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7776: <pre class="programlisting">
1.100 rillig 7777: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7778: </pre>
1.75 rillig 7779: </li>
1.128 wiz 7780: <li class="listitem">
1.160 wiz 7781: <p>If your package needs another package's binaries or
7782: libraries only for building, and if that package has a
7783: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7784: <pre class="programlisting">
7785: .include "../../graphics/jpeg/buildlink3.mk"
7786: </pre>
7787: <p>but set
7788: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7789: to make it a build dependency only. This case is rather
7790: rare.</p>
7791: </li>
7792: <li class="listitem">
1.132 spz 7793: <p>If your package needs binaries from another package to build,
7794: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7795: <pre class="programlisting">
1.132 spz 7796: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 7797: </pre>
1.75 rillig 7798: </li>
1.132 spz 7799: <li class="listitem"><p>If your package needs a library with which to link and
7800: there is no <code class="filename">buildlink3.mk</code> file
7801: available, create one. Using
7802: <code class="varname">DEPENDS</code> won't be sufficient because the
7803: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7804: <li class="listitem">
1.132 spz 7805: <p>If your package needs some executable to be able to run
7806: correctly and if there's no
7807: <code class="filename">buildlink3.mk</code> file, this is specified
7808: using the <code class="varname">DEPENDS</code> variable. The
1.189 snj 7809: <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 7810: be able to execute the latex binary from the teTeX package
7811: when it runs, and that is specified:</p>
1.75 rillig 7812: <pre class="programlisting">
1.132 spz 7813: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7814: </pre>
1.132 spz 7815: </li>
7816: <li class="listitem">
7817: <p>You can use wildcards in package dependencies. Note that
7818: such wildcard dependencies are retained when creating binary
7819: packages. The dependency is checked when installing the binary
7820: package and any package which matches the pattern will be
7821: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7822: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7823: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7824: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7825: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7826: <p>Wildcards can also be used to specify that a package
1.87 wiz 7827: will only build against a certain minimum version of a
7828: pre-requisite:</p>
1.75 rillig 7829: <pre class="programlisting">
1.132 spz 7830: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 7831: </pre>
1.132 spz 7832: <p>This means that the package will build using version 6.0
7833: of ImageMagick or newer. Such a dependency may be warranted
7834: if, for example, the command line options of an executable
7835: have changed.</p>
7836: <p>If you need to depend on minimum versions of libraries,
7837: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7838: <p>For security fixes, please update the package
1.110 hubertf 7839: 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 7840: information.</p>
1.75 rillig 7841: </li>
1.165 bsiegert 7842: <li class="listitem">
7843: <p>If the package depends on either one of two (or more)
7844: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7845: comma-separated list between curly braces.</p>
7846: <p>As an example, take a package that depends on the Perl
7847: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7848: itself since version 5.10.0. This either/or dependency is
7849: expressed as:</p>
7850: <pre class="programlisting">
7851: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7852: </pre>
7853: </li>
1.75 rillig 7854: </ol></div>
7855: <p>If your package needs files from another package to build,
1.87 wiz 7856: add the relevant distribution files to
7857: <code class="varname">DISTFILES</code>, so they will be extracted
1.189 snj 7858: 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 7859: (It relies on the jpeg sources being present in source form
7860: during the build.)</p>
1.75 rillig 7861: </div>
1.148 asau 7862: <div class="sect2">
1.75 rillig 7863: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7864: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7865: <p>Your package may conflict with other packages a user might
1.87 wiz 7866: already have installed on his system, e.g. if your package
1.88 wiz 7867: installs the same set of files as another package in the pkgsrc
1.190 wiz 7868: tree or has the same <code class="varname">PKGNAME</code>.</p>
7869: <p>These cases are handled automatically by the packaging tools
7870: at package installation time and do not need to be handled
7871: manually.</p>
7872: <p>In case the conflicts can not be recognized automatically
7873: (e.g., packages using the same config file location but no other
7874: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7875: space-separated list of packages (including version string) your
7876: package conflicts with.</p>
1.190 wiz 7877: <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>
7878: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7879: use the same config file, you would set in
7880: <code class="filename">foo/bar/Makefile</code>:</p>
1.87 wiz 7881: <pre class="programlisting">
1.190 wiz 7882: CONFLICTS= baz-[0-9]*
1.87 wiz 7883: </pre>
1.190 wiz 7884: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75 rillig 7885: <pre class="programlisting">
1.190 wiz 7886: CONFLICTS= bar-[0-9]*
1.87 wiz 7887: </pre>
1.75 rillig 7888: </div>
1.148 asau 7889: <div class="sect2">
1.75 rillig 7890: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7891: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7892: <p>There are several reasons why a package might be
1.88 wiz 7893: instructed to not build under certain circumstances. If the
1.87 wiz 7894: package builds and runs on most platforms, the exceptions
1.193 dholland 7895: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7896: the package builds and runs on a small handful of platforms,
7897: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7898: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7899: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7900: (OS-version-platform) that can use glob-style
7901: wildcards.</p>
7902: <p>If a package is not appropriate for some platforms (as
7903: oopposed to merely broken), a different set of variables should be
7904: used as this affects failure reporting and statistics.
7905: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7906: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7907: the package is appropriate for only a small handful of platforms
7908: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7909: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7910: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7911: (OS-version-platform) that can use glob-style
7912: wildcards.</p>
1.88 wiz 7913: <p>Some packages are tightly bound to a specific version of an
1.189 snj 7914: 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 7915: backwards compatible with other versions of the OS, and should be
7916: uploaded to a version specific directory on the FTP server. Mark
7917: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7918: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7919: the package system internals, but may be used in the
7920: future.</p>
1.75 rillig 7921: <p>If the package should be skipped (for example, because it
1.87 wiz 7922: provides functionality already provided by the system), set
1.88 wiz 7923: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7924: the package should fail because some preconditions are not met,
7925: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7926: message.</p>
1.75 rillig 7927: </div>
1.148 asau 7928: <div class="sect2">
1.75 rillig 7929: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7930: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7931: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7932: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7933: be set in the package Makefile. This will be carried into any
7934: binary package that is made from this pkgsrc entry. A
1.128 wiz 7935: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.189 snj 7936: 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 7937: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7938: </div>
1.148 asau 7939: <div class="sect2">
1.75 rillig 7940: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7941: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7942: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7943: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7944: and after committing that file, ask pkgsrc-security@NetBSD.org to
7945: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7946: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7947: <code class="varname">PKGREVISION</code> should be increased (this is of
7948: course not necessary if the problem is fixed by using a newer
7949: release of the software), and the pattern in the
7950: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7951: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7952: branch, be sure to submit a pullup request!</p>
1.75 rillig 7953: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7954: semi-automatically by a weekly cron job.</p>
1.75 rillig 7955: </div>
1.148 asau 7956: <div class="sect2">
1.75 rillig 7957: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7958: <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 7959: <p>When making fixes to an existing package it can be useful
1.87 wiz 7960: to change the version number in <code class="varname">PKGNAME</code>. To
7961: avoid conflicting with future versions by the original author, a
1.128 wiz 7962: <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 7963: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7964: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7965: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7966: <pre class="programlisting">
1.100 rillig 7967: DISTNAME= foo-17.42
7968: PKGREVISION= 9
1.87 wiz 7969: </pre>
1.75 rillig 7970: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7971: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7972: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7973: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7974: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7975: <p>When a new release of the package is released, the
1.87 wiz 7976: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7977: minor release of the above package, things should be like:</p>
1.75 rillig 7978: <pre class="programlisting">
1.100 rillig 7979: DISTNAME= foo-17.43
1.87 wiz 7980: </pre>
7981: <p><code class="varname">PKGREVISION</code> should be incremented for any
7982: non-trivial change in the resulting binary package. Without a
7983: <code class="varname">PKGREVISION</code> bump, someone with the previous
7984: version installed has no way of knowing that their package is out
7985: of date. Thus, changes without increasing
7986: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7987: trivial that no reasonable person would want to upgrade", and this
7988: is the rough test for when increasing
7989: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7990: changes that do not merit increasing
7991: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7992: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7993: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 7994: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 7995: or comments in Makefile.</p></li>
1.128 wiz 7996: <li class="listitem"><p>
1.100 rillig 7997: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 7998: <li class="listitem"><p>
1.100 rillig 7999: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8000: <li class="listitem"><p>
1.100 rillig 8001: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8002: </ul></div>
1.87 wiz 8003: <p>Examples of changes that do merit an increase to
8004: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 8005: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8006: <li class="listitem"><p>
1.100 rillig 8007: Security fixes</p></li>
1.128 wiz 8008: <li class="listitem"><p>
1.100 rillig 8009: Changes or additions to a patch file</p></li>
1.128 wiz 8010: <li class="listitem"><p>
1.100 rillig 8011: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8012: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8013: </ul></div>
1.78 rillig 8014: <p>PKGREVISION must also be incremented when dependencies have ABI
8015: changes.</p>
1.75 rillig 8016: </div>
1.148 asau 8017: <div class="sect2">
1.79 rillig 8018: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8019: <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 8020: <p>When you want to replace the same text in multiple files
1.87 wiz 8021: or when the replacement text varies, patches alone cannot help.
8022: This is where the SUBST framework comes in. It provides an
8023: easy-to-use interface for replacing text in files.
8024: Example:</p>
8025: <pre class="programlisting">
1.100 rillig 8026: SUBST_CLASSES+= fix-paths
8027: SUBST_STAGE.fix-paths= pre-configure
8028: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8029: SUBST_FILES.fix-paths= src/*.c
8030: SUBST_FILES.fix-paths+= scripts/*.sh
8031: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8032: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8033: </pre>
1.79 rillig 8034: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8035: that are used to identify the different SUBST blocks that are
8036: defined. The SUBST framework is heavily used by pkgsrc, so it is
8037: important to always use the <code class="literal">+=</code> operator with
8038: this variable. Otherwise some substitutions may be
8039: skipped.</p>
1.79 rillig 8040: <p>The remaining variables of each SUBST block are
1.87 wiz 8041: parameterized with the identifier from the first line
8042: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8043: parameters to a function call.</p>
1.79 rillig 8044: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8045: which the replacement will take place. All combinations of
8046: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8047: <code class="literal">post-</code> together with a phase name are
8048: possible, though only few are actually used. Most commonly used
8049: are <code class="literal">post-patch</code> and
8050: <code class="literal">pre-configure</code>. Of these two,
8051: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8052: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8053: have the state after applying the patches but before making any
8054: other changes. This is especially useful when you are debugging
8055: a package in order to create new patches for it. Similarly,
8056: <code class="literal">post-build</code> is preferred over
8057: <code class="literal">pre-install</code>, because the install phase should
8058: generally be kept as simple as possible. When you use
8059: <code class="literal">post-build</code>, you have the same files in the
8060: working directory that will be installed later, so you can check
8061: if the substitution has succeeded.</p>
1.79 rillig 8062: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8063: that is printed just before the substitution is done.</p>
1.79 rillig 8064: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8065: globbing patterns that specifies the files in which the
8066: substitution will take place. The patterns are interpreted
8067: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8068: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.189 snj 8069: <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 8070: command should be prefixed with <code class="literal">-e</code>, so that
8071: all SUBST blocks look uniform.</p>
1.79 rillig 8072: <p>There are some more variables, but they are so seldomly
1.87 wiz 8073: used that they are only documented in the
8074: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8075: </div>
1.75 rillig 8076: </div>
1.148 asau 8077: <div class="sect1">
1.75 rillig 8078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8079: <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 8080: <div class="sect2">
1.75 rillig 8081: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8082: <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 8083: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8084: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8085: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8086: with the name of each file to download as an argument, expecting
8087: it to output the URL of the directory from which to download
1.189 snj 8088: 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 8089: example of this usage.</p>
1.75 rillig 8090: <p>If the download can't be automated, because the user must
1.87 wiz 8091: submit personal information to apply for a password, or must pay
8092: for the source, or whatever, you can set
8093: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8094: displayed to the user before aborting the build. Example:</p>
8095: <pre class="programlisting">
1.100 rillig 8096: FETCH_MESSAGE= "Please download the files"
8097: FETCH_MESSAGE+= " "${DISTFILES:Q}
8098: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8099: </pre>
1.75 rillig 8100: </div>
1.148 asau 8101: <div class="sect2">
1.75 rillig 8102: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8103: <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 8104: <p>Sometimes authors of a software package make some
1.87 wiz 8105: modifications after the software was released, and they put up a
8106: new distfile without changing the package's version number. If a
8107: package is already in pkgsrc at that time, the checksum will
8108: no longer match. The contents of the new distfile should be
8109: compared against the old one before changing anything, to make
8110: sure the distfile was really updated on purpose, and that
8111: no trojan horse or so crept in.
1.97 rillig 8112: Please mention that the distfiles were compared and what was found
1.159 rodent 8113: in your commit message.</p>
8114: <p>Then, the correct way to work around this is to
1.87 wiz 8115: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8116: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8117: <code class="varname">DISTFILES</code> and
1.93 rillig 8118: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8119: subdirectory of the local distfiles directory.
1.110 hubertf 8120: (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 8121: In case this
1.87 wiz 8122: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8123: including the <code class="filename">nbX</code> suffix) or a date stamp
1.159 rodent 8124: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8125: <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>
8126: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8127: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8128: path in the filenames.
1.159 rodent 8129: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8130: Furthermore, a mail to the package's authors seems appropriate
8131: telling them that changing distfiles after releases without
8132: changing the file names is not good practice.</p>
1.75 rillig 8133: </div>
8134: </div>
1.148 asau 8135: <div class="sect1">
1.75 rillig 8136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8137: <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 8138: <div class="sect2">
1.75 rillig 8139: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8140: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8141: <p>pkgsrc supports many different machines, with different
1.87 wiz 8142: object formats like a.out and ELF, and varying abilities to do
8143: shared library and dynamic loading at all. To accompany this,
8144: varying commands and options have to be passed to the
8145: compiler, linker, etc. to get the Right Thing, which can be
8146: pretty annoying especially if you don't have all the machines
8147: at your hand to test things. The
1.189 snj 8148: <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 8149: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8150: both static and dynamic libraries from a set of source files,
8151: thus being platform-independent.</p>
8152: <p>Here's how to use libtool in a package in seven simple
8153: steps:</p>
1.128 wiz 8154: <div class="orderedlist"><ol class="orderedlist" type="1">
8155: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8156: Makefile.</p></li>
1.128 wiz 8157: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8158: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8159: add it to the definition of <code class="varname">CC</code>, if only
8160: libraries are being built in a given Makefile. This one command
8161: will build both PIC and non-PIC library objects, so you need not
8162: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8163: <li class="listitem">
1.75 rillig 8164: <p>For the linking of the library, remove any
1.128 wiz 8165: <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
8166: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8167: <pre class="programlisting">
1.100 rillig 8168: ${LIBTOOL} --mode=link \
8169: ${CC} -o ${.TARGET:.a=.la} \
8170: ${OBJS:.o=.lo} \
8171: -rpath ${PREFIX}/lib \
8172: -version-info major:minor
1.87 wiz 8173: </pre>
1.75 rillig 8174: <p>Note that the library is changed to have a
1.87 wiz 8175: <code class="filename">.la</code> extension, and the objects are
8176: changed to have a <code class="filename">.lo</code>
8177: extension. Change <code class="varname">OBJS</code> as
8178: necessary. This automatically creates all of the
8179: <code class="filename">.a</code>,
8180: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8181: necessary) in the build directory. Be sure to include
1.128 wiz 8182: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8183: minor are zero, as libtool will otherwise strip off the
8184: shared library version.</p>
1.75 rillig 8185: <p>From the libtool manual:</p>
8186: <pre class="programlisting">
1.100 rillig 8187: So, libtool library versions are described by three integers:
1.69 rillig 8188:
1.100 rillig 8189: CURRENT
8190: The most recent interface number that this library implements.
1.69 rillig 8191:
1.100 rillig 8192: REVISION
8193: The implementation number of the CURRENT interface.
1.69 rillig 8194:
1.100 rillig 8195: AGE
8196: The difference between the newest and oldest interfaces that
8197: this library implements. In other words, the library implements
8198: all the interface numbers in the range from number `CURRENT -
8199: AGE' to `CURRENT'.
1.1 grant 8200:
1.100 rillig 8201: If two libraries have identical CURRENT and AGE numbers, then the
8202: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8203: </pre>
1.128 wiz 8204: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8205: different results for a.out and ELF (excluding symlinks)
8206: in only one case. An ELF library of the form
1.128 wiz 8207: <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 8208: will have a symlink of
1.128 wiz 8209: <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 8210: on an a.out platform. This is handled
8211: automatically.</p>
1.128 wiz 8212: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8213: directory of the library being built.</p>
1.76 rillig 8214: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8215: <code class="filename">.la</code> file, the other files will be
8216: added automatically.</p>
1.75 rillig 8217: </li>
1.128 wiz 8218: <li class="listitem">
1.76 rillig 8219: <p>When linking shared object (<code class="filename">.so</code>)
1.189 snj 8220: 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 8221: shared libraries, use <span class="quote">“<span class="quote">-module
8222: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8223: tacked on.</p>
1.76 rillig 8224: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8225: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8226: </li>
1.128 wiz 8227: <li class="listitem">
1.75 rillig 8228: <p>When linking programs that depend on these libraries
1.87 wiz 8229: <span class="emphasis"><em>before</em></span> they are installed, preface
1.189 snj 8230: 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 8231: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8232: libraries (static or shared), but please be aware that
8233: libtool will not allow you to specify a relative path in
1.128 wiz 8234: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8235: expects you to change that argument to be the
8236: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8237: <pre class="programlisting">
1.100 rillig 8238: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8239: </pre>
1.75 rillig 8240: <p>should be changed to:</p>
8241: <pre class="programlisting">
1.100 rillig 8242: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8243: </pre>
1.75 rillig 8244: <p>and it will do the right thing with the libraries.</p>
8245: </li>
1.128 wiz 8246: <li class="listitem">
1.189 snj 8247: <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>
8248: 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 8249: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8250: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8251: <pre class="programlisting">
1.126 jakllsch 8252: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8253: </pre>
1.76 rillig 8254: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8255: shared library, any needed symlinks, and run
1.189 snj 8256: <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 8257: </li>
1.128 wiz 8258: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8259: the <code class="filename">.la</code>
8260: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8261: </ol></div>
8262: </div>
1.148 asau 8263: <div class="sect2">
1.75 rillig 8264: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8265: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8266: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8267: package Makefile. This will override the package's own libtool
8268: in most cases. For older libtool using packages, libtool is
8269: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8270: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8271: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8272: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8273: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8274: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8275: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8276: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8277: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8278: libraries built and installed, then use
8279: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8280: <p>If your package makes use of the platform-independent library
1.87 wiz 8281: for loading dynamic shared objects, that comes with libtool
8282: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8283: <p>Some packages use libtool incorrectly so that the package
8284: may not work or build in some circumstances. Some of the more
8285: common errors are:</p>
1.148 asau 8286: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8287: <li class="listitem">
1.75 rillig 8288: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8289: executable or library. This in itself isn't a problem if one of two things
8290: has been done:</p>
1.128 wiz 8291: <div class="orderedlist"><ol class="orderedlist" type="1">
8292: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8293: <code class="filename">libfoo.la</code>, not
8294: <code class="filename">foo.la</code></p></li>
1.128 wiz 8295: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8296: </ol></div>
8297: </li>
1.128 wiz 8298: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8299: The function lt_dlinit() should be called and the macro
8300: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8301: executables.</p></li>
1.75 rillig 8302: </ul></div>
8303: </div>
1.148 asau 8304: <div class="sect2">
1.75 rillig 8305: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8306: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8307: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8308: to regenerate the configure script and Makefile.in makefile
8309: templates, then they should be executed in a pre-configure
8310: target.</p>
1.75 rillig 8311: <p>For packages that need only autoconf:</p>
8312: <pre class="programlisting">
1.100 rillig 8313: AUTOCONF_REQD= 2.50 # if default version is not good enough
8314: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8315: ...
1.1 grant 8316:
1.100 rillig 8317: pre-configure:
8318: cd ${WRKSRC} && autoconf
1.1 grant 8319:
1.100 rillig 8320: ...
1.87 wiz 8321: </pre>
1.75 rillig 8322: <p>and for packages that need automake and autoconf:</p>
8323: <pre class="programlisting">
1.100 rillig 8324: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8325: USE_TOOLS+= automake # use "automake14" for automake-1.4
8326: ...
8327:
8328: pre-configure:
8329: set -e; cd ${WRKSRC}; \
8330: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8331:
1.100 rillig 8332: ...
1.87 wiz 8333: </pre>
1.75 rillig 8334: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8335: require GNU Make.</p>
1.75 rillig 8336: <p>There are times when the configure process makes
1.87 wiz 8337: additional changes to the generated files, which then causes
8338: the build process to try to re-execute the automake sequence.
8339: This is prevented by touching various files in the configure
8340: stage. If this causes problems with your package you can set
8341: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8342: Makefile.</p>
1.75 rillig 8343: </div>
8344: </div>
1.148 asau 8345: <div class="sect1">
1.75 rillig 8346: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8347: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 8348: <div class="sect2">
1.87 wiz 8349: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8350: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8351: <p>Compilers for the C, C++, and Fortran languages comes with
8352: the NetBSD base system. By default, pkgsrc assumes that a package
8353: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8354: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8355: <p>To declare which language's compiler a package needs, set
8356: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8357: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8358: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8359: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8360: written in C++, usually need a C compiler for the configure
8361: phase.</p>
8362: </div>
1.148 asau 8363: <div class="sect2">
1.87 wiz 8364: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8365: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8366: <p>If a program is written in Java, use the Java framework in
8367: pkgsrc. The package must include
8368: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8369: provides the following variables:</p>
1.148 asau 8370: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8371: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8372: dependency on the JDK is added. If
1.128 wiz 8373: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8374: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8375: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8376: JDK.</p></li>
1.128 wiz 8377: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8378: a package needs a Java2 implementation. The supported values
1.128 wiz 8379: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8380: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8381: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8382: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8383: above. This variable is not set by default.</p></li>
1.130 wiz 8384: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8385: automatically set to the runtime location of the used Java
8386: implementation dependency. It may be used to set
8387: <code class="varname">JAVA_HOME</code> to a good value if the program
8388: needs this variable to be defined.
8389: </p></li>
1.87 wiz 8390: </ul></div>
8391: </div>
1.148 asau 8392: <div class="sect2">
1.87 wiz 8393: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8394: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8395: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8396: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8397: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8398: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8399: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8400: that you want adjusted. Every occurrence of
8401: <code class="filename">*/bin/perl</code> in a she-bang line will be
8402: replaced with the full path to the perl executable.</p>
1.87 wiz 8403: <p>If a particular version of perl is needed, set the
8404: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8405: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8406: <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 8407: about handling perl modules.</p>
8408: </div>
1.148 asau 8409: <div class="sect2">
1.87 wiz 8410: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8411: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8412: <p><code class="varname">REPLACE_SH</code>,
8413: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8414: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8415: hash bangs in files. Please use the appropriate one, prefering
8416: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8417: Each should contain a list of scripts, relative to
8418: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8419: occurrence of the matching shell in a she-bang line will be
8420: replaced with the full path to the shell executable.
1.147 wiz 8421: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8422: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8423: </div>
1.148 asau 8424: <div class="sect2">
1.147 wiz 8425: <div class="titlepage"><div><div><h3 class="title">
8426: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8427: <p>Currently, there is no special handling for other languages
8428: in pkgsrc. If a compiler package provides a
8429: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8430: just add a (build) dependency on the appropriate compiler
8431: package.</p>
8432: </div>
8433: </div>
1.148 asau 8434: <div class="sect1">
1.87 wiz 8435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8436: <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 8437: <p>The most common failures when building a package are that
8438: some platforms do not provide certain header files, functions or
8439: libraries, or they provide the functions in a library that the
8440: original package author didn't know. To work around this, you
8441: can rewrite the source code in most cases so that it does not
8442: use the missing functions or provides a replacement function.</p>
1.148 asau 8443: <div class="sect2">
1.77 rillig 8444: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8445: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8446: <p>If a package already comes with a GNU configure script, the
8447: preferred way to fix the build failure is to change the
8448: configure script, not the code. In the other cases, you can
8449: utilize the C preprocessor, which defines certain macros
8450: depending on the operating system and hardware architecture it
8451: compiles for. These macros can be queried using for example
8452: <code class="varname">#if defined(__i386)</code>. Almost every operating
8453: system, hardware architecture and compiler has its own macro.
8454: For example, if the macros <code class="varname">__GNUC__</code>,
8455: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8456: are all defined, you know that you are using NetBSD on an i386
8457: compatible CPU, and your compiler is GCC.</p>
8458: <p>The list of the following macros for hardware and
8459: operating system depends on the compiler that is used. For
8460: example, if you want to conditionally compile code on Solaris,
8461: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8462: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8463: <div class="sect3">
1.75 rillig 8464: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8465: <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 8466: <p>To distinguish between 4.4 BSD-derived systems and the
8467: rest of the world, you should use the following code.</p>
8468: <pre class="programlisting">
1.100 rillig 8469: #include <sys/param.h>
8470: #if (defined(BSD) && BSD >= 199306)
8471: /* BSD-specific code goes here */
8472: #else
8473: /* non-BSD-specific code goes here */
8474: #endif
1.75 rillig 8475: </pre>
1.77 rillig 8476: <p>If this distinction is not fine enough, you can also test
8477: for the following macros.</p>
1.75 rillig 8478: <pre class="programlisting">
1.151 obache 8479: Cygwin __CYGWIN__
8480: DragonFly __DragonFly__
1.100 rillig 8481: FreeBSD __FreeBSD__
1.151 obache 8482: Haiku __HAIKU__
1.100 rillig 8483: Interix __INTERIX
8484: IRIX __sgi (TODO: get a definite source for this)
8485: Linux linux, __linux, __linux__
1.193 dholland 8486: Mac OS X __APPLE__
1.151 obache 8487: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8488: Minix3 __minix
1.100 rillig 8489: NetBSD __NetBSD__
8490: OpenBSD __OpenBSD__
8491: Solaris sun, __sun
1.75 rillig 8492: </pre>
8493: </div>
1.148 asau 8494: <div class="sect3">
1.75 rillig 8495: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8496: <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 8497: <pre class="programlisting">
1.100 rillig 8498: i386 i386, __i386, __i386__
8499: MIPS __mips
8500: SPARC sparc, __sparc
1.75 rillig 8501: </pre>
8502: </div>
1.148 asau 8503: <div class="sect3">
1.75 rillig 8504: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8505: <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 8506: <pre class="programlisting">
1.100 rillig 8507: GCC __GNUC__ (major version), __GNUC_MINOR__
8508: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8509: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8510: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8511: </pre>
8512: </div>
8513: </div>
1.148 asau 8514: <div class="sect2">
1.78 rillig 8515: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8516: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8517: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8518: combinations of compiler version and architecture and almost
8519: always relation to optimisation being enabled. Common symptoms
8520: are gcc internal errors or never finishing compiling a
1.78 rillig 8521: file.</p>
8522: <p>Typically, a workaround involves testing the
8523: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8524: optimisation for that combination of file,
8525: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8526: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8527: number of examples.</p>
8528: </div>
1.148 asau 8529: <div class="sect2">
1.78 rillig 8530: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8531: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8532: </h3></div></div></div>
1.92 rillig 8533: <p>This error message often means that a package did not
1.78 rillig 8534: link to a shared library it needs. The following functions are
8535: known to cause this error message over and over.</p>
8536: <div class="informaltable">
8537: <a name="undefined-reference-functions"></a><table border="1">
8538: <colgroup>
8539: <col>
8540: <col>
8541: <col>
8542: </colgroup>
8543: <thead><tr>
8544: <th>Function</th>
8545: <th>Library</th>
8546: <th>Affected platforms</th>
8547: </tr></thead>
8548: <tbody>
8549: <tr>
8550: <td>accept, bind, connect</td>
8551: <td>-lsocket</td>
8552: <td>Solaris</td>
8553: </tr>
8554: <tr>
8555: <td>crypt</td>
8556: <td>-lcrypt</td>
8557: <td>DragonFly, NetBSD</td>
8558: </tr>
8559: <tr>
8560: <td>dlopen, dlsym</td>
8561: <td>-ldl</td>
8562: <td>Linux</td>
8563: </tr>
8564: <tr>
8565: <td>gethost*</td>
8566: <td>-lnsl</td>
8567: <td>Solaris</td>
8568: </tr>
8569: <tr>
8570: <td>inet_aton</td>
8571: <td>-lresolv</td>
8572: <td>Solaris</td>
8573: </tr>
8574: <tr>
8575: <td>nanosleep, sem_*, timer_*</td>
8576: <td>-lrt</td>
8577: <td>Solaris</td>
8578: </tr>
8579: <tr>
8580: <td>openpty</td>
8581: <td>-lutil</td>
8582: <td>Linux</td>
8583: </tr>
8584: </tbody>
8585: </table>
8586: </div>
8587: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8588: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8589: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8590: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8591: bmake</strong></span>.</p>
1.148 asau 8592: <div class="sect3">
1.92 rillig 8593: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8594: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8595: <p>When you are using the SunPro compiler, there is another
8596: possibility. That compiler cannot handle the following code:</p>
8597: <pre class="programlisting">
1.100 rillig 8598: extern int extern_func(int);
1.93 rillig 8599:
1.100 rillig 8600: static inline int
8601: inline_func(int x)
8602: {
1.92 rillig 8603: return extern_func(x);
1.100 rillig 8604: }
1.93 rillig 8605:
1.100 rillig 8606: int main(void)
8607: {
1.92 rillig 8608: return 0;
1.100 rillig 8609: }
1.92 rillig 8610: </pre>
8611: <p>It generates the code for <code class="function">inline_func</code> even if
8612: that function is never used. This code then refers to
8613: <code class="function">extern_func</code>, which can usually not be resolved. To
8614: solve this problem you can try to tell the package to disable inlining
8615: of functions.</p>
8616: </div>
1.87 wiz 8617: </div>
1.148 asau 8618: <div class="sect2">
1.87 wiz 8619: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8620: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8621: <p>Sometimes packages fail to build because the compiler runs
8622: into an operating system specific soft limit. With the
8623: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8624: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8625: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8626: Setting this variable is similar to running the shell builtin
1.110 hubertf 8627: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8628: segment size or maximum stack size of a process, respectively, to
8629: their hard limits.</p>
1.78 rillig 8630: </div>
1.75 rillig 8631: </div>
1.148 asau 8632: <div class="sect1">
1.75 rillig 8633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8634: <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 8635: <div class="sect2">
1.75 rillig 8636: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8637: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8638: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8639: with some operating systems cannot create more than one
8640: directory at a time. As such, you should call
8641: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8642: <pre class="programlisting">
1.100 rillig 8643: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8644: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8645: </pre>
1.128 wiz 8646: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8647: dir2</code></span>”</span> to the
1.87 wiz 8648: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8649: automatically do the right thing.</p>
1.75 rillig 8650: </div>
1.148 asau 8651: <div class="sect2">
1.75 rillig 8652: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8653: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8654: <p>In general, documentation should be installed into
1.87 wiz 8655: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8656: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8657: includes the version number of the package).</p>
1.84 wiz 8658: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8659: directory where HTML documentation is installed with the
1.128 wiz 8660: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8661: is needed because otherwise the documentation ends up in
8662: <code class="filename">${PREFIX}/share/doc/html</code> or other
8663: places.</p>
8664: <p>An exception to the above is that library API documentation
1.189 snj 8665: 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 8666: browsers (devhelp) should be left at their default location, which
8667: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8668: documentation can be recognized from files ending in
8669: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8670: (It is also acceptable to install such files in
8671: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8672: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8673: <code class="filename">.devhelp*</code> file must be directly in that
8674: directory then, no additional subdirectory level is allowed in
8675: this case. This is usually achieved by using
1.128 wiz 8676: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8677: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8678: though.)</p>
1.75 rillig 8679: </div>
1.148 asau 8680: <div class="sect2">
1.75 rillig 8681: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8682: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8683: <p>Certain packages, most of them in the games category, install
1.87 wiz 8684: a score file that allows all users on the system to record their
8685: highscores. In order for this to work, the binaries need to be
8686: installed setgid and the score files owned by the appropriate
1.142 wiz 8687: group and/or owner (traditionally the "games" user/group). Set
8688: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8689: following variables, documented in more detail in
8690: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8691: behaviour: <code class="varname">GAMEDATAMODE</code>,
8692: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8693: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 8694: <p>A package should therefore never hard code file ownership or
1.87 wiz 8695: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8696: <code class="varname">INSTALL_GAME_DATA</code> to set these
8697: correctly.</p>
1.75 rillig 8698: </div>
1.148 asau 8699: <div class="sect2">
1.75 rillig 8700: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8701: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8702: <p><code class="varname">DESTDIR</code> support means that a package
8703: installs into a staging directory, not the final location of the
8704: files. Then a binary package is created which can be used for
8705: installation as usual. There are two ways: Either the package must
1.128 wiz 8706: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8707: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8708: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8709: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 8710: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8711: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8712: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8713: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8714: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8715: the inclusion.</p></li>
1.128 wiz 8716: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8717: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8718: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8719: automatically. Many manual rules and pre/post-install often are
8720: incorrect; fix them.</p></li>
1.128 wiz 8721: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8722: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8723: <li class="listitem"><p>In general, packages should support
1.103 wiz 8724: <code class="varname">UNPRIVILEGED</code> to be able to use
8725: DESTDIR.</p></li>
8726: </ul></div>
8727: </div>
1.148 asau 8728: <div class="sect2">
1.103 wiz 8729: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8730: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8731: <p>Your package may also contain scripts with hardcoded paths to
8732: other interpreters besides (or as well as) perl. To correct the
8733: full pathname to the script interpreter, you need to set the
8734: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8735: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8736: <pre class="programlisting">
1.100 rillig 8737: REPLACE_INTERPRETER+= tcl
8738: REPLACE.tcl.old= .*/bin/tclsh
8739: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8740: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8741: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8742: </pre>
1.148 asau 8743: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8744: <h3 class="title">Note</h3>
8745: <p>Before March 2006, these variables were called
1.87 wiz 8746: <code class="varname">_REPLACE.*</code> and
8747: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8748: </div>
8749: </div>
1.148 asau 8750: <div class="sect2">
1.75 rillig 8751: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8752: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8753: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8754: the Makefile fragment
8755: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8756: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8757: configuration for such modules as well as various hooks to tune
8758: this configuration. See comments in this file for
8759: details.</p>
1.75 rillig 8760: <p>Perl5 modules will install into different places depending
1.87 wiz 8761: on the version of perl used during the build process. To
8762: address this, pkgsrc will append lines to the
8763: <code class="filename">PLIST</code> corresponding to the files listed in
8764: the installed <code class="filename">.packlist</code> file generated by
8765: most perl5 modules. This is invoked by defining
8766: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8767: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8768: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8769: e.g.:</p>
1.75 rillig 8770: <pre class="programlisting">
1.153 wiz 8771: PERL5_PACKLIST= auto/Pg/.packlist
1.87 wiz 8772: </pre>
1.153 wiz 8773: <p>The perl5 config variables
8774: <code class="varname">installarchlib</code>,
8775: <code class="varname">installscript</code>,
8776: <code class="varname">installvendorbin</code>,
8777: <code class="varname">installvendorscript</code>,
8778: <code class="varname">installvendorarch</code>,
8779: <code class="varname">installvendorlib</code>,
8780: <code class="varname">installvendorman1dir</code>, and
8781: <code class="varname">installvendorman3dir</code> represent those
8782: locations in which components of perl5 modules may be installed,
8783: provided as variable with uppercase and prefixed with
8784: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8785: and may be used by perl5 packages that don't have a packlist.
8786: These variables are also substituted for in the
8787: <code class="filename">PLIST</code> as uppercase prefixed with
8788: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8789: </div>
1.148 asau 8790: <div class="sect2">
1.75 rillig 8791: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8792: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8793: <p>Some packages install info files or use the
1.128 wiz 8794: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8795: commands. <code class="varname">INFO_FILES</code> should be defined in
8796: the package Makefile so that <code class="filename">INSTALL</code> and
8797: <code class="filename">DEINSTALL</code> scripts will be generated to
8798: handle registration of the info files in the Info directory
1.128 wiz 8799: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8800: files registration is either provided by the system, or by a
8801: special purpose package automatically added as dependency if
8802: needed.</p>
1.75 rillig 8803: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8804: <code class="filename">${PREFIX}</code> where info files are primarily
8805: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8806: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8807: <p>The info files for the package should be listed in the
1.87 wiz 8808: package <code class="filename">PLIST</code>; however any split info files
8809: need not be listed.</p>
1.128 wiz 8810: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8811: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8812: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8813: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8814: should be noted with the <code class="varname">TEXINFO_REQD</code>
8815: variable in the package <code class="filename">Makefile</code>. By
8816: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8817: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8818: does not match the required minimum, a build dependency on the
1.189 snj 8819: <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 8820: be added automatically.</p>
1.75 rillig 8821: <p>The build and installation process of the software provided
1.87 wiz 8822: by the package should not use the
1.110 hubertf 8823: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8824: info files is the task of the package
8825: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8826: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8827: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8828: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8829: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8830: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8831: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8832: no effect except the logging of a message. The script overriding
1.110 hubertf 8833: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8834: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8835: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8836: </div>
1.148 asau 8837: <div class="sect2">
1.75 rillig 8838: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8839: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8840: <p>All packages that install manual pages should install them
1.87 wiz 8841: into the same directory, so that there is one common place to look
8842: for them. In pkgsrc, this place is
8843: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8844: should be used in packages. The default for
8845: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8846: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8847: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8848: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8849: <h3 class="title">Note</h3>
1.87 wiz 8850: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8851: is far from complete.</p>
1.75 rillig 8852: </div>
1.81 rillig 8853: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8854: <code class="filename">man/</code> as the top level directory for the man
8855: page file entries, and the pkgsrc framework will convert as
8856: needed. In all other places, the correct
8857: <code class="varname">PKGMANDIR</code> must be used.</p>
8858: <p>Packages that are
8859: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8860: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8861: <code class="filename">./configure</code>
8862: --mandir switch to set where the man pages should be installed.
8863: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8864: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8865: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8866: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8867: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8868: Or if the <code class="filename">./configure</code> script uses
8869: a non-standard use of --mandir, you can set
8870: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8871: <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 8872: information on installation of compressed manual pages.</p>
1.75 rillig 8873: </div>
1.148 asau 8874: <div class="sect2">
1.75 rillig 8875: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8876: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8877: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8878: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8879: you need to take some extra steps to make sure they get registered
8880: in the database:</p>
1.128 wiz 8881: <div class="orderedlist"><ol class="orderedlist" type="1">
8882: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8883: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8884: takes care of rebuilding the GConf database at installation and
1.87 wiz 8885: deinstallation time, and tells the package where to install
1.107 rillig 8886: GConf data files using some standard configure arguments. It
1.87 wiz 8887: also disallows any access to the database directly from the
8888: package.</p></li>
1.128 wiz 8889: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8890: <code class="filename">.schemas</code> files under
8891: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8892: installed under <code class="filename">${PREFIX}/etc</code>, you will
8893: need to manually patch the package.</p></li>
1.128 wiz 8894: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8895: directory, as they will be handled automatically. See
1.194 bsiegert 8896: <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 8897: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8898: your <code class="filename">Makefile</code> with a list of all
8899: <code class="filename">.schemas</code> files installed by the package, if
8900: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8901: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8902: your <code class="filename">Makefile</code> with a
8903: list of all <code class="filename">.entries</code> files installed by the
8904: package, if any. Names must not contain any directories in
8905: them.</p></li>
1.75 rillig 8906: </ol></div>
8907: </div>
1.148 asau 8908: <div class="sect2">
1.75 rillig 8909: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 8910: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8911: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8912: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8913: get registered in the database:</p>
1.128 wiz 8914: <div class="orderedlist"><ol class="orderedlist" type="1">
8915: <li class="listitem"><p>Include
1.119 mishka 8916: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8917: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8918: takes care of rebuilding the scrollkeeper database at
8919: installation and deinstallation time, and disallows any access
8920: to it directly from the package.</p></li>
1.128 wiz 8921: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8922: <code class="filename">libdata/scrollkeeper</code> directory, as they
8923: will be handled automatically.</p></li>
1.128 wiz 8924: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 8925: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8926: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 8927: </ol></div>
8928: </div>
1.148 asau 8929: <div class="sect2">
1.75 rillig 8930: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8931: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8932: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8933: the fonts database in the directory where they get installed at
8934: installation and deinstallation time. This can be automatically
8935: done by using the pkginstall framework.</p>
1.75 rillig 8936: <p>You can list the directories where fonts are installed in the
1.87 wiz 8937: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8938: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 8939: <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 8940: Also make sure that the database file
8941: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8942: <p>Note that you should not create new directories for fonts;
1.87 wiz 8943: instead use the standard ones to avoid that the user needs to
8944: manually configure his X server to find them.</p>
1.75 rillig 8945: </div>
1.148 asau 8946: <div class="sect2">
1.75 rillig 8947: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8948: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8949: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8950: take some extra steps to get them registered in the GTK2 database
8951: properly:</p>
1.128 wiz 8952: <div class="orderedlist"><ol class="orderedlist" type="1">
8953: <li class="listitem"><p>Include
1.87 wiz 8954: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8955: <code class="filename">buildlink3.mk</code> file. This takes care of
8956: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 8957: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 8958: your package installs GTK2 immodules.</p></li>
1.128 wiz 8959: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 8960: GTK2 loaders.</p></li>
1.128 wiz 8961: <li class="listitem">
1.87 wiz 8962: <p>Patch the package to not touch any of the GTK2
8963: databases directly. These are:</p>
1.148 asau 8964: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8965: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8966: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8967: </ul></div>
8968: </li>
1.128 wiz 8969: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 8970: any entries under the <code class="filename">libdata/gtk-2.0</code>
8971: directory, as they will be handled automatically.</p></li>
1.75 rillig 8972: </ol></div>
8973: </div>
1.148 asau 8974: <div class="sect2">
1.75 rillig 8975: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8976: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8977: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8978: registered in system-wide catalogs (like DTDs, sub-catalogs,
8979: etc.), you need to take some extra steps:</p>
1.128 wiz 8980: <div class="orderedlist"><ol class="orderedlist" type="1">
8981: <li class="listitem"><p>Include
1.87 wiz 8982: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8983: your <code class="filename">Makefile</code>, which takes care of
8984: registering those files in system-wide catalogs at
8985: installation and deinstallation time.</p></li>
1.128 wiz 8986: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8987: any SGML catalogs installed by the package.</p></li>
1.128 wiz 8988: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 8989: any XML catalogs installed by the package.</p></li>
1.128 wiz 8990: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 8991: to be added to the SGML catalog. These come in groups of
8992: three strings; see xmlcatmgr(1) for more information
8993: (specifically, arguments recognized by the 'add' action).
8994: Note that you will normally not use this variable.</p></li>
1.128 wiz 8995: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 8996: to be added to the XML catalog. These come in groups of three
8997: strings; see xmlcatmgr(1) for more information (specifically,
8998: arguments recognized by the 'add' action). Note that you will
8999: normally not use this variable.</p></li>
1.75 rillig 9000: </ol></div>
9001: </div>
1.148 asau 9002: <div class="sect2">
1.75 rillig 9003: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9004: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9005: <p>If a package provides extensions to the MIME database by
1.87 wiz 9006: installing <code class="filename">.xml</code> files inside
9007: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9008: need to take some extra steps to ensure that the database is kept
9009: consistent with respect to these new files:</p>
1.128 wiz 9010: <div class="orderedlist"><ol class="orderedlist" type="1">
9011: <li class="listitem"><p>Include
1.87 wiz 9012: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9013: (avoid using the <code class="filename">buildlink3.mk</code> file from
9014: this same directory, which is reserved for inclusion from
9015: other <code class="filename">buildlink3.mk</code> files). It takes
9016: care of rebuilding the MIME database at installation and
9017: deinstallation time, and disallows any access to it directly
9018: from the package.</p></li>
1.128 wiz 9019: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9020: <code class="filename">share/mime</code> directory,
9021: <span class="emphasis"><em>except</em></span> for files saved under
9022: <code class="filename">share/mime/packages</code>. The former are
9023: handled automatically by
9024: the update-mime-database program, but the latter are
9025: package-dependent and must be removed by the package that
9026: installed them in the first place.</p></li>
1.128 wiz 9027: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9028: from the PLIST. They will be handled by the shared-mime-info
9029: package.</p></li>
1.75 rillig 9030: </ol></div>
9031: </div>
1.148 asau 9032: <div class="sect2">
1.75 rillig 9033: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9034: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9035: <p>If a package uses intltool during its build, add
9036: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9037: which forces it to use the intltool package provided by pkgsrc,
9038: instead of the one bundled with the distribution file.</p>
1.75 rillig 9039: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9040: latest available version; this way, the package benefits of any
9041: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9042: </div>
1.148 asau 9043: <div class="sect2">
1.75 rillig 9044: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9045: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9046: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9047: the startup directory by default, but you can enable it, by adding
9048: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9049: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9050: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9051: it will automatically remove the scripts when the package is
9052: deinstalled.</p>
1.75 rillig 9053: </div>
1.148 asau 9054: <div class="sect2">
1.75 rillig 9055: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9056: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9057: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9058: the <code class="filename">ls-R</code> database of the tree needs to be
9059: updated.</p>
1.148 asau 9060: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9061: <h3 class="title">Note</h3>
1.125 wiz 9062: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9063: packages should install files
1.125 wiz 9064: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9065: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9066: </div>
1.128 wiz 9067: <div class="orderedlist"><ol class="orderedlist" type="1">
9068: <li class="listitem"><p>Include
1.125 wiz 9069: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9070: takes care of rebuilding the <code class="filename">ls-R</code>
9071: database at installation and deinstallation time.</p></li>
1.128 wiz 9072: <li class="listitem">
1.75 rillig 9073: <p>If your package installs files into a texmf
1.87 wiz 9074: tree other than the one
1.125 wiz 9075: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9076: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9077: trees that need database update.</p>
1.75 rillig 9078: <p>If your package also installs font map files that need
1.110 hubertf 9079: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9080: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9081: set <code class="varname">TEX_MAP_FILES</code> and/or
9082: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9083: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9084: be run automatically at installation/deinstallation to
9085: enable/disable font map files for TeX output
9086: drivers.</p>
1.75 rillig 9087: </li>
1.128 wiz 9088: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9089: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9090: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9091: </ol></div>
9092: </div>
1.148 asau 9093: <div class="sect2">
1.85 jmmv 9094: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9095: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9096: emulation</h3></div></div></div>
9097: <p>There are some packages that provide libraries and
9098: executables for running binaries from a one operating system
9099: on a different one (if the latter supports it). One example
9100: is running Linux binaries on NetBSD.</p>
1.189 snj 9101: <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 9102: helps in extracting and packaging Linux rpm packages.</p>
9103: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9104: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9105: if all libraries for each installed executable can be found by
9106: the dynamic linker. Since the standard dynamic linker is run,
9107: this fails for emulation packages, because the libraries used
9108: by the emulation are not in the standard directories.</p>
9109: </div>
1.148 asau 9110: <div class="sect2">
1.87 wiz 9111: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9112: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9113: <p>If a package installs images under the
1.87 wiz 9114: <code class="filename">share/icons/hicolor</code> and/or updates the
9115: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9116: database, you need to take some extra steps to make sure that the
9117: shared theme directory is handled appropriately and that the cache
9118: database is rebuilt:</p>
1.128 wiz 9119: <div class="orderedlist"><ol class="orderedlist" type="1">
9120: <li class="listitem"><p>Include
1.87 wiz 9121: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9122: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9123: entry that refers to the theme cache.</p></li>
1.128 wiz 9124: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9125: directories from the <code class="filename">share/icons/hicolor</code>
9126: hierarchy because they will be handled automatically.</p></li>
9127: </ol></div>
9128: <p>The best way to verify that the PLIST is correct with
9129: respect to the last two points is to regenerate it using
1.110 hubertf 9130: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9131: </div>
1.148 asau 9132: <div class="sect2">
1.85 jmmv 9133: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9134: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9135: <p>If a package installs <code class="filename">.desktop</code> files
9136: under <code class="filename">share/applications</code> and these include
1.159 rodent 9137: MIME information (MimeType key), you need to take extra steps to
9138: ensure that they are registered into the MIME database:</p>
1.128 wiz 9139: <div class="orderedlist"><ol class="orderedlist" type="1">
9140: <li class="listitem"><p>Include
1.85 jmmv 9141: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9142: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9143: <code class="filename">share/applications/mimeinfo.cache</code> file.
9144: It will be handled automatically.</p></li>
9145: </ol></div>
9146: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9147: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9148: print-PLIST</strong></span>.</p>
1.75 rillig 9149: </div>
9150: </div>
1.148 asau 9151: <div class="sect1">
1.87 wiz 9152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9153: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9154: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9155: immediately. In this case, one can plainly mark a package as broken. For
9156: this, one just sets the variable <code class="varname">BROKEN</code> to the
9157: reason why the package is broken (similar to the
9158: <code class="varname">RESTRICTED</code> variable). A user trying to build
9159: the package will immediately be shown this message, and the build
9160: will not be even tried.</p>
9161: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9162: intervals.</p>
9163: </div>
1.75 rillig 9164: </div>
1.148 asau 9165: <div class="chapter">
1.75 rillig 9166: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9167: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9168: <p>To check out all the gotchas when building a package, here are
9169: the steps that I do in order to get a package working. Please note
9170: this is basically the same as what was explained in the previous
9171: sections, only with some debugging aids.</p>
1.148 asau 9172: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9173: <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>
9174: <li class="listitem">
1.189 snj 9175: <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 9176: create a directory for a new package, change into it, then run
1.110 hubertf 9177: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9178: <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>
9179: <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>
9180: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9181: </li>
1.128 wiz 9182: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9183: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9184: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9185: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9186: configure step to the package's
9187: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9188: <li class="listitem">
1.75 rillig 9189: <p>Make the package compile, doing multiple rounds of</p>
9190: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9191: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9192: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9193: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9194: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9195: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9196: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9197: <p>Doing this step as non-root user will ensure that no files
9198: are modified that shouldn't be, especially during the build
1.110 hubertf 9199: phase. <span class="command"><strong>mkpatches</strong></span>,
9200: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.189 snj 9201: 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 9202: package.</p>
1.75 rillig 9203: </li>
1.128 wiz 9204: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9205: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9206: <li class="listitem">
1.76 rillig 9207: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9208: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9209: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9210: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9211: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9212: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9213: <p>You usually need to be <code class="username">root</code> to do
9214: this. Look if there are any files left:</p>
1.75 rillig 9215: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9216: <p>If this reveals any files that are missing in
1.88 wiz 9217: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9218: </li>
1.128 wiz 9219: <li class="listitem">
1.88 wiz 9220: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9221: package again and make a binary package:</p>
1.75 rillig 9222: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9223: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9224: </li>
1.128 wiz 9225: <li class="listitem">
1.75 rillig 9226: <p>Delete the installed package:</p>
1.88 wiz 9227: <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 9228: </li>
1.128 wiz 9229: <li class="listitem">
1.110 hubertf 9230: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9231: command, which shouldn't find anything now:</p>
1.75 rillig 9232: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9233: </li>
1.128 wiz 9234: <li class="listitem">
1.75 rillig 9235: <p>Reinstall the binary package:</p>
1.93 rillig 9236: <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 9237: </li>
1.128 wiz 9238: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9239: <li class="listitem">
1.189 snj 9240: <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 9241: reports:</p>
1.75 rillig 9242: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9243: </li>
1.128 wiz 9244: <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 9245: </ul></div>
9246: </div>
1.148 asau 9247: <div class="chapter">
1.75 rillig 9248: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9249: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9250: <div class="toc">
9251: <p><b>Table of Contents</b></p>
1.195 wiz 9252: <dl class="toc">
1.106 rillig 9253: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9254: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9255: <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 9256: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9257: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9258: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9259: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9260: </dl>
9261: </div>
1.148 asau 9262: <div class="sect1">
1.75 rillig 9263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9264: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9265: <p>Our policy is that we accept binaries only from pkgsrc
9266: developers to guarantee that the packages don't contain any
9267: trojan horses etc. This is not to annoy anyone but rather to
9268: protect our users! You're still free to put up your home-made
9269: binary packages and tell the world where to get them. NetBSD
9270: developers doing bulk builds and wanting to upload them please
1.174 asau 9271: 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
9272: builds)</i></a>.</p>
1.75 rillig 9273: </div>
1.148 asau 9274: <div class="sect1">
1.75 rillig 9275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9276: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9277: <p>First, check that your package is complete, compiles and
1.110 hubertf 9278: 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 9279: 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 9280: archive that contains all files that make up the package.
1.87 wiz 9281: Finally, send this package to the pkgsrc bug tracking system,
1.189 snj 9282: 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 9283: that, go to the web page
1.110 hubertf 9284: <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 9285: which contains some instructions and a link to a form where you
9286: can submit packages. The
1.189 snj 9287: <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 9288: also available as a substitute for either of the above two tools.
9289: </p>
1.87 wiz 9290: <p>In the form of the problem report, the category should be
1.128 wiz 9291: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9292: and version number, and the description field should contain a
9293: short description of your package (contents of the COMMENT
9294: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9295: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9296: <p>If you want to submit several packages, please send a
9297: separate PR for each one, it's easier for us to track things
9298: that way.</p>
9299: <p>Alternatively, you can also import new packages into
1.128 wiz 9300: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9301: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9302: for details.</p>
9303: </div>
1.148 asau 9304: <div class="sect1">
1.75 rillig 9305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9306: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9307: <p>Please note all package additions, updates, moves, and
1.93 rillig 9308: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9309: important to keep this file up to date and conforming to the
9310: existing format, because it will be used by scripts to
1.110 hubertf 9311: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9312: sites. Additionally, check the
1.76 rillig 9313: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9314: for the package you updated or removed, in case it was mentioned
9315: there.</p>
9316: <p>When the <code class="varname">PKGREVISION</code> of a package is
9317: bumped, the change should appear in
1.93 rillig 9318: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9319: related or otherwise relevant. Mass bumps that result from a
9320: dependency being updated should not be mentioned. In all other
9321: cases it's the developer's decision.</p>
9322: <p>There is a make target that helps in creating proper
1.110 hubertf 9323: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9324: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9325: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9326: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9327: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9328: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9329: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9330: For new packages, or package moves or removals, set the
9331: <code class="varname">CTYPE</code> variable on the command line to "Added",
9332: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9333: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9334: not the same as your NetBSD login name. The target also automatically
9335: removes possibly existing entries for the package in the
9336: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9337: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9338: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9339: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9340: makes the cvs commands use the main repository.
9341: </p>
1.75 rillig 9342: </div>
1.148 asau 9343: <div class="sect1">
1.75 rillig 9344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9345: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9346: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9347: access to the pkgsrc repository.</p>
9348: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9349: Start by adding the directory and then files in the directory. Don't
9350: forget to add the new package to the category's
9351: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9352: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9353: <pre class="programlisting">
9354: <code class="prompt">$</code> cd .../pkgsrc/category
9355: <code class="prompt">$</code> cvs add pkgname
9356: <code class="prompt">$</code> cd pkgname
9357: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9358: <code class="prompt">$</code> cvs add patches/p*
9359: <code class="prompt">$</code> cvs status | less
1.141 wiz 9360: <code class="prompt">$</code> cvs commit
1.140 wiz 9361: <code class="prompt">$</code> cd ..
9362: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9363: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9364: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9365: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9366: </pre>
1.87 wiz 9367: <p>The commit message of the initial import should include part of the
1.76 rillig 9368: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9369: what the package is/does.</p>
1.140 wiz 9370: <p>Also mention the new package in
9371: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9372: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9373: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9374: </div>
1.148 asau 9375: <div class="sect1">
1.75 rillig 9376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9377: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9378: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9379: changes between old and new versions into the commit log when updating
1.87 wiz 9380: a package. There are various reasons for this:</p>
1.148 asau 9381: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9382: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9383: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9384: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9385: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9386: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9387: repository is very useful for people who read the pkgsrc-changes mailing
9388: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9389: the package.</p></li>
1.75 rillig 9390: </ul></div>
1.87 wiz 9391: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9392: has been released, it should not automatically be upgraded in the CVS
9393: repository. We prefer to be conservative in the packages that are
9394: included in pkgsrc - development or beta packages are not really the
9395: best thing for most places in which pkgsrc is used. Please use your
9396: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9397: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9398: </div>
1.148 asau 9399: <div class="sect1">
1.75 rillig 9400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9401: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9402: <p>Renaming packages is not recommended.</p>
9403: <p>When renaming packages, be sure to fix any references to old name
9404: in other Makefiles, options, buildlink files, etc.</p>
9405: <p>Also When renaming a package, please define
9406: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9407: pattern(s) of the previous package name.
9408: This may be repeated for multiple renames.
9409: The new package would be an exact replacement.
9410: </p>
1.128 wiz 9411: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9412: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9413: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9414: not be an exact replacement but is a suggestion for the replaced
9415: functionality.</p>
9416: </div>
1.148 asau 9417: <div class="sect1">
1.122 reed 9418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9419: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9420: <p>It is preferred that packages are not renamed or moved, but if needed
9421: please follow these steps.
9422: </p>
1.128 wiz 9423: <div class="orderedlist"><ol class="orderedlist" type="1">
9424: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9425: <li class="listitem">
1.75 rillig 9426: <p>Remove all CVS dirs.</p>
1.87 wiz 9427: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9428: <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 9429: <p>and use that for further work.</p>
1.75 rillig 9430: </li>
1.128 wiz 9431: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9432: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9433: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9434: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9435: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9436: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9437: for doing an update using pkgsrc building; for example, it can
1.189 snj 9438: 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 9439: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9440: new <code class="varname">PKGPATH</code> for that moved package. Note that
9441: it may have multiple matches, so the tool should also check on the
9442: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9443: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9444: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9445: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9446: place.</p></li>
1.128 wiz 9447: <li class="listitem">
1.75 rillig 9448: <p>Check if any package depends on it:
9449: </p>
9450: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9451: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9452: </li>
1.128 wiz 9453: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9454: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9455: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9456: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9457: <li class="listitem">
1.75 rillig 9458: <p>Commit the changed and removed files:</p>
9459: <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 9460: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9461: </li>
9462: </ol></div>
9463: </div>
9464: </div>
1.148 asau 9465: <div class="chapter">
1.75 rillig 9466: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9467: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9468: <p>This section contains the answers to questions that may
9469: arise when you are writing a package. If you don't find your
9470: question answered here, first have a look in the other chapters,
9471: and if you still don't have the answer, ask on the
9472: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9473: <div class="qandaset">
1.196 ! wiz 9474: <a name="idm77324944"></a><dl>
1.106 rillig 9475: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9476: MAKEFLAGS, .MAKEFLAGS and
9477: MAKE_FLAGS?</a>
9478: </dt>
1.106 rillig 9479: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9480: MAKE, GMAKE and
9481: MAKE_PROGRAM?</a>
9482: </dt>
1.106 rillig 9483: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9484: CC, PKG_CC and
9485: PKGSRC_COMPILER?</a>
9486: </dt>
1.106 rillig 9487: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9488: BUILDLINK_LDFLAGS,
9489: BUILDLINK_LDADD and
9490: BUILDLINK_LIBS?</a>
9491: </dt>
1.106 rillig 9492: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9493: VARNAME=BUILDLINK_PREFIX.foo
9494: say it's empty?</a>
9495: </dt>
1.106 rillig 9496: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9497: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9498: don't understand the := inside
9499: it.</a>
9500: </dt>
1.106 rillig 9501: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9502: developers?</a>
9503: </dt>
1.106 rillig 9504: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9505: documentation?</a>
9506: </dt>
1.106 rillig 9507: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9508: do?</a>
9509: </dt>
1.75 rillig 9510: </dl>
1.148 asau 9511: <table border="0" style="width: 100%;">
9512: <colgroup>
1.75 rillig 9513: <col align="left" width="1%">
1.128 wiz 9514: <col>
1.148 asau 9515: </colgroup>
1.75 rillig 9516: <tbody>
1.148 asau 9517: <tr class="question">
1.75 rillig 9518: <td align="left" valign="top">
1.196 ! wiz 9519: <a name="devfaq.makeflags"></a><a name="idm77324560"></a><p><b>22.1.</b></p>
1.75 rillig 9520: </td>
9521: <td align="left" valign="top"><p>What is the difference between
9522: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9523: <code class="varname">MAKE_FLAGS</code>?</p></td>
9524: </tr>
9525: <tr class="answer">
1.91 rillig 9526: <td align="left" valign="top"></td>
1.75 rillig 9527: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.189 snj 9528: 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 9529: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9530: the <code class="varname">MAKE_PROGRAM</code> when building the
9531: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9532: </tr>
1.148 asau 9533: <tr class="question">
1.75 rillig 9534: <td align="left" valign="top">
1.196 ! wiz 9535: <a name="devfaq.make"></a><a name="idm77320592"></a><p><b>22.2.</b></p>
1.75 rillig 9536: </td>
9537: <td align="left" valign="top"><p>What is the difference between
9538: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9539: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9540: </tr>
9541: <tr class="answer">
1.91 rillig 9542: <td align="left" valign="top"></td>
1.75 rillig 9543: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.189 snj 9544: <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 9545: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9546: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9547: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9548: Make program that is used for building the
9549: package.</p></td>
9550: </tr>
1.148 asau 9551: <tr class="question">
1.75 rillig 9552: <td align="left" valign="top">
1.196 ! wiz 9553: <a name="devfaq.cc"></a><a name="idm77316112"></a><p><b>22.3.</b></p>
1.75 rillig 9554: </td>
9555: <td align="left" valign="top"><p>What is the difference between
9556: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9557: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9558: </tr>
9559: <tr class="answer">
1.91 rillig 9560: <td align="left" valign="top"></td>
1.75 rillig 9561: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9562: compiler, which can be configured by the pkgsrc user.
9563: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9564: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9565: path to a compiler, but the type of compiler that should be
1.76 rillig 9566: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9567: information about the latter variable.</p></td>
9568: </tr>
1.148 asau 9569: <tr class="question">
1.75 rillig 9570: <td align="left" valign="top">
1.196 ! wiz 9571: <a name="devfaq.bl3flags"></a><a name="idm77312016"></a><p><b>22.4.</b></p>
1.75 rillig 9572: </td>
9573: <td align="left" valign="top"><p>What is the difference between
9574: <code class="varname">BUILDLINK_LDFLAGS</code>,
9575: <code class="varname">BUILDLINK_LDADD</code> and
9576: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9577: </tr>
9578: <tr class="answer">
1.91 rillig 9579: <td align="left" valign="top"></td>
1.75 rillig 9580: <td align="left" valign="top"><p>[FIXME]</p></td>
9581: </tr>
1.148 asau 9582: <tr class="question">
1.75 rillig 9583: <td align="left" valign="top">
1.196 ! wiz 9584: <a name="devfaq.bl3prefix"></a><a name="idm77309840"></a><p><b>22.5.</b></p>
1.75 rillig 9585: </td>
1.110 hubertf 9586: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9587: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9588: say it's empty?</p></td>
9589: </tr>
9590: <tr class="answer">
1.91 rillig 9591: <td align="left" valign="top"></td>
1.75 rillig 9592: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9593: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9594: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9595: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9596: command.</p></td>
9597: </tr>
1.148 asau 9598: <tr class="question">
1.78 rillig 9599: <td align="left" valign="top">
1.196 ! wiz 9600: <a name="devfaq.master_sites"></a><a name="idm77306640"></a><p><b>22.6.</b></p>
1.78 rillig 9601: </td>
9602: <td align="left" valign="top"><p>What does
9603: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9604: don't understand the <code class="literal">:=</code> inside
9605: it.</p></td>
9606: </tr>
9607: <tr class="answer">
1.91 rillig 9608: <td align="left" valign="top"></td>
1.78 rillig 9609: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9610: assignment operator, like you might expect at first sight.
9611: Instead, it is a degenerate form of
9612: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.189 snj 9613: 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 9614: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9615: case of <code class="varname">MASTER_SITE_*</code>,
9616: <em class="replaceable"><code>old_string</code></em> is the empty string and
9617: <em class="replaceable"><code>new_string</code></em> is
9618: <code class="literal">package/</code>. That's where the
9619: <code class="literal">:</code> and the <code class="literal">=</code> fall
9620: together.</p></td>
9621: </tr>
1.148 asau 9622: <tr class="question">
1.78 rillig 9623: <td align="left" valign="top">
1.196 ! wiz 9624: <a name="devfaq.mailinglists"></a><a name="idm77298576"></a><p><b>22.7.</b></p>
1.78 rillig 9625: </td>
9626: <td align="left" valign="top"><p>Which mailing lists are there for package
9627: developers?</p></td>
9628: </tr>
9629: <tr class="answer">
1.91 rillig 9630: <td align="left" valign="top"></td>
1.148 asau 9631: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9632: <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 9633: <dd><p>This is a list for technical discussions related
9634: to pkgsrc development, e.g. soliciting feedback for changes to
9635: pkgsrc infrastructure, proposed new features, questions related
9636: to porting pkgsrc to a new platform, advice for maintaining a
9637: package, patches that affect many packages, help requests moved
9638: from pkgsrc-users when an infrastructure bug is found,
9639: etc.</p></dd>
1.110 hubertf 9640: <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 9641: <dd><p>All bug reports in category "pkg" sent with
1.189 snj 9642: <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 9643: directly; use one of the other mailing
9644: lists.</p></dd>
9645: </dl></div></td>
9646: </tr>
1.148 asau 9647: <tr class="question">
1.80 rillig 9648: <td align="left" valign="top">
1.196 ! wiz 9649: <a name="devfaq.documentation"></a><a name="idm77294864"></a><p><b>22.8.</b></p>
1.80 rillig 9650: </td>
9651: <td align="left" valign="top"><p>Where is the pkgsrc
9652: documentation?</p></td>
9653: </tr>
9654: <tr class="answer">
1.91 rillig 9655: <td align="left" valign="top"></td>
1.80 rillig 9656: <td align="left" valign="top">
9657: <p>There are many places where you can find
9658: documentation about pkgsrc:</p>
1.148 asau 9659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9660: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9661: of chapters that explain large parts of pkgsrc, but some
9662: chapters tend to be outdated. Which ones they are is hard to
9663: say.</p></li>
1.128 wiz 9664: <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 9665: about certain features, announcements of new parts of the pkgsrc
9666: infrastructure and sometimes even announcements that a certain
9667: feature has been marked as obsolete. The benefit here is that
9668: each message has a date appended to it.</p></li>
1.128 wiz 9669: <li class="listitem"><p>Many of the files in the
1.80 rillig 9670: <code class="filename">mk/</code> directory start with a comment that
9671: describes the purpose of the file and how it can be used by the
1.92 rillig 9672: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9673: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9674: help</strong></span>.</p></li>
1.128 wiz 9675: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9676: information, but they tend to be highly abbreviated, especially
9677: for actions that occur often. Some contain a detailed
9678: description of what has changed, but they are geared towards the
9679: other pkgsrc developers, not towards an average pkgsrc user.
9680: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9681: don't know what has been before, these messages may not be worth
9682: too much to you.</p></li>
1.128 wiz 9683: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9684: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9685: mind of the developer who wrote the code. To get this
1.110 hubertf 9686: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9687: to see who has written it and ask on the
9688: <code class="literal">tech-pkg</code> mailing list, so that others can
9689: find your questions later (see above). To be sure that the
9690: developer in charge reads the mail, you may CC him or
9691: her.</p></li>
9692: </ul></div>
9693: </td>
9694: </tr>
1.148 asau 9695: <tr class="question">
1.92 rillig 9696: <td align="left" valign="top">
1.196 ! wiz 9697: <a name="devfaq.too-much-time"></a><a name="idm77288336"></a><p><b>22.9.</b></p>
1.92 rillig 9698: </td>
9699: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9700: do?</p></td>
9701: </tr>
9702: <tr class="answer">
9703: <td align="left" valign="top"></td>
9704: <td align="left" valign="top">
1.93 rillig 9705: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9706: anyway.</p>
1.148 asau 9707: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9708: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.189 snj 9709: <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 9710: will tell you about newer versions of installed packages that are
9711: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9712: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9713: — it contains a list of suggested new packages and a list of
1.92 rillig 9714: cleanups and enhancements for pkgsrc that would be nice to
9715: have.</p></li>
1.128 wiz 9716: <li class="listitem"><p>Review packages for which review was requested on
1.180 wiz 9717: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92 rillig 9718: mailing list.</p></li>
9719: </ul></div>
9720: </td>
9721: </tr>
1.75 rillig 9722: </tbody>
9723: </table>
9724: </div>
9725: </div>
1.148 asau 9726: <div class="chapter">
1.85 jmmv 9727: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9728: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9729: <div class="toc">
9730: <p><b>Table of Contents</b></p>
1.195 wiz 9731: <dl class="toc">
1.106 rillig 9732: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9733: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9734: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9735: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9736: </dl>
9737: </div>
1.110 hubertf 9738: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9739: site</a>:</p>
9740: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9741: environment, an intuitive and attractive desktop for users, and the
9742: GNOME development platform, an extensive framework for building
9743: applications that integrate into the rest of the desktop.</p></blockquote></div>
9744: <p>pkgsrc provides a seamless way to automatically build and install
9745: a complete GNOME environment <span class="emphasis"><em>under many different
9746: platforms</em></span>. We can say with confidence that pkgsrc is one of
9747: the most advanced build and packaging systems for GNOME due to its
9748: included technologies buildlink3, the wrappers and tools framework and
9749: automatic configuration file management. Lots of efforts are put into
9750: achieving a completely clean deinstallation of installed software
9751: components.</p>
1.110 hubertf 9752: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9753: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9754: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9755: pkgsrc as its preferred packaging system, contributing lots of
9756: portability fixes to make GNOME build and install under it.</p>
9757: <p>This chapter is aimed at pkgsrc developers and other people
9758: interested in helping our GNOME porting and packaging efforts. It
9759: provides instructions on how to manage the existing packages and some
9760: important information regarding their internals.</p>
1.148 asau 9761: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9762: <h3 class="title">We need your help!</h3>
9763: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9764: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9765: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9766: work</a> list! There is still a long way to go to get a
9767: fully-functional GNOME desktop under NetBSD and we need your help to
9768: achieve it!</p>
9769: </div>
1.148 asau 9770: <div class="sect1">
1.85 jmmv 9771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9772: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9773: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 9775: <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 9776: the core GNOME desktop environment. It only includes the necessary
9777: bits to get it to boot correctly, although it may lack important
9778: functionality for daily operation. The idea behind this package is
9779: to let end users build their own configurations on top of this one,
9780: first installing this meta package to achieve a functional setup and
9781: then adding individual applications.</p></li>
1.189 snj 9782: <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 9783: complete installation of the GNOME platform and desktop as defined
9784: by the GNOME project; this is based on the components distributed in
9785: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9786: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9787: official FTP server. Developer-only tools found in those
9788: directories are not installed unless required by some other
9789: component to work properly. Similarly, packages from the bindings
9790: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9791: in unless required as a dependency for an end-user component. This
1.189 snj 9792: 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>
9793: <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 9794: Installs all the tools required to build a GNOME component when
9795: fetched from the CVS repository. These are required to let the
1.110 hubertf 9796: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9797: </ul></div>
9798: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9799: sorted in a way that eases updates: a package may depend on other
9800: packages listed before it but not on any listed after it. It is very
9801: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9802: change it to alphabetical sorting!</em></span></p>
9803: </div>
1.148 asau 9804: <div class="sect1">
1.85 jmmv 9805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9806: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9807: <p>Almost all GNOME applications are written in C and use a common
9808: set of tools as their build system. Things get different with the new
9809: bindings to other languages (such as Python), but the following will
9810: give you a general idea on the minimum required tools:</p>
1.148 asau 9811: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9812: <li class="listitem">
1.85 jmmv 9813: <p>Almost all GNOME applications use the GNU Autotools as their
9814: build system. As a general rule you will need to tell this to your
9815: package:</p>
1.100 rillig 9816: <pre class="programlisting">
9817: GNU_CONFIGURE=yes
1.85 jmmv 9818: USE_LIBTOOL=yes
1.100 rillig 9819: USE_TOOLS+=gmake
9820: </pre>
1.85 jmmv 9821: </li>
1.128 wiz 9822: <li class="listitem">
1.85 jmmv 9823: <p>If the package uses pkg-config to detect dependencies, add this
9824: tool to the list of required utilities:</p>
9825: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.189 snj 9826: <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 9827: the end of the build process to ensure that you did not miss to
9828: specify any dependency in your package and that the version
9829: requirements are all correct.</p>
9830: </li>
1.128 wiz 9831: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9832: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9833: to handle dependencies and to force the package to use the latest
9834: available version.</p></li>
1.128 wiz 9835: <li class="listitem">
1.85 jmmv 9836: <p>If the package uses gtk-doc (a documentation generation
9837: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9838: tool is rather big and the distfile should come with pregenerated
9839: documentation anyway; if it does not, it is a bug that you ought to
9840: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9841: the default):</p>
9842: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9843: <p>The default location of installed HTML files
9844: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9845: and should not be changed unless the package insists on installing
9846: them somewhere else. Otherwise programs as
1.110 hubertf 9847: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9848: do that with an entry similar to:</p>
9849: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9850: </li>
9851: </ul></div>
9852: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9853: files under the installation prefix to maintain databases. In this
9854: context, shared means that those exact same directories and files are
9855: used among several different packages, leading to conflicts in the
9856: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9857: handle the most common cases, so you have to forget about using
9858: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9859: omitting shared files from them. If you find yourself doing those,
9860: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9861: <p>The following table lists the common situations that result in
9862: using shared directories or files. For each of them, the appropriate
9863: solution is given. After applying the solution be sure to
9864: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9865: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9866: <div class="table">
1.106 rillig 9867: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9868: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9869: <colgroup>
9870: <col>
9871: <col>
9872: </colgroup>
9873: <thead><tr>
9874: <th>If the package...</th>
9875: <th>Then...</th>
9876: </tr></thead>
9877: <tbody>
9878: <tr>
9879: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9880: <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 9881: </tr>
9882: <tr>
9883: <td>Installs icons under the
9884: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9885: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9886: <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 9887: </tr>
9888: <tr>
9889: <td>Installs files under
9890: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9891: <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 9892: </tr>
9893: <tr>
9894: <td>Installs <code class="filename">.desktop</code> files under
9895: <code class="filename">share/applications</code> and these include MIME
9896: information.</td>
1.110 hubertf 9897: <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 9898: </tr>
9899: </tbody>
1.91 rillig 9900: </table></div>
1.85 jmmv 9901: </div>
1.91 rillig 9902: <br class="table-break">
1.85 jmmv 9903: </div>
1.148 asau 9904: <div class="sect1">
1.85 jmmv 9905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9906: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9907: <p>When seeing GNOME as a whole, there are two kinds of
9908: updates:</p>
1.148 asau 9909: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9910: <dt><span class="term">Major update</span></dt>
9911: <dd>
9912: <p>Given that there is still a very long way for GNOME 3 (if it
9913: ever appears), we consider a major update one that goes from a
9914: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9915: where <code class="literal">Y</code> is even and greater than
9916: <code class="literal">X</code>. These are hard to achieve because they
9917: introduce lots of changes in the components' code and almost all
9918: GNOME distfiles are updated to newer versions. Some of them can
9919: even break API and ABI compatibility with the previous major
9920: version series. As a result, the update needs to be done all at
9921: once to minimize breakage.</p>
9922: <p>A major update typically consists of around 80 package
9923: updates and the addition of some new ones.</p>
9924: </dd>
9925: <dt><span class="term">Minor update</span></dt>
9926: <dd>
9927: <p>We consider a minor update one that goes from a
9928: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9929: one where <code class="literal">Y</code> is greater than
9930: <code class="literal">X</code>. These are easy to achieve because they do
9931: not update all GNOME components, can be done in an incremental way
9932: and do not break API nor ABI compatibility.</p>
9933: <p>A minor update typically consists of around 50 package
9934: updates, although the numbers here may vary a lot.</p>
9935: </dd>
9936: </dl></div>
9937: <p>In order to update the GNOME components in pkgsrc to a new stable
9938: release (either major or minor), the following steps should be
9939: followed:</p>
1.128 wiz 9940: <div class="orderedlist"><ol class="orderedlist" type="1">
9941: <li class="listitem">
1.85 jmmv 9942: <p>Get a list of all the tarballs that form the new release by
9943: using the following commands. These will leave the full list of the
1.120 snj 9944: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 9945: file:</p>
1.88 wiz 9946: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9947: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9948: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9949: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9950: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9951: awk '{ print $9 }' >>list.txt</code></strong></pre>
9952: </li>
1.128 wiz 9953: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 9954: bump their version to the release you are updating them to. The
9955: three meta packages should be always consistent with versioning.
9956: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9957: in them.</p></li>
1.128 wiz 9958: <li class="listitem">
1.85 jmmv 9959: <p>For each meta package, update all its
9960: <code class="varname">DEPENDS</code> lines to match the latest versions as
9961: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9962: newer version (even if found in the FTP) because the meta packages
9963: are supposed to list the exact versions that form a specific GNOME
9964: release. Exceptions are permitted here if a newer version solves a
9965: serious issue in the overall desktop experience; these typically
9966: come in the form of a revision bump in pkgsrc, not in newer versions
9967: from the developers.</p>
9968: <p>Packages not listed in the <code class="filename">list.txt</code> file
9969: should be updated to the latest version available (if found in
9970: pkgsrc). This is the case, for example, of the dependencies on the
1.189 snj 9971: 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 9972: </li>
1.128 wiz 9973: <li class="listitem">
1.85 jmmv 9974: <p>Generate a patch from the modified meta packages and extract the
9975: list of "new" lines. This will provide you an outline on what
9976: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9977: <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 9978: </li>
1.128 wiz 9979: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 9980: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 9981: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 9982: of <code class="filename">todo.txt</code> and update the packages listed in
9983: it in order. For major desktop updates none of these should be
1.93 rillig 9984: committed until the entire set is completed because there are chances
1.85 jmmv 9985: of breaking not-yet-updated packages.</p></li>
1.128 wiz 9986: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 9987: the tree one by one with appropriate log messages. At the end,
9988: commit the three meta package updates and all the corresponding
9989: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9990: <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>
9991: </ol></div>
9992: </div>
1.148 asau 9993: <div class="sect1">
1.85 jmmv 9994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9995: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9996: <p>GNOME is a very big component in pkgsrc which approaches 100
9997: packages. Please, it is very important that you always, always,
9998: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 9999: 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 10000: their attention on portability issues and to ensure that future versions
10001: can be built out-of-the box on NetBSD. The less custom patches in
10002: pkgsrc, the easier further updates are. Those developers in charge of
10003: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10004: <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 10005: Bugzilla</a>. Not all components use these to track bugs, but most
10006: of them do. Do not be short on your reports: always provide detailed
10007: explanations of the current failure, how it can be improved to achieve
10008: maximum portability and, if at all possible, provide a patch against CVS
10009: head. The more verbose you are, the higher chances of your patch being
10010: accepted.</p>
10011: <p>Also, please avoid using preprocessor magic to fix portability
10012: issues. While the FreeBSD GNOME people are doing a great job in porting
10013: GNOME to their operating system, the official GNOME sources are now
10014: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10015: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10016: 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 10017: details.</p>
10018: </div>
10019: </div>
1.75 rillig 10020: </div>
1.148 asau 10021: <div class="part">
1.75 rillig 10022: <div class="titlepage"><div><div><h1 class="title">
10023: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10024: <div class="partintro">
1.75 rillig 10025: <div></div>
10026: <p>This part of the guide deals with everything
10027: from the infrastructure that is behind the interfaces described
10028: in the developer's guide. A casual package maintainer should not
10029: need anything from this part.</p>
10030: <div class="toc">
10031: <p><b>Table of Contents</b></p>
1.195 wiz 10032: <dl class="toc">
1.106 rillig 10033: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10034: <dd><dl>
1.106 rillig 10035: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10036: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10037: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10038: <dd><dl>
1.106 rillig 10039: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10040: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10041: </dl></dd>
1.106 rillig 10042: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10043: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10044: <dd><dl>
1.106 rillig 10045: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10046: <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 10047: </dl></dd>
1.106 rillig 10048: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10049: <dd><dl>
1.128 wiz 10050: <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>
10051: <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 10052: </dl></dd>
10053: </dl></dd>
1.106 rillig 10054: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10055: <dd><dl>
1.106 rillig 10056: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10057: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10058: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10059: <dd><dl>
1.106 rillig 10060: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10061: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10062: </dl></dd>
10063: </dl></dd>
1.106 rillig 10064: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10065: <dd><dl>
1.106 rillig 10066: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10067: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10068: </dl></dd>
10069: </dl>
10070: </div>
10071: </div>
1.148 asau 10072: <div class="chapter">
1.75 rillig 10073: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10074: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10075: <div class="toc">
10076: <p><b>Table of Contents</b></p>
1.195 wiz 10077: <dl class="toc">
1.106 rillig 10078: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10079: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10080: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10081: <dd><dl>
1.106 rillig 10082: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10083: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10084: </dl></dd>
1.106 rillig 10085: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10086: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10087: <dd><dl>
1.106 rillig 10088: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10089: <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 10090: </dl></dd>
1.106 rillig 10091: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10092: <dd><dl>
1.128 wiz 10093: <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>
10094: <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 10095: </dl></dd>
10096: </dl>
10097: </div>
10098: <p>The pkgsrc infrastructure consists of many small Makefile
10099: fragments. Each such fragment needs a properly specified
10100: interface. This chapter explains how such an interface looks
10101: like.</p>
1.148 asau 10102: <div class="sect1">
1.75 rillig 10103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10104: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10105: <p>Whenever a variable is defined in the pkgsrc
10106: infrastructure, the location and the way of definition provide
10107: much information about the intended use of that variable.
10108: Additionally, more documentation may be found in a header
10109: comment or in this pkgsrc guide.</p>
10110: <p>A special file is
10111: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10112: variables that are intended to be user-defined. They are either
10113: defined using the <code class="literal">?=</code> operator or they are
10114: left undefined because defining them to anything would
1.128 wiz 10115: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10116: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10117: file.</p>
10118: <p>Outside this file, the following conventions apply:
10119: Variables that are defined using the <code class="literal">?=</code>
10120: operator may be overridden by a package.</p>
10121: <p>Variables that are defined using the <code class="literal">=</code>
10122: operator may be used read-only at run-time.</p>
10123: <p>Variables whose name starts with an underscore must not be
10124: accessed outside the pkgsrc infrastructure at all. They may
10125: change without further notice.</p>
1.148 asau 10126: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10127: <h3 class="title">Note</h3>
10128: <p>These conventions are currently not applied
10129: consistently to the complete pkgsrc
10130: infrastructure.</p>
10131: </div>
10132: </div>
1.148 asau 10133: <div class="sect1">
1.81 rillig 10134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10135: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10136: <p>All variables that contain lists of things should default
10137: to being empty. Two examples that do not follow this rule are
10138: <code class="varname">USE_LANGUAGES</code> and
10139: <code class="varname">DISTFILES</code>. These variables cannot simply be
10140: modified using the <code class="literal">+=</code> operator in package
10141: <code class="filename">Makefile</code>s (or other files included by
10142: them), since there is no guarantee whether the variable is
10143: already set or not, and what its value is. In the case of
1.128 wiz 10144: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10145: the default value and just define it as in the following
10146: example.</p>
10147: <pre class="programlisting">
1.100 rillig 10148: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10149: </pre>
10150: <p>Because of the selection of this default value, the same
10151: value appears in many package Makefiles. Similarly for
10152: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10153: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10154: doesn't stand out. Nevertheless it is mentioned in many
10155: files.</p>
10156: </div>
1.148 asau 10157: <div class="sect1">
1.81 rillig 10158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10159: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 10160: <div class="sect2">
1.75 rillig 10161: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10162: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10163: <p>Variable evaluation takes place either at load time or at
10164: runtime, depending on the context in which they occur. The
10165: contexts where variables are evaluated at load time are:</p>
1.148 asau 10166: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10167: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10168: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10169: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10170: <code class="literal">.for</code>,</p></li>
1.128 wiz 10171: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10172: </ul></div>
10173: <p>A special exception are references to the iteration
10174: variables of <code class="literal">.for</code> loops, which are expanded
10175: inline, no matter in which context they appear.</p>
10176: <p>As the values of variables may change during load time,
10177: care must be taken not to evaluate them by accident. Typical
10178: examples for variables that should not be evaluated at load time
10179: are <code class="varname">DEPENDS</code> and
10180: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10181: clear, here is an example:</p>
10182: <pre class="programlisting">
1.100 rillig 10183: CONFIGURE_ARGS= # none
10184: CFLAGS= -O
10185: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10186:
1.100 rillig 10187: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10188:
1.100 rillig 10189: CFLAGS+= -Wall
1.75 rillig 10190: </pre>
10191: <p>This code shows how the use of the <code class="literal">:=</code>
10192: operator can quickly lead to unexpected results. The first
10193: paragraph is fairly common code. The second paragraph evaluates
10194: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10195: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10196: <code class="literal">-Wall</code> is appended to the
10197: <code class="varname">CFLAGS</code>, but this addition will not appear in
10198: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10199: paragraphs from above typically occur in completely unrelated
10200: files.</p>
10201: </div>
1.148 asau 10202: <div class="sect2">
1.75 rillig 10203: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10204: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10205: <p>After all the files have been loaded, the values of the
10206: variables cannot be changed anymore. Variables that are used in
10207: the shell commands are expanded at this point.</p>
10208: </div>
10209: </div>
1.148 asau 10210: <div class="sect1">
1.75 rillig 10211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10212: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10213: <p>There are many ways in which the definition and use of a
10214: variable can be restricted in order to detect bugs and
10215: violations of the (mostly unwritten) policies. See the
10216: <code class="literal">pkglint</code> developer's documentation for further
10217: details.</p>
10218: </div>
1.148 asau 10219: <div class="sect1">
1.78 rillig 10220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10221: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10222: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10223: of the following classes. Cases where a file falls into more
10224: than one class should be avoided as it often leads to subtle
10225: bugs.</p>
1.148 asau 10226: <div class="sect2">
1.75 rillig 10227: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10228: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10229: <p>In a traditional imperative programming language some of
1.76 rillig 10230: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10231: procedures. They take some input parameters and—after
10232: inclusion—provide a result in output parameters. Since all
1.76 rillig 10233: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10234: care must be taken not to use parameter names that have already
10235: another meaning. For example, <code class="varname">PKGNAME</code> is a
10236: bad choice for a parameter name.</p>
10237: <p>Procedures are completely evaluated at preprocessing time.
10238: That is, when calling a procedure all input parameters must be
10239: completely resolvable. For example,
10240: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10241: parameter since it is very likely that further text will be
10242: added after calling the procedure, which would effectively apply
10243: the procedure to only a part of the variable. Also, references
10244: to other variables wit will be modified after calling the
10245: procedure.</p>
10246: <p>A procedure can declare its output parameters either as
10247: suitable for use in preprocessing directives or as only
10248: available at runtime. The latter alternative is for variables
10249: that contain references to other runtime variables.</p>
10250: <p>Procedures shall be written such that it is possible to
10251: call the procedure more than once. That is, the file must not
10252: contain multiple-inclusion guards.</p>
10253: <p>Examples for procedures are
1.76 rillig 10254: <code class="filename">mk/bsd.options.mk</code> and
10255: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10256: that the parameters are evaluated at load time, they should be
10257: assigned using the <code class="literal">:=</code> operator, which should
10258: be used only for this purpose.</p>
10259: </div>
1.148 asau 10260: <div class="sect2">
1.75 rillig 10261: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10262: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10263: <p>Action files take some input parameters and may define
10264: runtime variables. They shall not define loadtime variables.
10265: There are action files that are included implicitly by the
10266: pkgsrc infrastructure, while other must be included
10267: explicitly.</p>
10268: <p>An example for action files is
1.76 rillig 10269: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10270: </div>
10271: </div>
1.148 asau 10272: <div class="sect1">
1.81 rillig 10273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10274: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10275: <p>Package <code class="filename">Makefile</code>s usually consist of
10276: a set of variable definitions, and include the file
10277: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10278: Before that, they may also include various other
10279: <code class="filename">*.mk</code> files if they need to query the
10280: availability of certain features like the type of compiler or
10281: the X11 implementation. Due to the heavy use of preprocessor
10282: directives like <code class="literal">.if</code> and
10283: <code class="literal">.for</code>, the order in which the files are loaded
10284: matters.</p>
10285: <p>This section describes at which point the various files
10286: are loaded and gives reasons for that order.</p>
1.148 asau 10287: <div class="sect2">
1.81 rillig 10288: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10289: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10290: </h3></div></div></div>
10291: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10292: is to define some essential variables like
10293: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10294: <code class="varname">MACHINE_ARCH</code>.</p>
10295: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10296: 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 10297: After that, those variables
1.81 rillig 10298: that have not been overridden by the user are loaded from
10299: <code class="filename">mk/defaults/mk.conf</code>.</p>
10300: <p>After the user settings, the system settings and platform
10301: settings are loaded, which may override the user
10302: settings.</p>
10303: <p>Then, the tool definitions are loaded. The tool wrappers
10304: are not yet in effect. This only happens when building a
10305: package, so the proper variables must be used instead of the
10306: direct tool names.</p>
10307: <p>As the last steps, some essential variables from the
10308: wrapper and the package system flavor are loaded, as well as the
10309: variables that have been cached in earlier phases of a package
10310: build.</p>
10311: </div>
1.148 asau 10312: <div class="sect2">
1.81 rillig 10313: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10314: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10315: </h3></div></div></div>
1.81 rillig 10316: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10317: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10318: loaded, which fill default values for those variables that have
1.93 rillig 10319: not been defined by the package. These variables may later
1.81 rillig 10320: be used even in unrelated files.</p>
10321: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10322: provides the target <code class="literal">error-check</code> that is added
10323: as a special dependency to all other targets that use
10324: <code class="varname">DELAYED_ERROR_MSG</code> or
10325: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10326: <p>Then, the package-specific hacks from
10327: <code class="filename">hacks.mk</code> are included.</p>
10328: <p>Then, various other files follow. Most of them don't have
10329: any dependencies on what they need to have included before or
10330: after them, though some do.</p>
10331: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10332: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10333: restricts the use of these variables to all the files that have
10334: been included before. Appearances in later files will be
10335: silently ignored.</p>
10336: <p>Then, the files for the main targets are included, in the
10337: order of later execution, though the actual order should not
10338: matter.</p>
10339: <p>At last, some more files are included that don't set any
10340: interesting variables but rather just define make targets to be
10341: executed.</p>
10342: </div>
10343: </div>
1.75 rillig 10344: </div>
1.148 asau 10345: <div class="chapter">
1.75 rillig 10346: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10347: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10348: <div class="toc">
10349: <p><b>Table of Contents</b></p>
1.195 wiz 10350: <dl class="toc">
1.106 rillig 10351: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10352: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10353: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10354: <dd><dl>
1.106 rillig 10355: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10356: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10357: </dl></dd>
10358: </dl>
10359: </div>
10360: <p>The pkgsrc infrastructure consists of a large codebase,
10361: and there are many corners where every little bit of a file is
10362: well thought out, making pkgsrc likely to fail as soon as
10363: anything is changed near those parts. To prevent most changes
10364: from breaking anything, a suite of regression tests should go
10365: along with every important part of the pkgsrc infrastructure.
10366: This chapter describes how regression tests work in pkgsrc and
10367: how you can add new tests.</p>
1.148 asau 10368: <div class="sect1">
1.75 rillig 10369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10370: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10371: <p></p>
10372: </div>
1.148 asau 10373: <div class="sect1">
1.75 rillig 10374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10375: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.189 snj 10376: <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 10377: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10378: can simply run that command, which will run all tests in the
1.76 rillig 10379: <code class="filename">regress</code> category.</p>
1.75 rillig 10380: </div>
1.148 asau 10381: <div class="sect1">
1.75 rillig 10382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10383: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10384: <p>Every directory in the <code class="filename">regress</code>
10385: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10386: is considered a regression test. This file is a shell program
1.110 hubertf 10387: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10388: The following functions can be overridden to suit your
10389: needs.</p>
1.148 asau 10390: <div class="sect2">
1.75 rillig 10391: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10392: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10393: <p>These functions do not take any parameters. They are all
1.128 wiz 10394: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10395: to check the exitcodes of any commands you run in the
10396: test.</p>
1.148 asau 10397: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10398: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10399: <dd><p>This function prepares the environment for the
10400: test. By default it does nothing.</p></dd>
10401: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10402: <dd><p>This function runs the actual test. By default,
10403: it calls <code class="varname">TEST_MAKE</code> with the arguments
10404: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10405: error messages into the file
10406: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10407: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10408: <dd><p>This function is run after the test and is
10409: typically used to compare the actual output from the one that is
10410: expected. It can make use of the various helper functions from
10411: the next section.</p></dd>
10412: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10413: <dd><p>This function cleans everything up after the
10414: test has been run. By default it does nothing.</p></dd>
10415: </dl></div>
10416: </div>
1.148 asau 10417: <div class="sect2">
1.75 rillig 10418: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10419: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 asau 10420: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10421: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10422: <dd><p>This function compares the exitcode of the
1.110 hubertf 10423: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10424: If they differ, the test will fail.</p></dd>
10425: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10426: <dd><p>This function checks for each of its parameters
1.110 hubertf 10427: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10428: extended regular expression. If it does not, the test will
10429: fail.</p></dd>
10430: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10431: <dd><p>This function checks for each of its parameters
1.110 hubertf 10432: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10433: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10434: If any of the regular expressions matches, the test will
10435: fail.</p></dd>
10436: </dl></div>
10437: </div>
10438: </div>
10439: </div>
1.148 asau 10440: <div class="chapter">
1.75 rillig 10441: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10442: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10443: <div class="toc">
10444: <p><b>Table of Contents</b></p>
1.195 wiz 10445: <dl class="toc">
1.106 rillig 10446: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10447: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10448: </dl>
10449: </div>
10450: <p>The pkgsrc system has already been ported to many
10451: operating systems, hardware architectures and compilers. This
10452: chapter explains the necessary steps to make pkgsrc even more
10453: portable.</p>
1.148 asau 10454: <div class="sect1">
1.75 rillig 10455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10456: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10457: <p>To port pkgsrc to a new operating system (called
10458: <code class="literal">MyOS</code> in this example), you need to touch the
10459: following files:</p>
1.148 asau 10460: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10461: <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 10462: <dd><p>This file contains some basic definitions, for
10463: example the name of the C
10464: compiler.</p></dd>
1.76 rillig 10465: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10466: <dd><p>Insert code that defines the variables
10467: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10468: <code class="varname">LOWER_OS_VERSION</code>,
10469: <code class="varname">LOWER_VENDOR</code>,
10470: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10471: <code class="varname">APPEND_ELF</code>, and the other variables that
10472: appear in this file.</p></dd>
1.93 rillig 10473: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10474: <dd><p>This file contains the platform-specific
10475: definitions that are used by pkgsrc. Start by copying one of the
10476: other files and edit it to your
10477: needs.</p></dd>
1.93 rillig 10478: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10479: <dd><p>This file defines the paths to all the tools
10480: that are needed by one or the other package in pkgsrc, as well
10481: as by pkgsrc itself. Find out where these tools are on your
10482: platform and add them.</p></dd>
10483: </dl></div>
10484: <p>Now, you should be able to build some basic packages, like
1.189 snj 10485: <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 10486: </div>
1.148 asau 10487: <div class="sect1">
1.75 rillig 10488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10489: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10490: <p>TODO</p>
10491: </div>
10492: </div>
10493: </div>
1.148 asau 10494: <div class="appendix">
10495: <div class="titlepage"><div><div><h1 class="title">
10496: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10497: <div class="toc">
10498: <p><b>Table of Contents</b></p>
1.195 wiz 10499: <dl class="toc">
1.75 rillig 10500: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10501: <dd><dl>
10502: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10503: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10504: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10505: <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 10506: </dl></dd>
10507: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10508: </dl>
10509: </div>
10510: <p>We checked to find a piece of software that wasn't in the packages
10511: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10512: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10513: present in the tree is beyond us, but it's useful for the purposes of
10514: this exercise.</p>
1.148 asau 10515: <div class="sect1">
1.75 rillig 10516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10517: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10518: <div class="sect2">
1.75 rillig 10519: <div class="titlepage"><div><div><h3 class="title">
10520: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10521: <pre class="programlisting">
1.100 rillig 10522: # $NetBSD$
10523: #
1.1 grant 10524:
1.100 rillig 10525: DISTNAME= bison-1.25
10526: CATEGORIES= devel
10527: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10528:
1.136 dholland 10529: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10530: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10531: COMMENT= GNU yacc clone
1.1 grant 10532:
1.100 rillig 10533: GNU_CONFIGURE= yes
1.152 wiz 10534: INFO_FILES= yes
1.1 grant 10535:
1.100 rillig 10536: .include "../../mk/bsd.pkg.mk"
1.1 grant 10537: </pre>
1.75 rillig 10538: </div>
1.148 asau 10539: <div class="sect2">
1.75 rillig 10540: <div class="titlepage"><div><div><h3 class="title">
10541: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10542: <pre class="programlisting">
1.100 rillig 10543: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.189 snj 10544: 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 10545: of the NetBSD source tree is beyond me.
1.1 grant 10546: </pre>
1.75 rillig 10547: </div>
1.148 asau 10548: <div class="sect2">
1.75 rillig 10549: <div class="titlepage"><div><div><h3 class="title">
10550: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10551: <pre class="programlisting">
1.100 rillig 10552: @comment $NetBSD$
10553: bin/bison
10554: man/man1/bison.1.gz
10555: share/bison.simple
10556: share/bison.hairy
1.1 grant 10557: </pre>
1.75 rillig 10558: </div>
1.148 asau 10559: <div class="sect2">
1.75 rillig 10560: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10561: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10562: </h3></div></div></div>
1.75 rillig 10563: <p>The NetBSD package system comes with
1.189 snj 10564: <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 10565: which helps to check the contents of these
10566: files. After installation it is quite easy to use, just change to the
10567: directory of the package you wish to examine and execute
1.110 hubertf 10568: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10569: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10570: looks fine.</pre>
10571: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10572: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10573: -Wall</strong></span> for a very thorough check.</p>
10574: </div>
10575: </div>
1.148 asau 10576: <div class="sect1">
1.75 rillig 10577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10578: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10579: <p>Create the directory where the package lives,
10580: plus any auxiliary directories:</p>
10581: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10582: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10583: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10584: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10585: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10586: <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 10587: then continue with fetching the distfile:</p>
10588: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10589: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10590: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10591: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10592: ftp: Error retrieving file: 500 Internal error
10593:
10594: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10595: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10596: ftp: Error retrieving file: 500 Internal error
10597:
10598: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10599: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10600: Successfully retrieved file.</pre>
10601: <p>Generate the checksum of the distfile into
1.76 rillig 10602: <code class="filename">distinfo</code>:</p>
1.88 wiz 10603: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10604: <p>Now compile:</p>
10605: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10606: >> Checksum OK for bison-1.25.tar.gz.
10607: ===> Extracting for bison-1.25
10608: ===> Patching for bison-1.25
10609: ===> Ignoring empty patch directory
10610: ===> Configuring for bison-1.25
10611: creating cache ./config.cache
10612: checking for gcc... cc
10613: checking whether we are using GNU C... yes
10614: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10615: checking how to run the C preprocessor... cc -E
10616: checking for minix/config.h... no
10617: checking for POSIXized ISC... no
10618: checking whether cross-compiling... no
10619: checking for ANSI C header files... yes
10620: checking for string.h... yes
10621: checking for stdlib.h... yes
10622: checking for memory.h... yes
10623: checking for working const... yes
10624: checking for working alloca.h... no
10625: checking for alloca... yes
10626: checking for strerror... yes
10627: updating cache ./config.cache
10628: creating ./config.status
10629: creating Makefile
10630: ===> Building for bison-1.25
10631: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10632: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10633: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10634: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10635: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10636: 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 10637: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10638: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10639: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
10640: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lex.c
10641: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
10642: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.c
10643: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
10644: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
10645: 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
10646: 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
10647: 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
10648: 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
10649: 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
10650: 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
10651: 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
10652: 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
10653: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10654: rm -f bison.s1
1.75 rillig 10655: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10656: <p>Everything seems OK, so install the files:</p>
10657: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10658: >> Checksum OK for bison-1.25.tar.gz.
10659: ===> Installing for bison-1.25
10660: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10661: rm -f /usr/pkg/bin/bison
10662: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10663: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10664: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10665: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10666: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10667: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10668: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10669: ===> Registering installation for bison-1.25</pre>
10670: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10671: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10672: binary package, do this now:</p>
10673: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10674: >> Checksum OK for bison-1.25.tar.gz.
10675: ===> Building package for bison-1.25
10676: Creating package bison-1.25.tgz
10677: Registering depends:.
1.75 rillig 10678: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10679: <p>Now that you don't need the source and object files
10680: any more, clean up:</p>
10681: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10682: ===> Cleaning for bison-1.25</pre>
10683: </div>
10684: </div>
1.148 asau 10685: <div class="appendix">
10686: <div class="titlepage"><div><div><h1 class="title">
10687: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10688: <div class="toc">
10689: <p><b>Table of Contents</b></p>
1.195 wiz 10690: <dl class="toc">
1.75 rillig 10691: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10692: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10693: </dl>
10694: </div>
1.148 asau 10695: <div class="sect1">
1.75 rillig 10696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10697: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10698: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10699: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10700: => figlet221.tar.gz doesn't seem to exist on this system.
10701: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10702: => [172219 bytes]
10703: Connected to ftp.plig.net.
10704: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10705: 331 Guest login ok, send your complete e-mail address as password.
10706: 230-You are user #5 of 500 simultaneous users allowed.
10707: 230-
1.68 rillig 10708: 230- ___ _ _ _
10709: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10710: 230- | _| _| . |_| . | | | . |_| . | _| . |
10711: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10712: 230- |_| |_| |___| |___|
10713: 230-
10714: 230-** Welcome to ftp.plig.org **
10715: 230-
10716: 230-Please note that all transfers from this FTP site are logged. If you
10717: 230-do not like this, please disconnect now.
10718: 230-
1.120 snj 10719: 230-This archive is available via
1.1 grant 10720: 230-
10721: 230-HTTP: http://ftp.plig.org/
10722: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10723: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10724: 230-
10725: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10726: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10727: 230-
10728: 230-
10729: 230 Logged in anonymously.
10730: Remote system type is UNIX.
10731: Using binary mode to transfer files.
10732: 200 Type okay.
10733: 250 "/pub" is new cwd.
10734: 250-"/pub/figlet" is new cwd.
10735: 250-
10736: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10737: 250-
1.75 rillig 10738: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10739: 250-
10740: 250-The official FIGlet web page is:
1.75 rillig 10741: 250- http://www.figlet.org/
1.1 grant 10742: 250-
10743: 250-If you have questions, please mailto:info@figlet.org. If you want to
10744: 250-contribute a font or something else, you can email us.
1.68 rillig 10745: 250
1.1 grant 10746: 250 "/pub/figlet/program" is new cwd.
10747: 250 "/pub/figlet/program/unix" is new cwd.
10748: local: figlet221.tar.gz remote: figlet221.tar.gz
10749: 502 Unimplemented command.
10750: 227 Entering Passive Mode (195,40,6,41,246,104)
10751: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10752: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10753: 226 Transfer completed.
10754: 172219 bytes received in 00:02 (75.99 KB/s)
10755: 221 Goodbye.
10756: => Checksum OK for figlet221.tar.gz.
10757: ===> Extracting for figlet-2.2.1nb2
10758: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10759: ===> Patching for figlet-2.2.1nb2
10760: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10761: ===> Overriding tools for figlet-2.2.1nb2
10762: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10763: ===> Configuring for figlet-2.2.1nb2
10764: ===> Building for figlet-2.2.1nb2
10765: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10766: chmod a+x figlet
10767: gcc -O2 -o chkfont chkfont.c
10768: => Unwrapping files-to-be-installed.
1.14 xtraeme 10769: <code class="prompt">#</code>
1.75 rillig 10770: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10771: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10772: ===> Installing for figlet-2.2.1nb2
10773: install -d -o root -g wheel -m 755 /usr/pkg/bin
10774: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10775: mkdir -p /usr/pkg/share/figlet
10776: cp figlet /usr/pkg/bin
10777: cp chkfont /usr/pkg/bin
10778: chmod 555 figlist showfigfonts
10779: cp figlist /usr/pkg/bin
10780: cp showfigfonts /usr/pkg/bin
10781: cp fonts/*.flf /usr/pkg/share/figlet
10782: cp fonts/*.flc /usr/pkg/share/figlet
10783: cp figlet.6 /usr/pkg/man/man6
10784: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10785: <code class="prompt">#</code></pre>
10786: </div>
1.148 asau 10787: <div class="sect1">
1.75 rillig 10788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10789: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10790: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10791: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10792: ===> Packaging figlet-2.2.1nb2
10793: ===> Building binary package for figlet-2.2.1nb2
10794: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10795: Using SrcDir value of /usr/pkg
1.68 rillig 10796: Registering depends:.
1.75 rillig 10797: <code class="prompt">#</code></pre>
10798: </div>
10799: </div>
1.148 asau 10800: <div class="appendix">
10801: <div class="titlepage"><div><div><h1 class="title">
10802: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10803: <div class="toc">
10804: <p><b>Table of Contents</b></p>
1.195 wiz 10805: <dl class="toc">
1.128 wiz 10806: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10807: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10808: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10809: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10810: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10811: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10812: source packages</a></span></dt>
10813: </dl>
10814: </div>
10815: <p>As in other big projects, the directory layout of pkgsrc
10816: is quite complex for newbies. This chapter explains where you
10817: find things on the FTP server. The base directory on
1.110 hubertf 10818: <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 10819: On other servers it may be different, but inside this directory,
10820: everything should look the same, no matter on which server you
10821: are. This directory contains some subdirectories, which are
10822: explained below.</p>
1.148 asau 10823: <div class="sect1">
1.76 rillig 10824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10825: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10826: <p>The directory <code class="filename">distfiles</code> contains lots
10827: of archive files from all pkgsrc packages, which are mirrored
10828: here. The subdirectories are called after their package names
10829: and are used when the distributed files have names that don't
10830: explicitly contain a version number or are otherwise too generic
10831: (for example <code class="filename">release.tar.gz</code>).</p>
10832: </div>
1.148 asau 10833: <div class="sect1">
1.76 rillig 10834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10835: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10836: <p>This directory contains things that individual pkgsrc
10837: developers find worth publishing.</p>
10838: </div>
1.148 asau 10839: <div class="sect1">
1.76 rillig 10840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10841: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10842: <p>This directory contains binary packages for the various
10843: platforms that are supported by pkgsrc.
10844: 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 10845: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10846: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10847: operating system for which the packages have been built. The
1.110 hubertf 10848: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10849: command, so it may differ from the one you are used to
10850: hear.</p></li>
1.128 wiz 10851: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10852: architecture of the platform for which the packages have been
1.110 hubertf 10853: built. It also includes the <code class="varname">ABI</code> (Application
10854: Binary Interface) for platforms that have several of
10855: them.</p></li>
1.128 wiz 10856: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10857: the operating system. For version numbers that change often (for
10858: example NetBSD-current), the often-changing part should be
10859: replaced with an <code class="literal">x</code>, for example
10860: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10861: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10862: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10863: for a stable branch, or <code class="literal">head</code> for packages
10864: built from the HEAD branch. The latter should only be used when
10865: the packages are updated on a regular basis. Otherwise the date
10866: from checking out pkgsrc should be appended, for example
10867: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10868: </ul></div>
10869: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10870: can quickly click through the directories on the
10871: server and find the best binary packages for their machines. Since they
10872: usually know the operating system and the hardware architecture, OPSYS
10873: and ARCH are placed first. After these choices, they can select the
10874: best combination of OSVERSION and TAG together, since it is usually the
10875: case that packages stay compatible between different version of the
10876: operating system.</p>
10877: <p>In each of these directories, there is a
10878: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10879: <code class="filename">All</code> which contains all binary packages.
10880: Besides that, there are various category directories that
10881: contain symbolic links to the real binary packages.</p>
10882: </div>
1.148 asau 10883: <div class="sect1">
1.76 rillig 10884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10885: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10886: <p>Here are the reports from bulk builds, for those who want
10887: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10888: 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 10889: </div>
1.148 asau 10890: <div class="sect1">
1.108 rillig 10891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10892: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10893: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10894: source packages</h2></div></div></div>
1.128 wiz 10895: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10896: that is the files that define how to create binary packages from
10897: source archives.</p>
10898: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10899: snapshot of the CVS repository, which is updated regularly. The
10900: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10901: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10902: <p>In the directories for the quarterly branches, there is an
10903: additional file called
1.126 jakllsch 10904: <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 10905: which contains the state of pkgsrc when it was branched.</p>
10906: </div>
1.75 rillig 10907: </div>
1.148 asau 10908: <div class="appendix">
10909: <div class="titlepage"><div><div><h1 class="title">
10910: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 10911: <div class="toc">
10912: <p><b>Table of Contents</b></p>
1.195 wiz 10913: <dl class="toc">
1.79 rillig 10914: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10915: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10916: </dl>
10917: </div>
1.79 rillig 10918: <p>This section contains information on editing the pkgsrc
10919: guide itself.</p>
1.148 asau 10920: <div class="sect1">
1.75 rillig 10921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10922: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10923: <p>The pkgsrc guide's source code is stored in
10924: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10925: are created from it:</p>
1.148 asau 10926: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10927: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10928: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10929: <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>
10930: <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 10931: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 10932: <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 10933: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10934: </ul></div>
10935: </div>
1.148 asau 10936: <div class="sect1">
1.75 rillig 10937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10938: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10939: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 10940: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 10941: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 10942: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 10943: documentation) installed. These are automatically installed when
1.189 snj 10944: 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 10945: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 10946: right directory. All further steps will take place
10947: here.</p></li>
1.148 asau 10948: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 10949: <code class="filename">files/</code>.</p></li>
1.148 asau 10950: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 10951: guide for valid XML and to build the final output files. If you
10952: get any errors at this stage, you can just edit the files, as
10953: there are only symbolic links in the working directory, pointing
10954: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 10955: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 10956: commit)</strong></span></p></li>
1.148 asau 10957: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 10958: regenerate the output files with the proper RCS
10959: Ids.</p></li>
1.148 asau 10960: <li class="step">
1.110 hubertf 10961: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 10962: commit the files in both <code class="filename">pkgsrc/doc</code> and
10963: <code class="filename">htdocs</code>.</p>
1.148 asau 10964: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 10965: <h3 class="title">Note</h3>
10966: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 10967: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10968: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 10969: directory.</p>
10970: </div>
10971: </li>
1.79 rillig 10972: </ol></div>
1.75 rillig 10973: </div>
10974: </div>
10975: </div></body>
1.1 grant 10976: </html>
CVSweb <webmaster@jp.NetBSD.org>