Annotation of pkgsrc/doc/pkgsrc.html, revision 1.178
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.104 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.106 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.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>
48: <dl>
49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
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.106 rillig 136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
1.174 asau 138: <dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
1.106 rillig 139: <dd><dl>
1.174 asau 140: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
141: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
1.106 rillig 142: </dl></dd>
1.174 asau 143: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
144: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 145: </dl></dd>
146: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
147: <dd><dl>
1.128 wiz 148: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
149: <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 150: </dl></dd>
151: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
152: <dd><dl>
153: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
154: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
155: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
156: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
157: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
158: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
159: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.173 wiz 160: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
161: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
162: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
163: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 164: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.173 wiz 165: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
166: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
167: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
168: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
169: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
170: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
171: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. 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 172: </dl></dd>
173: </dl></dd>
174: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
175: <dd><dl>
1.106 rillig 176: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 177: <dd><dl>
1.106 rillig 178: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 179: <dd><dl>
1.106 rillig 180: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 181: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 182: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 183: </dl></dd>
1.106 rillig 184: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
185: <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>
186: </dl></dd>
187: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
188: <dd><dl>
1.128 wiz 189: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
190: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 191: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
192: <dd><dl>
193: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
194: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
195: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
196: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
197: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
198: </dl></dd>
199: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
200: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
201: <dd><dl>
202: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
203: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
204: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
205: </dl></dd>
1.128 wiz 206: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
207: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 208: </dl></dd>
1.128 wiz 209: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 210: <dd><dl>
211: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 212: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 213: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
214: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
215: <dd><dl>
216: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
217: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
218: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
219: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
220: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
221: </dl></dd>
222: </dl></dd>
223: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
224: <dd><dl>
225: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 226: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
227: <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 228: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
229: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 230: <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 231: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
232: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
233: </dl></dd>
234: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
235: <dd><dl>
236: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 237: <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 238: <dd><dl>
239: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 240: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
241: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
242: and
243: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
244: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 245: </dl></dd>
1.128 wiz 246: <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 247: <dd><dl>
1.128 wiz 248: <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 249: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
250: </dl></dd>
251: </dl></dd>
252: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
253: <dd><dl>
254: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
255: <dd><dl>
256: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
257: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
258: </dl></dd>
259: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
260: <dd><dl>
1.128 wiz 261: <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 262: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
263: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
264: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
265: </dl></dd>
266: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
267: <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>
268: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
269: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
270: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
271: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
272: <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>
273: </dl></dd>
274: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
275: <dd><dl>
276: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 277: <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 278: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 279: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 280: </dl></dd>
281: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
282: <dd><dl>
283: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
284: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
285: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
286: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 287: <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 288: <dd><dl>
289: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
290: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
291: </dl></dd>
1.128 wiz 292: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
299: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
301: <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 302: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
303: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
304: </dl></dd>
305: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
306: <dd><dl>
307: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
308: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
309: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
310: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
311: </dl></dd>
312: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
315: <dd><dl>
316: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 317: <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 318: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
319: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
320: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
321: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
322: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
323: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
324: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
325: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
326: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
327: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
328: </dl></dd>
1.128 wiz 329: <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 330: <dd><dl>
331: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
332: <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>
333: </dl></dd>
1.128 wiz 334: <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 335: <dd><dl>
336: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
337: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
338: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
339: </dl></dd>
340: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
341: <dd><dl>
342: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
343: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
344: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 345: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
346: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 347: </dl></dd>
1.128 wiz 348: <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 349: <dd><dl>
350: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
351: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 352: <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 353: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
354: </dl></dd>
1.128 wiz 355: <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 356: <dd><dl>
357: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
358: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
359: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
360: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
361: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
362: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
363: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
364: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 365: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 366: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 367: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
368: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
369: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
370: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
371: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
372: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
373: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
374: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 375: emulation</a></span></dt>
1.106 rillig 376: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
377: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 378: </dl></dd>
1.106 rillig 379: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 380: </dl></dd>
1.106 rillig 381: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
382: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 383: <dd><dl>
1.106 rillig 384: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
385: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
386: <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 387: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 388: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 389: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
390: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 391: </dl></dd>
392: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
393: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
394: <dd><dl>
395: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
396: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
397: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
398: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 399: </dl></dd>
1.75 rillig 400: </dl></dd>
401: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
402: <dd><dl>
1.106 rillig 403: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 404: <dd><dl>
1.106 rillig 405: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
406: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
407: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 408: <dd><dl>
1.106 rillig 409: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
410: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 411: </dl></dd>
1.106 rillig 412: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
413: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 414: <dd><dl>
1.106 rillig 415: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
416: <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 417: </dl></dd>
1.106 rillig 418: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 419: <dd><dl>
1.128 wiz 420: <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>
421: <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 422: </dl></dd>
423: </dl></dd>
1.106 rillig 424: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 425: <dd><dl>
1.106 rillig 426: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
427: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
428: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 429: <dd><dl>
1.106 rillig 430: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
431: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 432: </dl></dd>
433: </dl></dd>
1.106 rillig 434: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 435: <dd><dl>
1.106 rillig 436: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
437: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 438: </dl></dd>
439: </dl></dd>
440: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
441: <dd><dl>
442: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
443: <dd><dl>
444: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
445: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
446: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 447: <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 448: </dl></dd>
449: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
450: </dl></dd>
451: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
452: <dd><dl>
453: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
454: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
455: </dl></dd>
1.76 rillig 456: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
457: <dd><dl>
1.128 wiz 458: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
459: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
460: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
461: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
462: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
463: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 464: source packages</a></span></dt>
465: </dl></dd>
1.75 rillig 466: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
467: <dd><dl>
1.79 rillig 468: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 469: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
470: </dl></dd>
471: </dl>
472: </div>
1.82 rillig 473: <div class="list-of-tables">
474: <p><b>List of Tables</b></p>
475: <dl>
476: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
477: </dt>
1.106 rillig 478: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 479: </dt>
1.106 rillig 480: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 481: </dt>
1.82 rillig 482: </dl>
483: </div>
1.148 asau 484: <div class="chapter">
485: <div class="titlepage"><div><div><h1 class="title">
486: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 487: <div class="toc">
488: <p><b>Table of Contents</b></p>
489: <dl>
490: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 491: <dd><dl>
492: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
493: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
494: </dl></dd>
1.75 rillig 495: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
496: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 497: <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 498: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
499: </dl>
500: </div>
1.148 asau 501: <div class="sect1">
1.75 rillig 502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
503: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 504: <p>There is a lot of software freely available for Unix-based
505: systems, which is usually available in form of the source code. Before
506: such software can be used, it needs to be configured to the local
507: system, compiled and installed, and this is exactly what The NetBSD
508: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
509: to handle binary packages, so that not every user has to build the
510: packages for himself, which is a time-costly task.</p>
1.75 rillig 511: <p>pkgsrc currently contains several thousand packages,
512: including:</p>
1.148 asau 513: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 514: <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 515: web server</p></li>
1.128 wiz 516: <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 517: web browser</p></li>
1.128 wiz 518: <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 519: Desktop Environment</p></li>
1.128 wiz 520: <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 521: Desktop Environment</p></li>
522: </ul></div>
523: <p>...just to name a few.</p>
524: <p>pkgsrc has built-in support for handling varying dependencies,
525: such as pthreads and X11, and extended features such as IPv6 support on
526: a range of platforms.</p>
1.148 asau 527: <div class="sect2">
1.82 rillig 528: <div class="titlepage"><div><div><h3 class="title">
529: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
530: <p>
531: pkgsrc provides the following key features:
532: </p>
1.148 asau 533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 534: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 535: and installation of binary packages. The source and latest
536: patches are retrieved from a master or mirror download site, checksum
537: verified, then built on your system. Support for binary-only
538: distributions is available for both native platforms and NetBSD
539: emulated platforms.</p></li>
1.128 wiz 540: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 541: including binaries, libraries, man pages and other
542: documentation.</p></li>
1.128 wiz 543: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 544: are handled automatically. The configuration files of various
545: packages are handled automatically during updates, so local changes
546: are preserved.</p></li>
1.128 wiz 547: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 548: consists of highly portable code. This allows the greatest speed of
1.132 spz 549: development when porting to a new platform. This portability also
1.82 rillig 550: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
551: platforms</em></span>.</p></li>
1.128 wiz 552: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 553: international encryption requirements and build-time options for a
554: large number of packages are all set in a simple, central
555: configuration file.</p></li>
1.128 wiz 556: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 557: freely available under a BSD license, so you may extend and adapt
558: pkgsrc to your needs. Support for local packages and patches is
559: available right out of the box, so you can configure it specifically
560: for your environment.</p></li>
561: </ul></div>
1.91 rillig 562: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 564: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 565: — That means, if a package contains bugs, it's better to find
1.91 rillig 566: them and to complain about them rather than to just install the package
567: and hope that it works. There are numerous checks in pkgsrc that try to
568: 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
569: of shell scripts), and post-installation checks (installed files,
570: references to shared libraries, script interpreters).</p></li>
1.128 wiz 571: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 572: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 573: pkgsrc has been ported to many operating systems. Care is taken that
574: packages behave the same on all platforms.</p></li>
575: </ul></div>
1.82 rillig 576: </div>
1.148 asau 577: <div class="sect2">
1.82 rillig 578: <div class="titlepage"><div><div><h3 class="title">
579: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
580: <p>pkgsrc consists of both a source distribution and a binary
581: distribution for these operating systems. After retrieving the required
582: source or binaries, you can be up and running with pkgsrc in just
583: minutes!</p>
1.75 rillig 584: <p>pkgsrc was derived from FreeBSD's ports system, and
585: initially developed for NetBSD only. Since then, pkgsrc has
586: grown a lot, and now supports the following platforms:</p>
1.82 rillig 587: <div class="table">
588: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 589: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 590: <colgroup>
591: <col>
592: <col>
593: </colgroup>
594: <thead><tr>
595: <th>Platform</th>
596: <th>Date Support Added</th>
597: </tr></thead>
598: <tbody>
599: <tr>
1.110 hubertf 600: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 601: <td align="center">Aug 1997</td>
602: </tr>
603: <tr>
1.110 hubertf 604: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 605: <td align="center">Mar 1999</td>
606: </tr>
607: <tr>
1.110 hubertf 608: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 609: <td align="center">Jun 1999</td>
610: </tr>
611: <tr>
612: <td>
1.110 hubertf 613: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
614: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 615: </td>
616: <td align="center">Oct 2001</td>
617: </tr>
618: <tr>
1.110 hubertf 619: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</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.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 624: <td align="center">Nov 2002</td>
625: </tr>
626: <tr>
1.110 hubertf 627: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 628: <td align="center">Dec 2002</td>
629: </tr>
630: <tr>
631: <td>BSD/OS</td>
632: <td align="center">Dec 2003</td>
633: </tr>
634: <tr>
1.110 hubertf 635: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 636: <td align="center">Dec 2003</td>
637: </tr>
638: <tr>
639: <td>
1.110 hubertf 640: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 641: (Microsoft Windows Services for Unix)
642: </td>
643: <td align="center">Mar 2004</td>
644: </tr>
645: <tr>
1.110 hubertf 646: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 647: <td align="center">Oct 2004</td>
648: </tr>
649: <tr>
1.110 hubertf 650: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 651: <td align="center">Nov 2004</td>
652: </tr>
1.98 wiz 653: <tr>
1.110 hubertf 654: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 655: <td align="center">Apr 2007</td>
656: </tr>
1.128 wiz 657: <tr>
658: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
659: <td align="center">Sep 2010</td>
660: </tr>
1.151 obache 661: <tr>
662: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 663: <td align="center">Jan 2011</td>
1.151 obache 664: </tr>
665: <tr>
666: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
667: <td align="center">Nov 2011</td>
668: </tr>
669: <tr>
670: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
671: <td align="center">Mar 2013</td>
672: </tr>
1.166 jnemeth 673: <tr>
674: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
675: <td align="center">Jul 2013</td>
676: </tr>
1.82 rillig 677: </tbody>
1.91 rillig 678: </table></div>
1.82 rillig 679: </div>
1.91 rillig 680: <br class="table-break">
1.82 rillig 681: </div>
1.75 rillig 682: </div>
1.148 asau 683: <div class="sect1">
1.75 rillig 684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
685: <a name="overview"></a>1.2. Overview</h2></div></div></div>
686: <p>This document is divided into three parts. The first,
1.110 hubertf 687: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 688: describes how one can use one of the packages in the Package
689: Collection, either by installing a precompiled binary package,
1.93 rillig 690: or by building one's own copy using the NetBSD package system.
1.110 hubertf 691: 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 692: package so it can be easily built by other NetBSD users without
693: knowing about the package's building details. The third part,
1.110 hubertf 694: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 695: is intended for those who want to understand how pkgsrc is
696: implemented.</p>
697: <p>This document is available in various formats:
1.110 hubertf 698: <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 699: </div>
1.148 asau 700: <div class="sect1">
1.75 rillig 701: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
702: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 703: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
704: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 705: terminology used within this document.</p>
1.148 asau 706: <div class="variablelist"><dl class="variablelist">
1.75 rillig 707: <dt><span class="term">Package</span></dt>
708: <dd><p>A set of files and building instructions
709: that describe what's necessary
710: to build a certain piece of software using
711: pkgsrc. Packages are traditionally stored under
1.76 rillig 712: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 713: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 714: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 715: is part of the NetBSD operating system and can be bootstrapped
716: to run on non-NetBSD operating systems as well. It handles
717: building (compiling), installing, and removing of
718: packages.</p></dd>
1.75 rillig 719: <dt><span class="term">Distfile</span></dt>
720: <dd><p>This term describes the file or files that are
721: provided by the author of the piece of software to
722: distribute his work. All the changes necessary to build on
723: NetBSD are reflected in the corresponding package. Usually
724: the distfile is in the form of a compressed tar-archive,
725: but other types are possible, too. Distfiles are usually
726: stored below
1.76 rillig 727: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 728: <dt><span class="term">Port</span></dt>
729: <dd><p>This is the term used by FreeBSD and OpenBSD people
730: for what we call a package.
1.128 wiz 731: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 732: architecture.</p></dd>
733: <dt><span class="term">Precompiled/binary package</span></dt>
734: <dd>
735: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 736: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 737: file so it can be installed on machines of the same
738: machine architecture without the need to
739: recompile. Packages are usually generated in
1.76 rillig 740: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 741: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 742: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 743: especially in the context of precompiled packages.</p>
744: </dd>
745: <dt><span class="term">Program</span></dt>
1.88 wiz 746: <dd><p>The piece of software to be installed which will be
747: constructed from all the files in the distfile by the
748: actions defined in the corresponding package.</p></dd>
1.75 rillig 749: </dl></div>
1.148 asau 750: <div class="sect2">
1.75 rillig 751: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 752: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 753: <div class="variablelist"><dl class="variablelist">
1.75 rillig 754: <dt><span class="term">pkgsrc users</span></dt>
755: <dd>
756: <p>The
757: pkgsrc users are people who use the packages provided by pkgsrc.
758: Typically they are system administrators. The people using the
1.128 wiz 759: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
760: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 761: <p>There are two kinds of pkgsrc users: Some only want to
762: install pre-built binary packages. Others build the pkgsrc
763: packages from source, either for installing them directly or for
1.110 hubertf 764: 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 765: documentation.</p>
766: </dd>
767: <dt><span class="term">package maintainers</span></dt>
768: <dd><p>A
1.110 hubertf 769: 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 770: <dt><span class="term">infrastructure developers</span></dt>
771: <dd><p>These people are involved in all those files
1.76 rillig 772: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 773: 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 774: too.</p></dd>
775: </dl></div>
776: </div>
777: </div>
1.148 asau 778: <div class="sect1">
1.75 rillig 779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
780: <a name="typography"></a>1.4. Typography</h2></div></div></div>
781: <p>When giving examples for commands, shell prompts are used to
782: show if the command should/can be issued as root, or if
1.128 wiz 783: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 784: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
785: shell prompt, assuming they use the C-shell or tcsh.</p>
786: </div>
787: </div>
1.148 asau 788: <div class="part">
1.75 rillig 789: <div class="titlepage"><div><div><h1 class="title">
790: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
791: <div class="toc">
792: <p><b>Table of Contents</b></p>
793: <dl>
794: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
795: <dd><dl>
796: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
797: <dd><dl>
1.157 asau 798: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 799: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 800: </dl></dd>
801: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
802: <dd><dl>
803: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
804: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
805: </dl></dd>
806: </dl></dd>
807: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
808: <dd><dl>
1.82 rillig 809: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
810: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
811: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
812: <dd><dl>
1.151 obache 813: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
814: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
815: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 816: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
817: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
818: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
819: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
820: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
821: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
822: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 823: </dl></dd>
824: </dl></dd>
825: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
826: <dd><dl>
827: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
828: <dd><dl>
829: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
830: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 831: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
832: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
833: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
834: <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>
835: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
836: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 837: </dl></dd>
838: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
839: <dd><dl>
840: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
841: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
842: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
843: </dl></dd>
844: </dl></dd>
845: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
846: <dd><dl>
847: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
848: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 849: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 850: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 851: <dd><dl>
1.103 wiz 852: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 853: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
854: <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 855: </dl></dd>
1.103 wiz 856: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
857: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 858: </dl></dd>
859: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
860: <dd><dl>
861: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
862: <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 863: </dl></dd>
864: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
865: builds)</a></span></dt>
1.75 rillig 866: <dd><dl>
1.106 rillig 867: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
868: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
1.174 asau 869: <dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
1.116 rillig 870: <dd><dl>
1.174 asau 871: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
872: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
1.116 rillig 873: </dl></dd>
1.174 asau 874: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
875: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 876: </dl></dd>
877: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
878: <dd><dl>
1.128 wiz 879: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
880: <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 881: </dl></dd>
882: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
883: <dd><dl>
884: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
885: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
886: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
887: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
888: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
889: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
890: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.173 wiz 891: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
892: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
893: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
894: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 895: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.173 wiz 896: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
897: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
898: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
899: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
900: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
901: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
902: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. 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 903: </dl></dd>
904: </dl>
905: </div>
1.148 asau 906: <div class="chapter">
1.75 rillig 907: <div class="titlepage"><div><div><h2 class="title">
908: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
909: <div class="toc">
910: <p><b>Table of Contents</b></p>
911: <dl>
912: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
913: <dd><dl>
1.157 asau 914: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 915: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 916: </dl></dd>
917: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
918: <dd><dl>
919: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
920: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
921: </dl></dd>
922: </dl>
923: </div>
1.91 rillig 924: <p>Before you download and extract the files, you need to decide
925: where you want to extract them. When using pkgsrc as root user, pkgsrc
926: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
927: free to install the sources and binary packages wherever you want in
928: your filesystem, provided that the pathname does not contain white-space
929: or other characters that are interpreted specially by the shell and some
930: other programs. A safe bet is to use only letters, digits, underscores
931: and dashes.</p>
1.148 asau 932: <div class="sect1">
1.75 rillig 933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
934: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
935: <p>Before you download any pkgsrc files, you should decide
936: whether you want the <span class="emphasis"><em>current</em></span> branch or the
937: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
938: quarterly basis from the current branch and only gets modified
939: for security updates. The names of the stable branches are built
940: from the year and the quarter, for example
1.124 snj 941: <code class="literal">2009Q1</code>.</p>
1.75 rillig 942: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 943: want to download pkgsrc. You can get it as a tar file or via CVS.
944: Both ways are described here.</p>
1.157 asau 945: <p>Note that tar archive contains CVS working copy.
946: Thus you can switch to using CVS at any later time.</p>
947: <p>Note also that quarterly branch is not frozen in stone.
948: It receives critical updates.</p>
1.148 asau 949: <div class="sect2">
1.75 rillig 950: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 951: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 952: <p>The primary download location for all pkgsrc files is
1.157 asau 953: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
954: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
955: (it points to the same location).
956: There are a number of subdirectories for different purposes,
957: 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>
958: <p>The tar archive for the current branch is in the directory
959: <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 960: It is autogenerated daily.</p>
1.157 asau 961: <p>To save download time we provide bzip2- and
962: xz-compressed archives which are published at
963: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
964: and
965: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
966: respectively.
967: </p>
968: <p>You can fetch the same files using FTP.</p>
1.166 jnemeth 969: <p>The tar file for the stable branch 2013Q1 is in the
970: directory <code class="filename">pkgsrc-2013Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2013Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112 weinem 971: <p>To download a pkgsrc stable tarball, run:</p>
972: <pre class="screen">
1.166 jnemeth 973: <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 974: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 975: stable branch to be downloaded, for example,
1.166 jnemeth 976: <span class="quote">“<span class="quote">pkgsrc-2013Q1</span>”</span>.</p>
1.157 asau 977: <p>You can use fetch it also using "wget", "curl",
978: or your web browser.</p>
1.112 weinem 979: <p>Then, extract it with:</p>
1.126 jakllsch 980: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.112 weinem 981: <p>This will create the directory <code class="filename">pkgsrc/</code>
982: in <code class="filename">/usr/</code> and all the package source will be
983: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
984: <p>To download pkgsrc-current, run:</p>
985: <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 986: </div>
1.148 asau 987: <div class="sect2">
1.75 rillig 988: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 989: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
990: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 991: <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 992: </pre>
993: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
994: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
995: <p>This will create the directory <code class="filename">pkgsrc/</code>
996: in your <code class="filename">/usr/</code> directory and all the package source
997: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
998: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 999: <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 1000: </pre>
1.136 dholland 1001: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 1002: <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 1003: <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 1004: </pre>
1005: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1006: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1007: or better globally in <code class="filename">/etc/profile</code>:</p>
1008: <pre class="programlisting">
1009: # set CVS remote shell command
1010: CVS_RSH=ssh
1011: export CVS_RSH
1012: </pre>
1013: <p>By default, CVS doesn't do things like most people would expect it to do.
1014: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1015: in your home directory and saving the following lines to it.
1016: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1017: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1018: <pre class="programlisting">
1019: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1020: cvs -q -z2
1.101 rillig 1021: checkout -P
1.103 wiz 1022: update -dP
1023: diff -upN
1.101 rillig 1024: rdiff -u
1.128 wiz 1025: release -d
1.101 rillig 1026: </pre>
1.75 rillig 1027: </div>
1028: </div>
1.148 asau 1029: <div class="sect1">
1.75 rillig 1030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1031: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1032: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1033: (which also works if you have first installed it via a tar
1034: file). It saves bandwidth and hard disk activity, compared to
1035: downloading the tar file again.</p>
1.148 asau 1036: <div class="sect2">
1.75 rillig 1037: <div class="titlepage"><div><div><h3 class="title">
1038: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1039: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1040: <h3 class="title">Warning</h3>
1.77 rillig 1041: <p>When updating from a tar file, you first need to
1042: completely remove the old pkgsrc directory. Otherwise those
1043: files that have been removed from pkgsrc in the mean time will
1044: not be removed on your local disk, resulting in inconsistencies.
1045: When removing the old files, any changes that you have done to
1046: the pkgsrc files will be lost after updating. Therefore updating
1047: via CVS is strongly recommended.</p>
1.75 rillig 1048: </div>
1.82 rillig 1049: <p>Note that by default the distfiles and the binary packages
1050: are saved in the pkgsrc tree, so don't forget to rescue them
1051: before updating. You can also configure pkgsrc to use other than
1052: the default directories by setting the
1053: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1054: 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 1055: <p>To update pkgsrc from a tar file, download the tar file as
1056: explained above. Then, make sure that you have not made any
1057: changes to the files in the pkgsrc directory. Remove the pkgsrc
1058: directory and extract the new tar file. Done.</p>
1059: </div>
1.148 asau 1060: <div class="sect2">
1.75 rillig 1061: <div class="titlepage"><div><div><h3 class="title">
1062: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1063: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1064: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1065: </pre>
1066: <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>
1067: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1068: </pre>
1.148 asau 1069: <div class="sect3">
1.75 rillig 1070: <div class="titlepage"><div><div><h4 class="title">
1071: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1072: <p>When updating pkgsrc, the CVS program keeps track of the
1073: branch you selected. But if you, for whatever reason, want to
1074: switch from the stable branch to the current one, you can do it
1.128 wiz 1075: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1076: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1077: back to the stable branch, add the
1.128 wiz 1078: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.75 rillig 1079: </div>
1.148 asau 1080: <div class="sect3">
1.75 rillig 1081: <div class="titlepage"><div><div><h4 class="title">
1082: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1083: <p>When you update pkgsrc, the CVS program will only touch
1084: those files that are registered in the CVS repository. That
1085: means that any packages that you created on your own will stay
1086: unmodified. If you change files that are managed by CVS, later
1087: updates will try to merge your changes with those that have been
1088: done by others. See the CVS manual, chapter
1.128 wiz 1089: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1090: </div>
1091: </div>
1092: </div>
1093: </div>
1.148 asau 1094: <div class="chapter">
1.75 rillig 1095: <div class="titlepage"><div><div><h2 class="title">
1096: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1097: <div class="toc">
1098: <p><b>Table of Contents</b></p>
1099: <dl>
1.82 rillig 1100: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1101: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1102: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1103: <dd><dl>
1.151 obache 1104: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1105: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1106: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 1107: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1108: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1109: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1110: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1111: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1112: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1113: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 1114: </dl></dd>
1115: </dl>
1116: </div>
1.148 asau 1117: <div class="sect1">
1.75 rillig 1118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1119: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1120: <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 1121: </div>
1.148 asau 1122: <div class="sect1">
1.82 rillig 1123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1124: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1125: <p>pkgsrc can be bootstrapped for use in two different modes:
1126: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1127: to privileged one all programs are installed under one particular user
1.149 asau 1128: and cannot utilise privileged operations (packages don't create
1129: special users and all special file permissions like setuid are ignored).
1130: </p>
1.82 rillig 1131: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1132: <pre class="screen">
1.167 asau 1133: <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 1134: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1135: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1136: </pre>
1.149 asau 1137: <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>
1138: <p>By default, in privileged mode pkgsrc uses
1139: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1140: where programs will be installed in,
1.87 wiz 1141: and <code class="filename">/var/db/pkg</code> for the package database
1.149 asau 1142: directory where pkgsrc will do its internal bookkeeping,
1143: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1144: where packages install their persistent data.
1145: In unprivileged mode pkgsrc uses
1146: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1147: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1148: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1149: </p>
1150: <p>You can change default layout using command-line arguments.
1151: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1152: </p>
1.148 asau 1153: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1154: <h3 class="title">Note</h3>
1.110 hubertf 1155: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1156: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1157: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1158: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1159: </div>
1.149 asau 1160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1161: <h3 class="title">Note</h3>
1162: <p>It is possible to bootstrap multiple instances of pkgsrc
1163: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1164: corresponding to the installation you're working with to build
1165: and install packages.
1166: </p>
1167: </div>
1.75 rillig 1168: </div>
1.148 asau 1169: <div class="sect1">
1.75 rillig 1170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1171: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1172: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 asau 1173: <div class="sect2">
1.75 rillig 1174: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1175: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1176: <p>Cygwin 1.7.x and later are supported.</p>
1177: <p>You need to install minimal base packages in `Base' category
1178: plus any of compiler, gcc, gcc4, and/or clang.
1179: For gcc and gcc4, C and C++ compiler will be installed by default,
1180: but you can install Fortran compiler additionally
1181: because it will be required to use libtool.
1182: If it is not installed (or too old), Fortran compiler will be
1183: installed with pkgsrc automatically.</p>
1184: <p>As noted in
1185: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1186: su(1) command has been in Cygwin distribution, but it has never worked.
1187: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1188: </p>
1189: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1190: then pick "Run as administrator".</p></li></ul></div>
1191: </div>
1192: <div class="sect2">
1193: <div class="titlepage"><div><div><h3 class="title">
1194: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.148 asau 1195: <p>Darwin 5.x and up are supported.</p>
1196: <p>Before you start, you need to download and install
1197: the Mac OS X Developer Tools from Apple's Developer Connection.
1198: This requires (free) membership. See
1.126 jakllsch 1199: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 asau 1200: for details. Also, make sure you install X11 (an optional
1201: package included with the Developer Tools) if you intend
1202: to build packages that use the X11 Window System.
1203: (If you don't want or need the full Xcode GUI,
1204: download and install Command Line Tools for Xcode.)</p>
1.75 rillig 1205: </div>
1.148 asau 1206: <div class="sect2">
1.75 rillig 1207: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1208: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136 dholland 1209: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1210: other versions may work.</p>
1.75 rillig 1211: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1212: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1213: <div class="orderedlist"><ol class="orderedlist" type="1">
1214: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1215: <code class="filename">/var/db/pkg</code>. It is therefore
1216: recommended that you choose a different location (e.g.
1217: <code class="filename">/usr/pkgdb</code>) by
1218: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1219: <li class="listitem">
1.75 rillig 1220: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1221: good idea to move them out of the way to avoid confusion, e.g.</p>
1222: <pre class="screen">
1223: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1224: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1225: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1226: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1227: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1228: </pre>
1.75 rillig 1229: </li>
1.128 wiz 1230: <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 1231: <code class="filename">/etc/mk.conf.example</code> file
1232: when you use the bootstrap script.</p></li>
1.75 rillig 1233: </ol></div>
1234: </div>
1.148 asau 1235: <div class="sect2">
1.75 rillig 1236: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1237: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1238: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1239: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1240: <p> You should install ncurses (libncurses and libncurses-dev)
1241: packages.</p>
1242: </div>
1243: <div class="sect2">
1244: <div class="titlepage"><div><div><h3 class="title">
1245: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75 rillig 1246: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1247: providing a Unix-like environment with a tighter kernel integration than
1248: available with Cygwin. It is part of the Windows Services for Unix
1249: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1250: (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 1251: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1252: are not officially supported. (The main difference in 3.0/3.1 is lack
1253: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 wiz 1254: <p>Services for Unix Applications (aka SUA) is an integrated
1255: component of Windows Server 2003 R2 (5.2), Windows Vista and
1256: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1257: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1258: 6.1 (64bit) subsystems have been tested. Other versions may
1259: work as well. The Interix 5.x subsystem has not yet been tested
1260: with pkgsrc.</p>
1.148 asau 1261: <div class="sect3">
1.75 rillig 1262: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1263: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1264: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1265: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 asau 1266: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1267: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1268: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1269: <li class="listitem"><p>Remote Connectivity</p></li>
1270: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1271: </ul></div>
1272: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1273: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1274: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1275: pkgsrc (or from a binary package).</p>
1.75 rillig 1276: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1277: not need to be installed, but Remote Connectivity itself should be
1278: installed in order to have a working inetd.</p>
1.75 rillig 1279: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1280: behavior for Interix programs, and whether to make pathnames default to
1281: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1282: enabled. (Without case-sensitivity, a large number of packages including
1283: perl will not build.)</p>
1.75 rillig 1284: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1285: works (via the Data Execution Prevention feature). In order to use
1286: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1287: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1288: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1289: support contract; however, Debian Interix Port has made most Interix
1290: 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 1291: <p>In addition to the hotfix noted above, it may be necessary to
1292: disable Data Execution Prevention entirely to make Interix functional.
1293: This may happen only with certain types of CPUs; the cause is not fully
1294: understood at this time. If gcc or other applications still segfault
1295: repeatedly after installing one of the hotfixes note above, the
1296: following option can be added to the appropriate "boot.ini" line on the
1297: Windows boot drive: /NoExecute=AlwaysOff
1298: (WARNING, this will disable DEP completely, which may be a security
1299: risk if applications are often run as a user in the Administrators
1300: group!)</p>
1.75 rillig 1301: </div>
1.148 asau 1302: <div class="sect3">
1.75 rillig 1303: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1304: <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 1305: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1306: with pkgsrc, note the following things.</p>
1.148 asau 1307: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1308: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1309: Windows Services for UNIX, then click Change. In the installer, choose
1310: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1311: <li class="listitem">
1.75 rillig 1312: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1313: change the following registry key:</p>
1.75 rillig 1314: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1315: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1316: </li>
1.128 wiz 1317: <li class="listitem">
1.75 rillig 1318: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1319: following registry key:</p>
1.75 rillig 1320: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1321: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1322: </li>
1323: </ul></div>
1324: </div>
1.148 asau 1325: <div class="sect3">
1.75 rillig 1326: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1327: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1328: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1329: running "pkg_add") must be a member of the local Administrators
1330: group. Such a user must also be used to run the bootstrap. This is
1331: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1332: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1333: automatically complain if this is not the case. This ensures that
1334: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1335: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1336: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1337: NOT be used in conjunction with pkgsrc. If you choose to use them at
1338: the same time as the pkgsrc packages, ensure that you use the proper
1339: pkg_* tools for each type of binary package.</p>
1.75 rillig 1340: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1341: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1342: don't have a termcap/terminfo entry for it, but the following .termcap
1343: entry provides adequate emulation in most cases:</p>
1.75 rillig 1344: <pre class="programlisting">
1.100 rillig 1345: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1346: </pre>
1.75 rillig 1347: </div>
1.148 asau 1348: <div class="sect3">
1.75 rillig 1349: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1350: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1351: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1352: for a full Unix-like platform, it has some drawbacks that should
1353: be noted for those desiring to make the most of Interix.</p>
1.148 asau 1354: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1355: <li class="listitem">
1.75 rillig 1356: <p><span class="strong"><strong>X11:</strong></span></p>
1357: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1358: and can run X11 based applications, but it does
1359: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1360: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1361: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1362: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1363: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1364: and the free X11 server included with
1.110 hubertf 1365: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1366: </li>
1.128 wiz 1367: <li class="listitem">
1.75 rillig 1368: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1369: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1370: Win32 applications, it does not currently support various X11
1371: protocol extensions for acceleration (such as MIT-SHM or DGA).
1372: Most interactive applications to a local X server will run
1373: reasonably fast, but full motion video and other graphics
1374: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1375: </li>
1.128 wiz 1376: <li class="listitem">
1.75 rillig 1377: <p><span class="strong"><strong>Audio:</strong></span></p>
1378: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1379: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1380: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1381: <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 1382: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1383: server component. To output audio via an Interix host, the
1.91 rillig 1384: <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 1385: must also be installed.</p>
1.75 rillig 1386: </li>
1.128 wiz 1387: <li class="listitem">
1.75 rillig 1388: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1389: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1390: is not currently possible to access CD/DVD drives, USB devices,
1391: or SCSI devices through non-filesystem means. Among other things,
1392: this makes it impossible to use Interix directly for CD/DVD
1393: burning.</p>
1.75 rillig 1394: </li>
1.128 wiz 1395: <li class="listitem">
1.75 rillig 1396: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1397: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1398: drives are also not directly accessible in Interix. However,
1399: support is in work to make tape drive access possible by using
1400: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1401: esound server).</p>
1.75 rillig 1402: </li>
1403: </ul></div>
1404: </div>
1.148 asau 1405: <div class="sect3">
1.75 rillig 1406: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1407: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1408: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1409: Windows system; any member of the local Administrators group will
1410: suffice. However, some packages currently assume that the user
1411: named "root" is the privileged user. To accommodate these, you
1412: may create such a user; make sure it is in the local group
1413: Administrators (or your language equivalent).</p>
1.110 hubertf 1414: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1415: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1416: time being, install packages as the local Administrator (or
1417: your language equivalent), or run the following command after
1418: installing a package to work around the issue:</p>
1.75 rillig 1419: <pre class="screen">
1.87 wiz 1420: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1421: </pre>
1.75 rillig 1422: </div>
1423: </div>
1.148 asau 1424: <div class="sect2">
1.75 rillig 1425: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1426: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75 rillig 1427: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1428: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1429: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1430: 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 1431: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.136 dholland 1432: 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 1433: etc.</p>
1.86 schwarz 1434: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1435: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1436: you start out using "abi=n32", that's what all your packages will be built
1437: with.</p>
1438: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1439: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1440: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1441: try to link n32 object files with lib64 or vice versa. Check your
1442: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1443: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1444: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1445: as it appears that IRIX linker occasionally runs into issues when trying to
1446: link over a network-mounted file system.</p>
1.75 rillig 1447: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1448: as imake(1), but you may want to set some options depending on your local
1449: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1450: course, your compiler's man pages for details.</p>
1.75 rillig 1451: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1452:
1.87 wiz 1453: </p>
1.75 rillig 1454: <pre class="programlisting">
1.100 rillig 1455: PKGSRC_COMPILER= mipspro
1.87 wiz 1456: </pre>
1.75 rillig 1457: <p>
1.1 grant 1458:
1.110 hubertf 1459: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1460: are using gcc and may end up passing invalid flags to the compiler. Note that
1461: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1462: default.</p>
1.75 rillig 1463: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1464: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1465: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1466: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1467: '--preserve-path' flag.</p>
1.75 rillig 1468: </div>
1.148 asau 1469: <div class="sect2">
1.75 rillig 1470: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1471: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87 wiz 1472: <p>Some versions of Linux (for example Debian GNU/Linux) need
1473: either libtermcap or libcurses (libncurses). Installing the
1474: distributions libncurses-dev package (or equivalent) should fix
1475: the problem.</p>
1476: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1477: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1478: i386 have been tested.</p>
1.75 rillig 1479: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1480: directory:</p>
1.75 rillig 1481: <pre class="programlisting">
1.138 wiz 1482: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1483: </pre>
1.148 asau 1484: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1485: <h3 class="title">Note</h3>
1.138 wiz 1486: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1487: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1488: <p>For icc 10.1 neither of these appears to be necessary.</p>
1489: </div>
1490: <p>Use a value for ICCBASE that corresponds to the directory
1491: where icc is installed. After bootstrapping, set
1492: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137 wiz 1493: <pre class="programlisting">
1.138 wiz 1494: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1495: </pre>
1.138 wiz 1496: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1497: <code class="filename">/opt/intel_cc_80</code>. This is the default
1498: install directory for icc 8.0. If you are using a more recent
1499: version, be sure to set the correct path explicitly.
1500: </p>
1.75 rillig 1501: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1502: provided by icc, so binaries can be run on other systems which do not
1503: have the shared libraries installed.</p>
1504: <p>Libtool, however, extracts a list of libraries from the
1.136 dholland 1505: <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 1506: records it, throwing away the -Bstatic and -Bdynamic options
1507: interspersed between the libraries. This means that
1508: libtool-linked C++ shared libraries will have a runtime
1509: dependency on the icc libraries until this is fixed in
1510: libtool.</p>
1.75 rillig 1511: </div>
1.148 asau 1512: <div class="sect2">
1.75 rillig 1513: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1514: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163 bsiegert 1515: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1516: Older versions might also work. Releases before #10 are not
1517: supported.</p>
1518: <p>The package tools of the (older) native ports tree,
1519: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1520: have the same names as the ones used by pkgsrc. Care should be taken
1521: that the right tools are used. When installing packages from source,
1522: use the <code class="filename">bmake</code> command for pkgsrc and
1523: <code class="filename">mmake</code> for MirPorts.</p>
1524: <p>pkgsrc and MirPorts use the same location for the package
1525: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1526: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1527: tree is self-contained. This is also the default setting used in the
1528: binary package builds.</p>
1529: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1530: server. The bootstrap kit there already contains the
1531: <span class="command"><strong>pkgin</strong></span> package manager. See the
1532: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1533: page for more details.</p>
1534: </div>
1535: <div class="sect2">
1536: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1537: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136 dholland 1538: <p>OpenBSD 5.1 has been tested and supported,
1539: other versions may work.</p>
1.75 rillig 1540: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1541: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1542: <div class="orderedlist"><ol class="orderedlist" type="1">
1543: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1544: <code class="filename">/var/db/pkg</code>. It is therefore
1545: recommended that you choose a different location (e.g.
1546: <code class="filename">/usr/pkgdb</code>) by
1547: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1548: <li class="listitem">
1.75 rillig 1549: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1550: good idea to move them out of the way to avoid confusion, e.g.</p>
1551: <pre class="screen">
1552: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1553: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1554: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1555: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1556: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1557: </pre>
1.75 rillig 1558: </li>
1.128 wiz 1559: <li class="listitem">
1.110 hubertf 1560: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1561: <code class="filename">/etc/mk.conf.example</code> file
1562: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1563: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1564: as well. You can work around this by enclosing all the pkgsrc-specific parts
1565: of the file with:</p>
1566: <pre class="programlisting">
1.100 rillig 1567: .ifdef BSD_PKG_MK
1568: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1569: .else
1570: # OpenBSD stuff
1571: .endif
1.87 wiz 1572: </pre>
1.75 rillig 1573: </li>
1574: </ol></div>
1575: </div>
1.148 asau 1576: <div class="sect2">
1.75 rillig 1577: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1578: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142 wiz 1579: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1580: You will need a working C compiler. Both gcc 4.5.3 and
1.87 wiz 1581: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1582: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1583: process and to build packages.</p>
1.148 asau 1584: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1585: <li class="listitem"><p>SUNWsprot</p></li>
1586: <li class="listitem"><p>SUNWarc</p></li>
1587: <li class="listitem"><p>SUNWbtool</p></li>
1588: <li class="listitem"><p>SUNWtoo</p></li>
1589: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1590: </ul></div>
1.78 rillig 1591: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1592: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1593: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1594: your $prefix are in your <code class="varname">PATH</code>. This includes
1595: <code class="filename">/usr/ccs/{bin,lib}</code>
1596: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148 asau 1597: <div class="sect3">
1.75 rillig 1598: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1599: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1600: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1601: for building all packages.</p>
1.75 rillig 1602: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1603: then either build gcc from
1.142 wiz 1604: <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 1605: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1606: <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 1607: </div>
1.148 asau 1608: <div class="sect3">
1.75 rillig 1609: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1610: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1611: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1612: 5.0)</p>
1.148 asau 1613: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1614: <li class="listitem"><p>SPROcc
1.87 wiz 1615: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1616: <li class="listitem"><p>SPROcpl
1.87 wiz 1617: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1618: <li class="listitem"><p>SPROild
1.87 wiz 1619: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1620: <li class="listitem"><p>SPROlang
1.87 wiz 1621: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1622: </ul></div>
1.96 rillig 1623: <p>You should set the following variables in your
1.110 hubertf 1624: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1625: <pre class="programlisting">
1.100 rillig 1626: CC= cc
1627: CXX= CC
1628: CPP= cc -E
1629: CXXCPP= CC -E
1.96 rillig 1630: </pre>
1.148 asau 1631: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1632: <h3 class="title">Note</h3>
1633: <p>The <code class="varname">CPP</code> setting might break some
1634: packages that use the C preprocessor for processing things other
1635: than C source code.</p>
1636: </div>
1.75 rillig 1637: </div>
1.148 asau 1638: <div class="sect3">
1.75 rillig 1639: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1640: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1641: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1642: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1643: <pre class="programlisting">
1.100 rillig 1644: PKGSRC_COMPILER= sunpro
1645: ABI= 64
1.96 rillig 1646: </pre>
1.148 asau 1647: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1648: <h3 class="title">Note</h3>
1649: <p>This setting has been tested for the SPARC
1650: architecture. Intel and AMD machines need some more
1651: work.</p>
1652: </div>
1.75 rillig 1653: </div>
1.148 asau 1654: <div class="sect3">
1.75 rillig 1655: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1656: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110 hubertf 1657: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1658: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1659: The workaround is to use another shell for the configure
1.91 rillig 1660: 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 1661: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1662: <pre class="programlisting">
1.100 rillig 1663: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1664: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1665: </pre>
1.91 rillig 1666: <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 1667: </div>
1668: </div>
1669: </div>
1670: </div>
1.148 asau 1671: <div class="chapter">
1.75 rillig 1672: <div class="titlepage"><div><div><h2 class="title">
1673: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1674: <div class="toc">
1675: <p><b>Table of Contents</b></p>
1676: <dl>
1677: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1678: <dd><dl>
1679: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1680: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1681: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1682: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1683: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1684: <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>
1685: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1686: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1687: </dl></dd>
1688: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1689: <dd><dl>
1690: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1691: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1692: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1693: </dl></dd>
1694: </dl>
1695: </div>
1696: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1697: is to only install the package tools and to use binary packages
1.128 wiz 1698: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1699: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1700: of pkgsrc, too. Then you are able to build your own packages,
1701: and you can still use binary packages from someone else.</p>
1.148 asau 1702: <div class="sect1">
1.75 rillig 1703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1704: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1705: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1706: server and its mirrors, there are collections of binary packages,
1707: ready to be installed. These binary packages have been built using the
1708: default settings for the directories, that is:</p>
1.148 asau 1709: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1710: <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>
1711: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1712: <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 1713: </ul></div>
1714: <p>If you cannot use these directories for whatever reasons (maybe
1715: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1716: 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 1717: <div class="sect2">
1.75 rillig 1718: <div class="titlepage"><div><div><h3 class="title">
1719: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1720: <p>To install binary packages, you first need to know from where
1721: to get them. The first place where you should look is on the main
1.110 hubertf 1722: 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 1723: <p>This directory contains binary packages for multiple
1724: platforms. First, select your operating system. (Ignore the
1725: directories with version numbers attached to it, they just exist for
1726: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1727: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1728: <p>In this directory, you often find a file called
1729: <code class="filename">bootstrap.tar.gz</code> which contains the package
1730: management tools. If the file is missing, it is likely that your
1731: operating system already provides those tools. Download the file and
1732: extract it in the <code class="filename">/</code> directory. It will create
1733: the directories <code class="filename">/usr/pkg</code> (containing the tools
1734: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1735: (the database of installed packages).</p>
1.75 rillig 1736: </div>
1.148 asau 1737: <div class="sect2">
1.75 rillig 1738: <div class="titlepage"><div><div><h3 class="title">
1739: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1740: <p>In the directory from the last section, there is a
1741: subdirectory called <code class="filename">All</code>, which contains all the
1742: binary packages that are available for the platform, excluding those
1743: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1744: medium you are using).</p>
1.109 rillig 1745: <p>To install packages directly from an FTP or HTTP server, run
1746: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1747: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1748: <pre class="screen">
1749: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1750: <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>
1751: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1752: </pre>
1753: <p>Instead of URLs, you can also use local paths, for example if
1754: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1755: repository. If you want to install packages from multiple sources,
1756: you can separate them by a semicolon in
1757: <code class="varname">PKG_PATH</code>.</p>
1758: <p>After these preparations, installing a package is very
1759: easy:</p>
1760: <pre class="screen">
1761: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1762: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1763: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1764: </pre>
1.75 rillig 1765: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1766: package in question will be installed, too, assuming they are
1767: present where you install from.</p>
1.128 wiz 1768: <p>Adding packages might install vulnerable packages.
1769: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1770: regularly, especially after installing new packages, and verify
1771: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1772: <p>After you've installed packages, be sure to have
1.88 wiz 1773: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1774: <code class="varname">PATH</code> so you can actually start the just
1775: installed program.</p>
1.75 rillig 1776: </div>
1.148 asau 1777: <div class="sect2">
1.75 rillig 1778: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1779: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1780: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1781: installed from source code or from a binary package. The
1.110 hubertf 1782: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1783: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1784: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1785: name can be given with or without version number. Wildcards can
1786: also be used to deinstall a set of packages, for example
1787: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1788: so that the shell does not expand them before
1789: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1790: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1791: removes all the packages that require the package in question
1792: and then removes the package itself. For example:
1.82 rillig 1793:
1.88 wiz 1794: </p>
1.82 rillig 1795: <pre class="screen">
1.88 wiz 1796: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1797: </pre>
1.82 rillig 1798: <p>
1799:
1.88 wiz 1800: will remove jpeg and all the packages that used it; this allows
1801: upgrading the jpeg package.</p>
1.82 rillig 1802: </div>
1.148 asau 1803: <div class="sect2">
1.82 rillig 1804: <div class="titlepage"><div><div><h3 class="title">
1805: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1806: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1807: installed packages or binary package files.</p>
1.82 rillig 1808: </div>
1.148 asau 1809: <div class="sect2">
1.82 rillig 1810: <div class="titlepage"><div><div><h3 class="title">
1811: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1812: <p>
1.88 wiz 1813: The NetBSD Security-Officer and Packages Groups maintain a list of
1814: known security vulnerabilities to packages which are (or have been)
1815: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1816: 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 1817: </p>
1.82 rillig 1818: <p>
1.125 wiz 1819: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1820: this list can be downloaded
1821: automatically, and a security audit of all packages installed on a system
1822: can take place.
1823: </p>
1.82 rillig 1824: <p>
1.125 wiz 1825: There are two components to auditing. The first
1826: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1827: is for downloading
1.88 wiz 1828: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1829: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1830: installed packages are vulnerable. If a package is vulnerable, you
1831: will see output similar to the following:
1832: </p>
1.82 rillig 1833: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1834: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1835: <p>
1.125 wiz 1836: You may wish to have the
1.110 hubertf 1837: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1838: file downloaded daily so that
1839: it remains current. This may be done by adding an appropriate entry
1.136 dholland 1840: 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 1841: </p>
1842: <pre class="screen">
1843: # download vulnerabilities file
1844: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1845: </pre>
1846: <p>
1847: will update the vulnerability list every day at 3AM. You may wish to do
1848: this more often than once a day.
1849:
1850: In addition, you may wish to run the package audit from the daily
1851: security script. This may be accomplished by adding the following
1852: line to <code class="filename">/etc/security.local</code>:
1853: </p>
1854: <pre class="screen">
1855: /usr/sbin/pkg_admin audit
1856: </pre>
1857: <p>
1.88 wiz 1858: </p>
1.82 rillig 1859: </div>
1.148 asau 1860: <div class="sect2">
1.82 rillig 1861: <div class="titlepage"><div><div><h3 class="title">
1862: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1863: <p>
1.112 weinem 1864: 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 1865: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1866: argument to check if your packages are up-to-date, e.g.
1867: </p>
1868: <pre class="screen">
1869: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1870: ...
1.88 wiz 1871: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1872: </pre>
1.110 hubertf 1873: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1874: package on your system and rebuild any dependencies.
1875: </p>
1.82 rillig 1876: </div>
1.148 asau 1877: <div class="sect2">
1.82 rillig 1878: <div class="titlepage"><div><div><h3 class="title">
1879: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1880: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1881: administrative functions on the package system.</p>
1.82 rillig 1882: </div>
1.148 asau 1883: <div class="sect2">
1.82 rillig 1884: <div class="titlepage"><div><div><h3 class="title">
1885: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1886: <p>Please pay very careful attention to the warnings
1.136 dholland 1887: 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 1888: inherent dangers of installing binary packages which you did
1889: not create yourself, and the security holes that can be
1890: introduced onto your system by indiscriminate adding of such
1891: files.</p>
1.75 rillig 1892: <p>The same warning of course applies to every package you
1.88 wiz 1893: install from source when you haven't completely read and
1894: understood the source code of the package, the compiler that
1895: is used to build the package and all the other tools that are
1896: involved.</p>
1.75 rillig 1897: </div>
1898: </div>
1.148 asau 1899: <div class="sect1">
1.75 rillig 1900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1901: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1902: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1903: directory now contains a set of packages, organized into
1904: categories. You can browse the online index of packages, or run
1.110 hubertf 1905: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1906: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1907: 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 1908: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1909: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1910: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1911: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1912: different <code class="varname">LOCALBASE</code> definitions on the same
1913: system (inside a chroot is an exception). </p>
1914: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1915: 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 1916: instructions how to create your own packages.</p>
1.148 asau 1917: <div class="sect2">
1.75 rillig 1918: <div class="titlepage"><div><div><h3 class="title">
1919: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1920: <p>To build packages from source, you need a working C
1.88 wiz 1921: compiler. On NetBSD, you need to install the
1.128 wiz 1922: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1923: sets. If you want to build X11-related packages, the
1.128 wiz 1924: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1925: sets are required, too.</p>
1.75 rillig 1926: </div>
1.148 asau 1927: <div class="sect2">
1.75 rillig 1928: <div class="titlepage"><div><div><h3 class="title">
1929: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1930: <p>The first step for building a package is downloading the
1.88 wiz 1931: distfiles (i.e. the unmodified source). If they have not yet been
1932: downloaded, pkgsrc will fetch them automatically.</p>
1933: <p>If you have all files that you need in the
1934: <code class="filename">distfiles</code> directory,
1935: you don't need to connect. If the distfiles are on CD-ROM, you can
1936: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1937: </p>
1.82 rillig 1938: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1939: <p>
1.110 hubertf 1940: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1941: <p>By default a list of distribution sites will be randomly
1942: intermixed to prevent huge load on servers which holding popular
1943: packages (for example, SourceForge.net mirrors). Thus, every
1944: time when you need to fetch yet another distfile all the mirrors
1945: will be tried in new (random) order. You can turn this feature
1946: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1947: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1948: <p>You can overwrite some of the major distribution sites to
1949: fit to sites that are close to your own. By setting one or two
1950: variables you can modify the order in which the master sites are
1951: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1952: delimited list of domain suffixes.
1953: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1954: contains a whitespace delimited list of regular expressions. It
1955: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1956: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1957: some examples. This may save some of your bandwidth and
1958: time.</p>
1.75 rillig 1959: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1960: if you want to keep the settings, by editing the
1.110 hubertf 1961: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1962: and adding the definitions there.</p>
1.82 rillig 1963: <p>
1.88 wiz 1964: If a package depends on many other packages (such as
1.93 rillig 1965: <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 1966: alternate between periods of
1967: downloading source, and compiling. To ensure you have all the source
1968: downloaded initially you can run the command:
1969: </p>
1.82 rillig 1970: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1971: <p>
1.88 wiz 1972: which will output and run a set of shell commands to fetch the
1973: necessary files into the <code class="filename">distfiles</code> directory. You can
1974: also choose to download the files manually.
1975: </p>
1.75 rillig 1976: </div>
1.148 asau 1977: <div class="sect2">
1.75 rillig 1978: <div class="titlepage"><div><div><h3 class="title">
1979: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1980: <p>
1.88 wiz 1981: Once the software has downloaded, any patches will be applied, then it
1982: will be compiled for you. This may take some time depending on your
1983: computer, and how many other packages the software depends on and their
1984: compile time.
1985: </p>
1.148 asau 1986: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1987: <h3 class="title">Note</h3>
1988: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1989: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1990: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1991: </div>
1.87 wiz 1992: <p>For example, type</p>
1.88 wiz 1993: <pre class="screen">
1994: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1995: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1996: </pre>
1.75 rillig 1997: <p>at the shell prompt to build the various components of the
1.88 wiz 1998: package.</p>
1.82 rillig 1999: <p>The next stage is to actually install the newly compiled
1.88 wiz 2000: program onto your system. Do this by entering:
1.82 rillig 2001:
1.88 wiz 2002: </p>
1.82 rillig 2003: <pre class="screen">
1.88 wiz 2004: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2005: </pre>
1.82 rillig 2006: <p>
2007:
1.88 wiz 2008: while you are still in the directory for whatever package you
2009: are installing.</p>
1.82 rillig 2010: <p>Installing the package on your system may require you to
1.88 wiz 2011: be root. However, pkgsrc has a
2012: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2013: to only become root for the actual installation step.</p>
1.82 rillig 2014: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2015: You can now enter:
1.82 rillig 2016:
1.88 wiz 2017: </p>
1.82 rillig 2018: <pre class="screen">
1.88 wiz 2019: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2020: </pre>
1.82 rillig 2021: <p>
2022:
1.88 wiz 2023: to remove the compiled files in the work directory, as you shouldn't need
2024: them any more. If other packages were also added to your system
2025: (dependencies) to allow your program to compile, you can tidy these up
2026: also with the command:</p>
1.82 rillig 2027: <pre class="screen">
1.88 wiz 2028: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2029: </pre>
1.75 rillig 2030: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2031: 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 2032: <p>The program is installed under the default root of the
2033: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2034: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2035: variable in your environment, and it will use that value as the
2036: root of your packages tree. So, to use
2037: <code class="filename">/usr/local</code>, set
2038: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2039: Please note that you should use a directory which is dedicated to
2040: packages and not shared with other programs (i.e., do not try and
2041: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2042: to add any of your own files or directories (such as
2043: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2044: <code class="filename">pkgsrc/</code>) below the
2045: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2046: conflicts between programs and other files installed by the
2047: package system and whatever else may have been installed
2048: there.</p>
1.110 hubertf 2049: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2050: alter some configuration options at build time. Have a look at
2051: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2052: of what will be set there by default. Environment variables such
2053: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2054: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2055: set them each time you want to use pkgsrc.</p>
1.128 wiz 2056: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2057: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 2058: or being installed. This may be for debugging purposes, or out of
2059: simple curiosity. A number of utility values have been added to
2060: help with this.</p>
1.128 wiz 2061: <div class="orderedlist"><ol class="orderedlist" type="1">
2062: <li class="listitem">
1.136 dholland 2063: <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 2064: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2065: information will be displayed. For example,</p>
1.75 rillig 2066: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2067: <p>will show all the commands that are invoked, up to and
1.128 wiz 2068: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 2069: </li>
1.128 wiz 2070: <li class="listitem">
1.136 dholland 2071: <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 2072: definition, then the <code class="varname">VARNAME</code> definition
2073: should be used, in conjunction with the show-var
1.136 dholland 2074: 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 2075: variable <code class="varname">LOCALBASE</code>:</p>
2076: <pre class="screen">
2077: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2078: /usr/pkg
2079: <code class="prompt">%</code>
1.88 wiz 2080: </pre>
1.75 rillig 2081: </li>
2082: </ol></div>
2083: <p>If you want to install a binary package that you've either
1.88 wiz 2084: created yourself (see next section), that you put into
2085: pkgsrc/packages manually or that is located on a remote FTP
2086: server, you can use the "bin-install" target. This target will
1.136 dholland 2087: 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 2088: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2089: sites searched is kept in the variable
2090: <code class="varname">BINPKG_SITES</code>, which defaults to
1.136 dholland 2091: 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 2092: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2093: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2094: details.</p>
2095: <p>A final word of warning: If you set up a system that has a
2096: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2097: set that before any packages are installed, as you cannot use
2098: several directories for the same purpose. Doing so will result in
2099: pkgsrc not being able to properly detect your installed packages,
2100: and fail miserably. Note also that precompiled binary packages are
2101: usually built with the default <code class="varname">LOCALBASE</code> of
2102: <code class="filename">/usr/pkg</code>, and that you should
2103: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2104: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2105: </div>
2106: </div>
2107: </div>
1.148 asau 2108: <div class="chapter">
1.75 rillig 2109: <div class="titlepage"><div><div><h2 class="title">
2110: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2111: <div class="toc">
2112: <p><b>Table of Contents</b></p>
2113: <dl>
2114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2118: <dd><dl>
1.103 wiz 2119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2121: <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 2122: </dl></dd>
1.103 wiz 2123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2125: </dl>
2126: </div>
1.104 rillig 2127: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2128: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2129: that file depends on the installation. On NetBSD, when you use
1.136 dholland 2130: <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 2131: <code class="filename">/etc/</code>. In all other cases the default location is
2132: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2133: bootstrap program to install the binary packages.</p>
2134: <p>During the bootstrap, an example configuration file is created. To
2135: use that, you have to create the directory
2136: <code class="filename">${PREFIX}/etc</code> and copy the example file
2137: there.</p>
2138: <p>The format of the configuration file is that of the usual
2139: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2140: is done by setting variables in this file. Note that you can define all
2141: kinds of variables, and no special error checking (for example for
2142: spelling mistakes) takes place, so you have to try it out to see if it
2143: works.</p>
1.148 asau 2144: <div class="sect1">
1.75 rillig 2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2146: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2147: <p>In this section, you can find some variables that apply to all
1.89 rillig 2148: pkgsrc packages. A complete list of the variables that can be
2149: configured by the user is available in
2150: <code class="filename">mk/defaults/mk.conf</code>, together with some
2151: comments that describe each variable's intent.</p>
1.148 asau 2152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2153: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2154: packages will be installed. The default is
1.76 rillig 2155: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2156: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2157: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2158: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2159: installed. The default is
1.76 rillig 2160: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2161: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2162: X11 is installed on the system. The default is
1.76 rillig 2163: <code class="filename">/usr/X11R6</code>.</p></li>
1.128 wiz 2164: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2165: downloaded copies of the original source distributions used
2166: for building pkgsrc packages. The default is
1.76 rillig 2167: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2168: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2169: database about installed packages is stored. The default is
2170: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2171: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2172: If set, override the packages'
2173: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2174: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2175: Backup location(s) for distribution files and patch files
2176: if not found locally or in
1.76 rillig 2177: <code class="filename">${MASTER_SITES}</code> or
2178: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2179: The defaults are
1.132 spz 2180: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2181: and
1.76 rillig 2182: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2183: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2184: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2185: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2186: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2187: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2188: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2189: List of acceptable licenses. License names are case-sensitive.
2190: Whenever you try to build a package whose license is not in this
2191: list, you will get an error message. If the license condition is
2192: simple enough, the error message will include specific
2193: instructions on how to change this variable.</p></li>
1.75 rillig 2194: </ul></div>
2195: </div>
1.148 asau 2196: <div class="sect1">
1.75 rillig 2197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2198: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2199: <p>XXX
2200: </p>
1.148 asau 2201: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2202: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2203: directory for the binary packages. The default is
1.76 rillig 2204: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2205: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2206: The top level directory where, if defined, the separate
2207: working directories will get created, and symbolically
1.76 rillig 2208: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2209: This is useful for building packages on several
1.76 rillig 2210: architectures, then <code class="filename">${PKGSRCDIR}</code>
2211: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2212: is local to every architecture. (It should be noted that
2213: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2214: — it is an internal definition which refers to the
1.75 rillig 2215: root of the pkgsrc tree. It is possible to have many
2216: pkgsrc tree instances.)</p></li>
1.128 wiz 2217: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2218: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2219: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2220: information.</p></li>
1.128 wiz 2221: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2222: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2223: BSD-style Makefile. If this is not set,
2224: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2225: <code class="filename">/dev/null</code> to avoid picking up
2226: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2227: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2228: By default, dependencies are only installed, and no binary
2229: package is created for them. You can set this variable to
1.174 asau 2230: <code class="literal">package-install</code> to automatically create binary
1.82 rillig 2231: packages after installing dependencies.</p></li>
1.75 rillig 2232: </ul></div>
2233: </div>
1.148 asau 2234: <div class="sect1">
1.75 rillig 2235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2236: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2237: <p>Most packages support installation into a
1.103 wiz 2238: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2239: to be built, before the actual filesystem is touched. DESTDIR
2240: support exists in two variations:</p>
1.148 asau 2241: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2242: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 2243: installation and packaging is still run as root.</p></li>
2244: <li class="listitem"><p>Full DESTDIR support can run the complete
2245: build, installation and packaging as normal user. Root
2246: privileges are only needed to add packages.</p></li>
2247: </ul></div>
2248: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2249: you can set
2250: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2251: so it's preferable to convert a package to DESTDIR instead.</p>
1.103 wiz 2252: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2253: clean</code></strong> needs to be run as root.</p>
1.118 imil 2254: <p>Considering the <code class="filename">foo/bar</code> package,
2255: DESTDIR full support can be tested using the following commands
2256:
2257: </p>
2258: <pre class="programlisting">
2259: <code class="prompt">$</code> id
2260: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2261: <code class="prompt">$</code> mkdir $HOME/packages
2262: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2263: </pre>
2264: <p>
2265:
2266: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2267: should be needed
2268:
2269: </p>
2270: <pre class="programlisting">
1.174 asau 2271: <code class="prompt">$</code> make stage-install
1.118 imil 2272: </pre>
2273: <p>
2274:
2275: Create a package without root privileges
2276:
2277: </p>
2278: <pre class="programlisting">
1.174 asau 2279: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 2280: </pre>
2281: <p>
2282:
2283: For the following command, you must be able to gain root
1.136 dholland 2284: 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 2285:
2286: </p>
2287: <pre class="programlisting">
1.174 asau 2288: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 2289: </pre>
2290: <p>
2291:
2292: Then, as a simple user
2293:
2294: </p>
2295: <pre class="programlisting">
2296: <code class="prompt">$</code> make clean
2297: </pre>
2298: <p>
2299:
2300: </p>
1.103 wiz 2301: </div>
1.148 asau 2302: <div class="sect1">
1.103 wiz 2303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2304: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 2305: <div class="sect2">
1.78 rillig 2306: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2307: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2308: <p>By default, pkgsrc will use GCC to build packages. This may be
2309: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 2310: <div class="variablelist"><dl class="variablelist">
1.89 rillig 2311: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2312: <dd>
2313: <p>This is a list of values specifying the chain of
2314: compilers to invoke when building packages. Valid values
2315: are:</p>
1.148 asau 2316: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 2317: <li class="listitem"><p><code class="varname">ccc</code>:
2318: Compaq C Compilers (Tru64)</p></li>
2319: <li class="listitem"><p><code class="varname">ccache</code>:
2320: compiler cache (chainable)</p></li>
2321: <li class="listitem"><p><code class="varname">clang</code>:
2322: Clang C and Objective-C compiler</p></li>
1.128 wiz 2323: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2324: distributed C/C++ (chainable)</p></li>
1.174 asau 2325: <li class="listitem"><p><code class="varname">f2c</code>:
2326: Fortran 77 to C compiler (chainable)</p></li>
2327: <li class="listitem"><p><code class="varname">icc</code>:
2328: Intel C++ Compiler (Linux)</p></li>
2329: <li class="listitem"><p><code class="varname">ido</code>:
2330: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 2331: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2332: GNU C/C++ Compiler</p></li>
1.174 asau 2333: <li class="listitem"><p><code class="varname">hp</code>:
2334: HP-UX C/aC++ compilers</p></li>
1.128 wiz 2335: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2336: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 2337: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 2338: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2339: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2340: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 2341: <li class="listitem"><p><code class="varname">xlc</code>:
2342: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89 rillig 2343: </ul></div>
2344: <p>The default is
1.128 wiz 2345: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2346: <code class="varname">ccache</code> and/or
2347: <code class="varname">distcc</code> with an appropriate
2348: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2349: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2350: variable should always be terminated with a value for
2351: a real compiler. Note that only one real compiler
1.128 wiz 2352: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2353: is not allowed).</p>
1.89 rillig 2354: </dd>
2355: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2356: <dd><p>This specifies the minimum version of GCC to use
2357: when building packages. If the system GCC doesn't
2358: satisfy this requirement, then pkgsrc will build and
2359: install one of the GCC packages to use instead.</p></dd>
2360: </dl></div>
2361: </div>
1.148 asau 2362: <div class="sect2">
1.89 rillig 2363: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2364: <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 2365: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2366: please make sure to use the <code class="literal">+=</code> operator
2367: instead of the <code class="literal">=</code> operator:</p>
2368: <pre class="programlisting">
1.100 rillig 2369: CFLAGS+= -your -flags
1.78 rillig 2370: </pre>
2371: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2372: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2373: need to add their own flags. You may want to take a look
2374: 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 2375: package if you're interested in optimization specifically
2376: for the current CPU. </p>
1.78 rillig 2377: </div>
1.148 asau 2378: <div class="sect2">
1.88 wiz 2379: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2380: <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 2381: <p>If you want to pass flags to the linker, both in the configure
2382: step and the build step, you can do this in two ways. Either set
2383: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2384: between the two is that <code class="varname">LIBS</code> will be appended to
2385: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2386: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2387: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2388: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2389: <code class="varname">CFLAGS</code>, if you do not wish to override these
2390: settings, use the <code class="literal">+=</code> operator:</p>
2391: <pre class="programlisting">
1.100 rillig 2392: LDFLAGS+= -your -linkerflags
1.88 wiz 2393: </pre>
2394: </div>
1.78 rillig 2395: </div>
1.148 asau 2396: <div class="sect1">
1.78 rillig 2397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2398: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2399: <p>XXX
2400: </p>
1.148 asau 2401: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2402: <li class="listitem">
1.75 rillig 2403: <p><code class="varname">PKG_DEVELOPER</code>:
2404: Run some sanity checks that package developers want:
2405: </p>
1.148 asau 2406: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2407: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2408: fuzz</p></li>
1.128 wiz 2409: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2410: binaries will find their shared libs.</p></li>
1.75 rillig 2411: </ul></div>
2412: <p>
1.87 wiz 2413: </p>
1.75 rillig 2414: </li>
1.128 wiz 2415: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2416: of debugging output which is displayed whilst making and
2417: installing the package. The default value for this is 0,
2418: which will not display the commands as they are executed
2419: (normal, default, quiet operation); the value 1 will display
2420: all shell commands before their invocation, and the value 2
2421: will display both the shell commands before their invocation,
1.110 hubertf 2422: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2423: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2424: </ul></div>
2425: <p>
2426: </p>
2427: </div>
1.148 asau 2428: <div class="sect1">
1.75 rillig 2429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2430: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2431: <p>Some packages have build time options, usually to select
2432: between different dependencies, enable optional support for big
2433: dependencies or enable experimental features.</p>
1.75 rillig 2434: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2435: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2436: show-options</strong></span>, for example:</p>
1.75 rillig 2437: <pre class="programlisting">
2438: The following options are supported by this package:
2439: ssl Enable SSL support.
2440: Exactly one of the following gecko options is required:
2441: firefox Use firefox as gecko rendering engine.
2442: mozilla Use mozilla as gecko rendering engine.
2443: At most one of the following database options may be selected:
2444: mysql Enable support for MySQL database.
2445: pgsql Enable support for PostgreSQL database.
1.1 grant 2446:
1.75 rillig 2447: These options are enabled by default: firefox
2448: These options are currently enabled: mozilla ssl
1.1 grant 2449: </pre>
1.75 rillig 2450: <p>The following variables can be defined in
1.110 hubertf 2451: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2452: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2453: which can be used to select or disable options for all packages
2454: that support them, and
2455: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2456: which can be used to select or disable options specifically for
2457: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2458: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2459: are disabled. A few examples:</p>
1.75 rillig 2460: <pre class="screen">
1.110 hubertf 2461: <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 2462: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2463: PKG_OPTIONS.kdebase= debug -sasl
2464: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2465: <p>It is important to note that options that were specifically
1.120 snj 2466: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2467: you do not wish to include the option. If you are unsure you can view
2468: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2469: <p>The following settings are consulted in the order given, and
2470: the last setting that selects or disables an option is
2471: used:</p>
1.128 wiz 2472: <div class="orderedlist"><ol class="orderedlist" type="1">
2473: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2474: maintainer</p></li>
1.128 wiz 2475: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2476: variables (see below)</p></li>
1.128 wiz 2477: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2478: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2479: </ol></div>
2480: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2481: selected is used, all others are automatically disabled. If an
2482: option of the group is explicitly disabled, the previously
2483: selected option, if any, is used. It is an error if no option
2484: from a required group of options is selected, and building the
2485: package will fail.</p>
2486: <p>Before the options framework was introduced, build options
2487: were selected by setting a variable (often named
2488: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2489: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2490: transition to the options framework for the user, these legacy
2491: variables are converted to the appropriate options setting
2492: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2493: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2494: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2495: directly. Support for the legacy variables will be removed
2496: eventually.</p>
1.75 rillig 2497: </div>
2498: </div>
1.148 asau 2499: <div class="chapter">
1.75 rillig 2500: <div class="titlepage"><div><div><h2 class="title">
2501: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2502: <div class="toc">
2503: <p><b>Table of Contents</b></p>
2504: <dl>
2505: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2506: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2507: </dl>
2508: </div>
1.148 asau 2509: <div class="sect1">
1.75 rillig 2510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2511: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2512: <p>Once you have built and installed a package, you can create
2513: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.136 dholland 2514: 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 2515: the same package on a group of hosts and wasting CPU time. It also
2516: provides a simple means for others to install your package, should
2517: you distribute it.</p>
2518: <p>To create a binary package, change into the appropriate
1.110 hubertf 2519: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2520: package</strong></span>:</p>
2521: <pre class="screen">
2522: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2523: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2524: </pre>
2525: <p>This will build and install your package (if not already done),
2526: and then build a binary package from what was installed. You can
1.110 hubertf 2527: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2528: it. Binary packages are created by default in
2529: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2530: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2531: 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 2532: <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 2533: such a binary package.</p>
1.75 rillig 2534: </div>
1.148 asau 2535: <div class="sect1">
1.75 rillig 2536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2537: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2538: <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 2539: </div>
2540: </div>
1.148 asau 2541: <div class="chapter">
1.106 rillig 2542: <div class="titlepage"><div><div><h2 class="title">
2543: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2544: builds)</h2></div></div></div>
2545: <div class="toc">
2546: <p><b>Table of Contents</b></p>
2547: <dl>
2548: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2549: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
1.174 asau 2550: <dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
1.106 rillig 2551: <dd><dl>
1.174 asau 2552: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
2553: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
1.106 rillig 2554: </dl></dd>
1.174 asau 2555: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2556: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2557: </dl>
2558: </div>
2559: <p>When you have multiple machines that should run the same packages,
2560: it is wasted time if they all build their packages themselves from
1.174 asau 2561: source. There is a ways of getting a set of binary packages:
2562: The bulk build system, or pbulk ("p" stands for "parallel).
2563: This chapter describes how to set it up so that the packages
1.106 rillig 2564: are most likely to be usable later.</p>
1.148 asau 2565: <div class="sect1">
1.106 rillig 2566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2567: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2568: <p>Since a bulk build takes several days or even weeks to finish, you
2569: should think about the setup before you start everything. Pay attention
2570: to at least the following points:</p>
1.148 asau 2571: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2572: <li class="listitem">
1.106 rillig 2573: <p>If you want to upload the binary packages to
2574: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2575: packages:</p>
1.148 asau 2576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2577: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.106 rillig 2578: by a NetBSD developer on a trusted machine (that is, where you and only
2579: you have root access).</p></li>
1.128 wiz 2580: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.124 snj 2581: the stable branches (like 2009Q1), so that users browsing the available
1.106 rillig 2582: collections can see at a glance how old the packages
2583: are.</p></li>
1.128 wiz 2584: <li class="listitem"><p>The packages must be built as root, since some packages
1.106 rillig 2585: require set-uid binaries at runtime, and creating those packages as
2586: unprivileged user doesn't work well at the moment.</p></li>
2587: </ul></div>
2588: </li>
1.128 wiz 2589: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.106 rillig 2590: your system. Most bulk builds run as root, so they should be run at least
2591: in a chroot environment or something even more restrictive, depending on
2592: what the operating system provides. There have been numerous cases where
2593: certain packages tried to install files outside the
2594: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2595: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2596: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2597: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2598: that you don't need any package during the build.</p></li>
2599: </ul></div>
2600: </div>
1.148 asau 2601: <div class="sect1">
1.106 rillig 2602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2603: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2604: <p>A complete bulk build requires lots of disk space. Some of the
2605: disk space can be read-only, some other must be writable. Some can be on
2606: remote filesystems (such as NFS) and some should be local. Some can be
2607: temporary filesystems, others must survive a sudden reboot.</p>
1.148 asau 2608: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 jnemeth 2609: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2610: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2611: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
1.128 wiz 2612: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
1.169 jnemeth 2613: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
1.128 wiz 2614: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.106 rillig 2615: </ul></div>
1.75 rillig 2616: </div>
1.148 asau 2617: <div class="sect1">
1.75 rillig 2618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2619: <a name="bulk.pbulk"></a>7.3. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2620: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2621: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2622: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2623: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2624: </ul></div>
1.148 asau 2625: <div class="sect2">
1.116 rillig 2626: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2627: <a name="bulk.pbulk.prepare"></a>7.3.1. Preparation</h3></div></div></div>
1.117 jnemeth 2628: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
1.116 rillig 2629: <pre class="screen">
2630: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2631: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2632: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2633: </pre>
2634: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
1.148 asau 2635: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2636: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2637: <li class="listitem"><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
2638: <li class="listitem"><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
2639: <li class="listitem"><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
2640: <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.116 rillig 2641: </ul></div>
2642: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2643: <pre class="screen">
2644: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2645: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2646: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2647: </pre>
2648: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
2649: </div>
1.148 asau 2650: <div class="sect2">
1.106 rillig 2651: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2652: <a name="bulk.pbulk.conf"></a>7.3.2. Configuration</h3></div></div></div>
1.178 ! asau 2653: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
! 2654: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
! 2655: Configure network access to fetch distribution files.
! 2656: Create user with name "pbulk".</p>
! 2657: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
! 2658: <pre class="screen">
! 2659: <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>
! 2660: <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>
! 2661: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.netbsd.org:/cvsroot get -P pkgsrc)</code></strong>
! 2662: </pre>
! 2663: <p>Or any other way that fits (e.g., curl, wget).</p>
! 2664: <p>Deploy and configure pbulk tools, e.g.:</p>
! 2665: <pre class="screen">
! 2666: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
! 2667: <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>
! 2668: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
! 2669: </pre>
! 2670: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
! 2671: <h3 class="title">Note</h3>
! 2672: <p><code class="filename">mk.conf.frag</code> is a fragment of
! 2673: <code class="filename">mk.conf</code> that contains settings you want to
! 2674: apply to packages you build. For instance,</p>
! 2675: <pre class="programlisting">
! 2676: PKG_DEVELOPER= yes # perform more checks
! 2677: X11_TYPE= modular # use pkgsrc X11
! 2678: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
! 2679: </pre>
! 2680: </div>
! 2681: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
! 2682: with your list of packages one per line without empty lines or comments. E.g.:</p>
! 2683: <pre class="programlisting">
! 2684: www/firefox
! 2685: mail/thunderbird
! 2686: misc/libreoffice4
! 2687: </pre>
! 2688: <p>Start it:</p>
! 2689: <pre class="screen">
! 2690: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
! 2691: </pre>
! 2692: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
! 2693: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
! 2694: </p>
! 2695: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
! 2696: <h3 class="title">Note</h3>
! 2697: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
! 2698: While being ready to run, it serves as a good starting point to understand and build more complex setups.
! 2699: The script is kept small enough for better understanding.</p>
! 2700: </div>
! 2701: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
! 2702: <h3 class="title">Note</h3>
! 2703: <p>The <code class="filename">pbulk.sh</code> script supports running
! 2704: unprivileged bulk build and helps configuring distributed bulk builds.</p>
! 2705: </div>
1.106 rillig 2706: </div>
2707: </div>
1.148 asau 2708: <div class="sect1">
1.106 rillig 2709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2710: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2711: <p>After your pkgsrc bulk-build has completed, you may wish to
2712: create a CD-ROM set of the resulting binary packages to assist
2713: in installing packages on other machines. The
1.91 rillig 2714: <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 2715: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2716: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2717: way that keeps all the dependencies for a given package on the same
2718: CD as that package.</p>
1.148 asau 2719: <div class="sect2">
1.75 rillig 2720: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2721: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2722: <p>Complete documentation for cdpack is found in the cdpack(1)
2723: man page. The following short example assumes that the binary
2724: packages are left in
2725: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2726: sufficient disk space exists in <code class="filename">/u2</code> to
2727: hold the ISO 9660 images.</p>
2728: <pre class="screen">
2729: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2730: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2731: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2732: </pre>
2733: <p>If you wish to include a common set of files
2734: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2735: etc.) on each CD in the collection, then you need to create a
2736: directory which contains these files. e.g.</p>
2737: <pre class="screen">
2738: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2739: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2740: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2741: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2742: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2743: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2744: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2745: </pre>
1.75 rillig 2746: <p>Now create the images:</p>
2747: <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 2748: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2749: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2750: in their root directories.</p>
1.75 rillig 2751: </div>
2752: </div>
2753: </div>
1.148 asau 2754: <div class="chapter">
1.75 rillig 2755: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2756: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2757: <div class="toc">
2758: <p><b>Table of Contents</b></p>
2759: <dl>
1.128 wiz 2760: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2761: <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 2762: </dl>
2763: </div>
2764: <p>The files that are installed by pkgsrc are organized in a way that
2765: is similar to what you find in the <code class="filename">/usr</code> directory
2766: of the base system. But some details are different. This is because
2767: pkgsrc initially came from FreeBSD and had adopted its file system
2768: hierarchy. Later it was largely influenced by NetBSD. But no matter
2769: which operating system you are using pkgsrc with, you can expect the
2770: same layout for pkgsrc.</p>
1.91 rillig 2771: <p>There are mainly four root directories for pkgsrc, which are all
2772: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2773: When pkgsrc has been installed as root, the default locations
2774: are:</p>
2775: <pre class="programlisting">
1.100 rillig 2776: LOCALBASE= /usr/pkg
2777: PKG_SYSCONFBASE= /usr/pkg/etc
2778: VARBASE= /var
2779: PKG_DBDIR= /var/db/pkg
1.91 rillig 2780: </pre>
2781: <p>In unprivileged mode (when pkgsrc has been installed as any other
2782: user), the default locations are:</p>
2783: <pre class="programlisting">
1.100 rillig 2784: LOCALBASE= ${HOME}/pkg
2785: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2786: VARBASE= ${HOME}/pkg/var
2787: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 2788: </pre>
2789: <p>What these four directories are for, and what they look like is
2790: explained below.</p>
1.148 asau 2791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2792: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2793: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2794: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2795: the well-known subdirectories like <code class="filename">bin</code>,
2796: <code class="filename">include</code>, <code class="filename">lib</code>,
2797: <code class="filename">share</code> and
2798: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2799: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2800: <code class="filename">/var</code> in the base system. Some programs (especially
2801: games, network daemons) need write access to it during normal
2802: operation.</p></li>
1.128 wiz 2803: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2804: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2805: 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 2806: itself.</p></li>
2807: </ul></div>
1.148 asau 2808: <div class="sect1">
1.90 rillig 2809: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2810: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2811: </h2></div></div></div>
1.90 rillig 2812: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2813: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2814: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2815: <dt><span class="term"><code class="filename">bin</code></span></dt>
2816: <dd><p>Contains executable programs that are intended to be
2817: directly used by the end user.</p></dd>
2818: <dt><span class="term"><code class="filename">emul</code></span></dt>
2819: <dd><p>Contains files for the emulation layers of various other
2820: operating systems, especially for
2821: NetBSD.</p></dd>
2822: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2823: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2824: <dd><p>Contains
2825: the configuration files.</p></dd>
2826: <dt><span class="term"><code class="filename">include</code></span></dt>
2827: <dd><p>Contains headers for the C and C++ programming
2828: languages.</p></dd>
2829: <dt><span class="term"><code class="filename">info</code></span></dt>
2830: <dd><p>Contains GNU info files of various
2831: packages.</p></dd>
2832: <dt><span class="term"><code class="filename">lib</code></span></dt>
2833: <dd><p>Contains shared and static
2834: libraries.</p></dd>
2835: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2836: <dd><p>Contains data files that don't change after
2837: installation. Other data files belong into
2838: <code class="filename">${VARBASE}</code>.</p></dd>
2839: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2840: <dd><p>Contains programs that are not intended to be used by
2841: end users, such as helper programs or network
2842: daemons.</p></dd>
2843: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2844: <dd><p>Contains programs that are intended to be executed as
2845: CGI scripts by a web server.</p></dd>
2846: <dt><span class="term"><code class="filename">man</code> (the usual value of
2847: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2848: <dd><p>Contains brief
2849: documentation in form of manual pages.</p></dd>
2850: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2851: <dd><p>Contains programs that are intended to be used only by
2852: the super-user.</p></dd>
2853: <dt><span class="term"><code class="filename">share</code></span></dt>
2854: <dd><p>Contains platform-independent data files that don't
2855: change after installation.</p></dd>
2856: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2857: <dd><p>Contains documentation files provided by the
2858: packages.</p></dd>
2859: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2860: <dd><p>Contains example files provided by the packages. Among
2861: others, the original configuration files are saved here and copied to
2862: <code class="filename">${PKG_SYSCONFDIR}</code> during
2863: installation.</p></dd>
2864: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2865: <dd><p>Contains the original files for rc.d
2866: scripts.</p></dd>
2867: <dt><span class="term"><code class="filename">var</code> (the usual location of
2868: <code class="filename">${VARBASE}</code>)</span></dt>
2869: <dd><p>Contains files
2870: that may be modified after
2871: installation.</p></dd>
2872: </dl></div>
2873: </div>
1.148 asau 2874: <div class="sect1">
1.90 rillig 2875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2876: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2877: </h2></div></div></div>
1.148 asau 2878: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2879: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2880: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2881: <dd><p>Contains
2882: information about the currently installed
2883: packages.</p></dd>
2884: <dt><span class="term"><code class="filename">games</code></span></dt>
2885: <dd><p>Contains highscore
2886: files.</p></dd>
2887: <dt><span class="term"><code class="filename">log</code></span></dt>
2888: <dd><p>Contains log files.</p></dd>
2889: <dt><span class="term"><code class="filename">run</code></span></dt>
2890: <dd><p>Contains informational files about daemons that are
2891: currently running.</p></dd>
2892: </dl></div>
2893: </div>
2894: </div>
1.148 asau 2895: <div class="chapter">
1.90 rillig 2896: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2897: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2898: <div class="toc">
2899: <p><b>Table of Contents</b></p>
2900: <dl>
1.106 rillig 2901: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2902: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
2903: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
2904: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
2905: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
2906: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2907: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.173 wiz 2908: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
2909: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2910: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
2911: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2912: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.173 wiz 2913: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
2914: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
2915: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
2916: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
2917: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2918: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
2919: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. 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 2920: </dl>
2921: </div>
2922: <p>This section contains hints, tips & tricks on special things in
2923: pkgsrc that we didn't find a better place for in the previous chapters, and
2924: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2925: <div class="sect1">
1.75 rillig 2926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2927: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2928: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2929: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2930: <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 2931: This is a general purpose list for most issues regarding
2932: pkgsrc, regardless of platform, e.g. soliciting user help
2933: for pkgsrc configuration, unexpected build failures, using
2934: particular packages, upgrading pkgsrc installations,
2935: questions regarding the pkgsrc release branches, etc. General announcements or
2936: proposals for changes that impact the pkgsrc user community,
2937: e.g. major infrastructure changes, new features, package
2938: removals, etc., may also be posted.</p></li>
1.128 wiz 2939: <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 2940: A list where the results of pkgsrc bulk builds are sent and
2941: discussed.</p></li>
1.128 wiz 2942: <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 2943: This list is for those who are interested in getting a
2944: commit message for every change committed to pkgsrc. It is
2945: also available in digest form, meaning one daily message
2946: containing all commit messages for changes to the package
2947: source tree in that 24 hour period.</p></li>
2948: </ul></div>
2949: <p>To subscribe, do:</p>
2950: <pre class="programlisting">
1.100 rillig 2951: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2952: </pre>
2953: <p>Archives for all these mailing lists are available from
1.110 hubertf 2954: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2955: </div>
1.148 asau 2956: <div class="sect1">
1.75 rillig 2957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2958: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 2959: <p>Pkgviews is tightly integrated with buildlink. You can find a
2960: pkgviews User's guide in
1.76 rillig 2961: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 2962: </div>
1.148 asau 2963: <div class="sect1">
1.75 rillig 2964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2965: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2966: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2967: a number of useful utilities for both users and developers of pkgsrc. This
2968: section attempts only to make the reader aware of the utilities and when
2969: they might be useful, and not to duplicate the documentation that comes
2970: with each package.</p>
2971: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.148 asau 2972: <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 2973: Symlinks for use by buildlink.</p></li></ul></div>
2974: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2975: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2976: <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 2977: Calculates various kinds of checksums (including SHA1).</p></li>
1.128 wiz 2978: <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 2979: Compatibility library for pkgsrc tools.</p></li>
1.128 wiz 2980: <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 2981: non-BSD systems due to lack of native mtree.</p></li>
1.128 wiz 2982: <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 2983: Up-to-date replacement for
1.76 rillig 2984: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2985: systems where pkg_install is not present.</p></li>
2986: </ul></div>
2987: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2988: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2989: <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 2990: Create a binary package from an
1.110 hubertf 2991: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2992: save the old package.</p></li>
1.128 wiz 2993: <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 2994: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2995: from multiple locations. It currently supports the following
2996: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.128 wiz 2997: <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 2998: the best compiler flags to optimise code for your current
1.128 wiz 2999: CPU and compiler. </p></li>
1.75 rillig 3000: </ul></div>
3001: <p>Utilities for keeping track of installed packages, being up to date,
3002: etc:</p>
1.148 asau 3003: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.173 wiz 3004: <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
3005: update tool similar to apt(1). Download, install, and upgrade
3006: binary packages easily.</p></li>
1.128 wiz 3007: <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 3008: packages whose installed versions do not match the latest pkgsrc
3009: entries.</p></li>
1.128 wiz 3010: <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 3011: dependency graphs of packages, to aid in choosing a strategy for
3012: updating.</p></li>
1.128 wiz 3013: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
1.91 rillig 3014: graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
1.128 wiz 3015: <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 3016: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.128 wiz 3017: <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 3018: does various checks on the complete pkgsrc system.</p></li>
1.128 wiz 3019: <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 3020: packages you have installed.</p></li>
3021: </ul></div>
3022: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 3023: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3024: <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 3025: making and maintaining patches for a package (includes pkgdiff,
3026: pkgvi, mkpatches, etc.).</p></li>
1.173 wiz 3027: <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 3028: converting to pkgsrc.</p></li>
3029: </ul></div>
3030: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3031: utilities)</p>
1.148 asau 3032: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3033: <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 3034: packages in a chrooted area.</p></li>
1.128 wiz 3035: <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 3036: kernel version for chrooted cross builds.</p></li>
3037: </ul></div>
3038: </div>
1.148 asau 3039: <div class="sect1">
1.75 rillig 3040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3041: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3042: <p>If you want to use pkgsrc as non-root user, you can set some
3043: variables to make pkgsrc work under these conditions. At the very least,
1.128 wiz 3044: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 3045: will turn on unprivileged mode and set multiple related variables to allow
3046: installation of packages as non-root.</p>
3047: <p>In case the defaults are not enough, you may want to tune some other
3048: variables used. For example, if the automatic user/group detection leads
3049: to incorrect values (or not the ones you would like to use), you can change
3050: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3051: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3052: <p>As regards bootstrapping, please note that the
1.110 hubertf 3053: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3054: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3055: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3056: installation targets. These directories can be overridden by the
1.128 wiz 3057: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3058: that allow finer tuning of the tree layout.</p>
3059: </div>
1.148 asau 3060: <div class="sect1">
1.75 rillig 3061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3062: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3063: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3064: enable this feature by adding the option
3065: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3066: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3067: distfile is found, pkgsrc will try to resume it.</p>
3068: <p>You can also
1.168 wiz 3069: use a different program than the platform default program by changing the
1.117 jnemeth 3070: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3071: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3072: by using the value manual. A value of custom disables the system defaults
3073: and dependency tracking for the fetch program. In that case you have to
3074: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3075: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3076: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3077: <p>For example, if you want to use
1.117 jnemeth 3078: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3079: like:</p>
3080: <pre class="programlisting">
1.117 jnemeth 3081: FETCH_USING= wget
1.1 grant 3082: </pre>
1.75 rillig 3083: </div>
1.148 asau 3084: <div class="sect1">
1.75 rillig 3085: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3086: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 3087: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3088: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3089: you will have to add the following line into
1.110 hubertf 3090: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3091: <pre class="programlisting">
1.103 wiz 3092: X11_TYPE=modular
1.1 grant 3093: </pre>
1.148 asau 3094: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3095: <h3 class="title">Note</h3>
1.103 wiz 3096: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3097: </p>
1.75 rillig 3098: </div>
3099: </div>
1.148 asau 3100: <div class="sect1">
1.75 rillig 3101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3102: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3103: <p>If you are sitting behind a firewall which does not allow direct
3104: connections to Internet hosts (i.e. non-NAT), you may specify the
3105: relevant proxy hosts. This is done using an environment variable in the
3106: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 3107: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3108: port 80 as the proxy port number. So the proxy environment variables
3109: are:</p>
3110: <pre class="programlisting">
1.100 rillig 3111: ftp_proxy=ftp://orpheus.amdahl.com:80/
3112: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3113: </pre>
1.75 rillig 3114: </div>
1.148 asau 3115: <div class="sect1">
1.75 rillig 3116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3117: <a name="fetch-https"></a>9.8. How to fetch files from HTTPS sites</h2></div></div></div>
3118: <p>Some fetch tools are not prepared to support HTTPS by default
3119: (for example, the one in NetBSD 6.0), or the one installed by the
3120: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3121: dependency graph).</p>
3122: <p>Usually you won't notice, because distribution files are
3123: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3124: be often enough if you are following pkgsrc-current. In that case, set
3125: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3126: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3127: with HTTPS support by default. Of course, these tools need to be
3128: installed before you can use them this way.</p>
3129: </div>
3130: <div class="sect1">
3131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3132: <a name="passive-ftp"></a>9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3133: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3134: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3135: the first available command from the following list:</p>
1.148 asau 3136: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3137: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3138: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3139: </ul></div>
3140: <p>On a default NetBSD installation, this will be
1.76 rillig 3141: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3142: connections first, and falls back to active connections if the server
3143: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3144: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3145: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3146: <p>Having that option present will prevent
1.76 rillig 3147: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3148: transfers.</p>
3149: </div>
1.148 asau 3150: <div class="sect1">
1.75 rillig 3151: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3152: <a name="fetching-all-distfiles"></a>9.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3153: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3154: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3155: 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 3156: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3157: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3158: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3159: resulting list to your machine at work/school and use it there. If you
1.136 dholland 3160: 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 3161: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3162: URL:</p>
3163: <p>At home:</p>
3164: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3165: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3166: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3167: <p>At work:</p>
3168: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3169: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3170: home.</p>
3171: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3172: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3173: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3174: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3175: directly by running:</p>
1.75 rillig 3176: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3177: <p>If you even decide to ignore
3178: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3179: by running:</p>
3180: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3181: </div>
1.148 asau 3182: <div class="sect1">
1.75 rillig 3183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3184: <a name="tmac.andoc-missing"></a>9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 3185: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.91 rillig 3186: <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 3187: package, you get the error from make that it doesn't know how to make
1.76 rillig 3188: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3189: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3190: the NetBSD base distribution on your machine. It is recommended to do
3191: that to format man pages.</p>
1.91 rillig 3192: <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 3193: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3194: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3195: </div>
1.148 asau 3196: <div class="sect1">
1.75 rillig 3197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3198: <a name="bsd.own.mk-missing"></a>9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.87 wiz 3199: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3200: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3201: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3202: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3203: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3204: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3205: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3206: -r</strong></span>).</p>
3207: </div>
1.148 asau 3208: <div class="sect1">
1.75 rillig 3209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3210: <a name="using-sudo-with-pkgsrc"></a>9.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3211: <p>When installing packages as non-root user and using the just-in-time
1.136 dholland 3212: <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 3213: password for each required package installed. To avoid this, the sudo
3214: package can be used, which does password caching over a limited time. To
3215: use it, install sudo (either as binary package or from
1.98 wiz 3216: <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 3217: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3218: <span class="emphasis"><em>after</em></span> the definition of the
3219: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3220: <pre class="programlisting">
1.100 rillig 3221: .if exists(${LOCALBASE}/bin/sudo)
3222: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3223: .endif
1.1 grant 3224: </pre>
1.75 rillig 3225: </div>
1.148 asau 3226: <div class="sect1">
1.75 rillig 3227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3228: <a name="faq.conf"></a>9.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3229: <p>As the system administrator, you can choose where configuration files
3230: are installed. The default settings make all these files go into
1.76 rillig 3231: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3232: be suboptimal depending on your expectations (e.g., a read-only,
3233: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3234: configuration of the provided packages).</p>
3235: <p>In order to change the defaults, you can modify the
3236: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3237: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3238: directory; some common examples include <code class="filename">/etc</code> or
3239: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3240: <p>Furthermore, you can change this value on a per-package basis by
3241: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3242: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3243: package you would like to modify, that is, the contents of
3244: <code class="varname">PKGBASE</code>.</p>
3245: <p>Note that after changing these settings, you must rebuild and
3246: reinstall any affected packages.</p>
3247: </div>
1.148 asau 3248: <div class="sect1">
1.75 rillig 3249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3250: <a name="audit-packages"></a>9.15. Automated security checks</h2></div></div></div>
1.75 rillig 3251: <p>Please be aware that there can often be bugs in third-party software,
3252: and some of these bugs can leave a machine vulnerable to exploitation by
3253: attackers. In an effort to lessen the exposure, the NetBSD packages team
3254: maintains a database of known-exploits to packages which have at one time
3255: been included in pkgsrc. The database can be downloaded automatically, and
3256: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3257: do this, refer to the following two tools (installed as part of the
3258: <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 3259: <div class="orderedlist"><ol class="orderedlist" type="1">
3260: <li class="listitem">
1.122 reed 3261: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3262: download a list of the security vulnerabilities information. This list
1.132 spz 3263: is kept up to date by the pkgsrc security team, and is distributed
3264: from the NetBSD ftp server:</p>
3265: <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 3266: </li>
1.128 wiz 3267: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3268: current machine, checking each known vulnerability. If a
1.75 rillig 3269: vulnerable package is installed, it will be shown by output to stdout,
3270: including a description of the type of vulnerability, and a URL
3271: containing more information.</p></li>
3272: </ol></div>
1.114 jmcneill 3273: <p>Use of these tools is strongly recommended! After
1.128 wiz 3274: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3275: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3276: pkg_install</code></strong>.</p>
1.87 wiz 3277: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3278: 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 3279: check.</p>
1.75 rillig 3280: </div>
1.148 asau 3281: <div class="sect1">
1.75 rillig 3282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3283: <a name="ufaq-cflags"></a>9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3284: <p>When you add your own preferences to the
3285: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3286: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3287: environment variables to the <code class="filename">./configure</code>
1.136 dholland 3288: 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 3289: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3290: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3291: package.</p>
3292: <p>Currently there is no solution to this problem. If you
3293: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3294: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3295: directory and then inspect any <code class="filename">Makefile</code> and
3296: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3297: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3298: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3299: programmers write so bad code that it only works for the
3300: specific combination of <code class="varname">CFLAGS</code> they have
3301: chosen.</p>
3302: </div>
1.148 asau 3303: <div class="sect1">
1.80 rillig 3304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3305: <a name="ufaq-fail"></a>9.17. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3306: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3307: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3308: case that occurs often is that people only update pkgsrc in
3309: parts, because of performance reasons. Since pkgsrc is one large
3310: system, not a collection of many small systems, there are
3311: sometimes changes that only work when the whole pkgsrc tree is
3312: updated.</p></li>
1.148 asau 3313: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3314: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3315: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3316: files.</p></li>
1.148 asau 3317: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3318: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3319: verify this.</p></li>
1.148 asau 3320: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3321: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3322: </ol></div>
3323: </div>
1.148 asau 3324: <div class="sect1">
1.88 wiz 3325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3326: <a name="faq.rcs-conflicts"></a>9.18. 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 3327: <p>You have modified a file from pkgsrc, and someone else has
3328: modified that same file afterwards in the CVS repository. Both changes
3329: are in the same region of the file, so when you updated pkgsrc, the
3330: <code class="literal">cvs</code> command marked the conflicting changes in the
3331: file. Because of these markers, the file is no longer a valid
3332: <code class="filename">Makefile</code>.</p>
3333: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3334: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3335: -dP</strong></span> in that directory to download the current version.</p>
3336: </div>
1.75 rillig 3337: </div>
3338: </div>
1.148 asau 3339: <div class="part">
1.75 rillig 3340: <div class="titlepage"><div><div><h1 class="title">
3341: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3342: <div class="partintro">
1.77 rillig 3343: <div></div>
3344: <p>This part of the book deals with creating and
1.128 wiz 3345: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3346: guide on creating a new package. The remaining chapters are more
3347: like a reference manual for pkgsrc.</p>
1.75 rillig 3348: <div class="toc">
3349: <p><b>Table of Contents</b></p>
3350: <dl>
1.106 rillig 3351: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3352: <dd><dl>
1.106 rillig 3353: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3354: <dd><dl>
1.106 rillig 3355: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3356: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3357: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3358: </dl></dd>
1.106 rillig 3359: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3360: <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>
3361: </dl></dd>
3362: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3363: <dd><dl>
1.128 wiz 3364: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3365: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3366: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3367: <dd><dl>
3368: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3369: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3370: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3371: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3372: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3373: </dl></dd>
3374: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3375: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3376: <dd><dl>
3377: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3378: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3379: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3380: </dl></dd>
1.128 wiz 3381: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3382: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3383: </dl></dd>
1.128 wiz 3384: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3385: <dd><dl>
3386: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3387: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3388: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3389: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3390: <dd><dl>
3391: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3392: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3393: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3394: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3395: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3396: </dl></dd>
3397: </dl></dd>
3398: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3399: <dd><dl>
3400: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 3401: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3402: <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 3403: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3404: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 3405: <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 3406: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3407: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3408: </dl></dd>
3409: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3410: <dd><dl>
3411: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 3412: <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 3413: <dd><dl>
3414: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 3415: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3416: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3417: and
3418: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3419: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3420: </dl></dd>
1.128 wiz 3421: <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 3422: <dd><dl>
1.128 wiz 3423: <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 3424: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3425: </dl></dd>
3426: </dl></dd>
3427: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3428: <dd><dl>
3429: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3430: <dd><dl>
3431: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3432: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3433: </dl></dd>
3434: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3435: <dd><dl>
1.128 wiz 3436: <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 3437: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3438: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3439: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3440: </dl></dd>
3441: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3442: <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>
3443: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3444: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3445: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3446: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3447: <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>
3448: </dl></dd>
3449: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3450: <dd><dl>
3451: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3452: <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 3453: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3454: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3455: </dl></dd>
3456: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3457: <dd><dl>
3458: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3459: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3460: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3461: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3462: <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 3463: <dd><dl>
3464: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3465: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3466: </dl></dd>
1.128 wiz 3467: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3468: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3469: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3470: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3471: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3472: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3473: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3474: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3475: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3476: <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 3477: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3478: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3479: </dl></dd>
3480: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3481: <dd><dl>
3482: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3483: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3484: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3485: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3486: </dl></dd>
3487: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3488: <dd><dl>
3489: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3490: <dd><dl>
3491: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3492: <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 3493: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3494: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3495: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3496: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3497: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3498: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3499: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3500: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3501: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3502: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3503: </dl></dd>
1.128 wiz 3504: <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 3505: <dd><dl>
3506: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3507: <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>
3508: </dl></dd>
1.128 wiz 3509: <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 3510: <dd><dl>
3511: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3512: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3513: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3514: </dl></dd>
3515: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3516: <dd><dl>
3517: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3518: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3519: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 3520: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3521: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 3522: </dl></dd>
1.128 wiz 3523: <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 3524: <dd><dl>
3525: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3526: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3527: <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 3528: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3529: </dl></dd>
1.128 wiz 3530: <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 3531: <dd><dl>
3532: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3533: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3534: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3535: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3536: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3537: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3538: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3539: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3540: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3541: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3542: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3543: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3544: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3545: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3546: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3547: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3548: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3549: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3550: emulation</a></span></dt>
1.106 rillig 3551: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3552: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3553: </dl></dd>
1.106 rillig 3554: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3555: </dl></dd>
1.106 rillig 3556: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3557: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3558: <dd><dl>
1.106 rillig 3559: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3560: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3561: <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 3562: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3563: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3564: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3565: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3566: </dl></dd>
3567: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3568: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3569: <dd><dl>
3570: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3571: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3572: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3573: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3574: </dl></dd>
1.75 rillig 3575: </dl>
3576: </div>
1.77 rillig 3577: </div>
1.148 asau 3578: <div class="chapter">
1.77 rillig 3579: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3580: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3581: <div class="toc">
3582: <p><b>Table of Contents</b></p>
3583: <dl>
1.106 rillig 3584: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3585: <dd><dl>
1.106 rillig 3586: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3587: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3588: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3589: </dl></dd>
1.106 rillig 3590: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3591: <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 3592: </dl>
3593: </div>
1.77 rillig 3594: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3595: most likely have a URL from where you can download the source
3596: code. Starting with this URL, creating a package involves only a
3597: few steps.</p>
1.128 wiz 3598: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3599: <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>
3600: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3601: category in which you want to place your package. You can also create a
3602: directory of your own (maybe called <code class="filename">local</code>). In that
3603: category directory, create another directory for your package and change
3604: into it.</p></li>
1.148 asau 3605: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3606: you for a URL. Enter the URL of the distribution file (in most cases a
3607: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3608: of your package are created automatically. The distribution file is
3609: extracted automatically to fill in some details in the
3610: <code class="filename">Makefile</code> that would otherwise have to be done
3611: manually.</p></li>
1.148 asau 3612: <li class="step">
1.91 rillig 3613: <p>Examine the extracted files to determine the dependencies of
3614: your package. Ideally, this is mentioned in some
3615: <code class="filename">README</code> file, but things may differ. For each of
3616: these dependencies, look where it exists in pkgsrc, and if there is a
3617: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3618: line to your package <code class="filename">Makefile</code> which includes that
3619: file just before the last line. If the
1.132 spz 3620: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3621: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3622: <p>If you just need binaries from a package, add a
1.91 rillig 3623: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3624: version of the dependency and where it can be found in pkgsrc. This line
3625: should be placed in the third paragraph. If the dependency is only
3626: needed for building the package, but not when using it, use
3627: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3628: Your package may then look like this:</p>
1.77 rillig 3629: <pre class="programlisting">
1.100 rillig 3630: [...]
1.77 rillig 3631:
1.174 asau 3632: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3633: DEPENDS+= screen-[0-9]*:../../misc/screen
3634: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3635:
1.100 rillig 3636: [...]
1.77 rillig 3637:
1.100 rillig 3638: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3639: .include "../../devel/glib2/buildlink3.mk"
3640: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3641: </pre>
3642: </li>
1.148 asau 3643: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3644: 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 3645: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3646: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3647: -e</strong></span>, which outputs additional
3648: explanations.</p></li>
1.148 asau 3649: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3650: 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 3651: over there, you can hopefully continue here.</p></li>
1.148 asau 3652: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3653: directory from the extracted files. Besides these files, a lot of cache
3654: files and other system information has been saved in the working
3655: directory, which may become wrong after you edited the
3656: <code class="filename">Makefile</code>.</p></li>
1.148 asau 3657: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3658: 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 3659: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3660: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3661: everything works.</p></li>
1.148 asau 3662: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3663: contains a list of the files that are installed by the package, is
1.110 hubertf 3664: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3665: >PLIST</strong></span> to generate a probably correct list. Check
3666: the file using your preferred text editor to see if the list of
3667: files looks plausible.</p></li>
1.148 asau 3668: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3669: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3670: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3671: has been registered in the database of installed files, but with an
1.110 hubertf 3672: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3673: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3674: registered with the list of files from
3675: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3676: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3677: package from the set of installed files.</p></li>
1.77 rillig 3678: </ol></div>
1.148 asau 3679: <div class="sect1">
1.91 rillig 3680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3681: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3682: <div class="sect2">
1.91 rillig 3683: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3684: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3685: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3686: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3687: </div>
1.148 asau 3688: <div class="sect2">
1.91 rillig 3689: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 3690: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3691: <p>KDE3 applications should always include
1.91 rillig 3692: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174 asau 3693: settings that are typical of KDE3 packages.</p>
1.91 rillig 3694: </div>
1.148 asau 3695: <div class="sect2">
1.118 imil 3696: <div class="titlepage"><div><div><h3 class="title">
3697: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3698: <p>Python modules and programs packages are easily created using a
3699: set of predefined variables.</p>
3700: <p>
1.171 wiz 3701: If some Python versions are not supported by the software, set the
3702: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3703: that are not supported, e.g.
1.118 imil 3704: </p>
3705: <pre class="programlisting">
1.172 wiz 3706: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.118 imil 3707: </pre>
3708: <p>
3709: If the packaged software is a Python module, include
1.128 wiz 3710: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3711: In this case, the package directory should be called
1.128 wiz 3712: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3713: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3714: </p>
3715: <pre class="programlisting">
3716: DISTNAME= foopymodule-1.2.10
3717: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3718: </pre>
1.171 wiz 3719: <p>If it is an application, include
3720: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3721: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3722: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3723: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3724: For example:
1.118 imil 3725: </p>
3726: <pre class="programlisting">
1.142 wiz 3727: REPLACE_PYTHON= *.py
1.118 imil 3728: </pre>
1.171 wiz 3729: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3730: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3731: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3732: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3733: so pkgsrc will use this framework.
3734: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3735: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3736: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3737: to the name of the script.</p>
3738: <p>Otherwise, if the packaged software is egg-aware, you only need
3739: to include
3740: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3741: <p>Some Python modules have separate distributions for Python-2.x
3742: and Python-3.x support. In pkgsrc this is handled by the
3743: <code class="filename">versioned_dependencies.mk</code> file. Set
3744: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3745: packages that should be depended upon and include
3746: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3747: then the pkgsrc infrastructure will depend on the appropriate package
3748: version. For example:
3749: </p>
3750: <pre class="programlisting">
3751: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3752: </pre>
3753: <p>
3754: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3755: of supported packages.</p>
1.118 imil 3756: </div>
1.91 rillig 3757: </div>
1.148 asau 3758: <div class="sect1">
1.91 rillig 3759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3760: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3761: <div class="sect2">
1.91 rillig 3762: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3763: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3764: <div class="sect3">
1.91 rillig 3765: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3766: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3767: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3768: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3769: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3770: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3771: <pre class="programlisting">
1.100 rillig 3772: <code class="prompt">$</code> mkdir www/nvu
3773: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3774: </pre>
3775: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3776: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3777: <pre class="programlisting">
1.100 rillig 3778: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3779: </pre>
3780: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3781: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3782: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3783: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3784: <code class="varname">COMMENT</code> fields. Then the package
3785: <code class="filename">Makefile</code> looked like that:</p>
3786: <pre class="programlisting">
1.100 rillig 3787: # $NetBSD$
3788: #
1.91 rillig 3789:
1.100 rillig 3790: DISTNAME= nvu-1.0-sources
3791: PKGNAME= nvu-1.0
3792: CATEGORIES= www
3793: MASTER_SITES= http://cvs.nvu.com/download/
3794: EXTRACT_SUFX= .tar.bz2
3795:
3796: MAINTAINER= rillig@NetBSD.org
3797: HOMEPAGE= http://cvs.nvu.com/
3798: COMMENT= Web Authoring System
1.91 rillig 3799:
1.100 rillig 3800: # url2pkg-marker (please do not remove this line.)
3801: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3802: </pre>
3803: <p>Then, I quit the editor and watched pkgsrc downloading a large
3804: source archive:</p>
3805: <pre class="programlisting">
1.100 rillig 3806: url2pkg> Running "make makesum" ...
3807: => Required installed package digest>=20010302: digest-20060826 found
3808: => Fetching nvu-1.0-sources.tar.bz2
3809: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3810: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3811: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3812: url2pkg> Running "make extract" ...
3813: => Required installed package digest>=20010302: digest-20060826 found
3814: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3815: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3816: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3817: ===> Installing dependencies for nvu-1.0
3818: ===> Overriding tools for nvu-1.0
3819: ===> Extracting for nvu-1.0
3820: url2pkg> Adjusting the Makefile.
1.91 rillig 3821:
1.100 rillig 3822: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3823:
1.100 rillig 3824: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3825: </pre>
3826: </div>
1.148 asau 3827: <div class="sect3">
1.91 rillig 3828: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3829: <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 3830: <p>Now that the package has been extracted, let's see what's inside
3831: it. The package has a <code class="filename">README.txt</code>, but that only
3832: says something about mozilla, so it's probably useless for seeing what
3833: dependencies this package has. But since there is a GNU configure script
3834: in the package, let's hope that it will complain about everything it
3835: needs.</p>
3836: <pre class="programlisting">
1.100 rillig 3837: <code class="prompt">$</code> bmake
3838: => Required installed package digest>=20010302: digest-20060826 found
3839: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3840: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3841: ===> Patching for nvu-1.0
3842: ===> Creating toolchain wrappers for nvu-1.0
3843: ===> Configuring for nvu-1.0
3844: [...]
3845: configure: error: Perl 5.004 or higher is required.
3846: [...]
3847: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3848: [...]
1.91 rillig 3849: </pre>
3850: <p>That worked quite well. So I opened the package Makefile in my
3851: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3852: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3853: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3854: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3855: from scratch.</p>
3856: <pre class="programlisting">
1.100 rillig 3857: <code class="prompt">$</code> bmake clean
3858: ===> Cleaning for nvu-1.0
3859: <code class="prompt">$</code> bmake
3860: [...]
3861: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3862: GNU Make. You will not be able to build Mozilla without GNU Make.
3863: [...]
1.91 rillig 3864: </pre>
1.128 wiz 3865: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3866: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3867: <pre class="programlisting">
1.100 rillig 3868: [...]
3869: checking for GTK - version >= 1.2.0... no
3870: *** Could not run GTK test program, checking why...
3871: [...]
1.91 rillig 3872: </pre>
3873: <p>Now to the other dependencies. The first question is: Where is the
3874: GTK package hidden in pkgsrc?</p>
3875: <pre class="programlisting">
1.100 rillig 3876: <code class="prompt">$</code> echo ../../*/gtk*
3877: [many packages ...]
3878: <code class="prompt">$</code> echo ../../*/gtk
3879: ../../x11/gtk
3880: <code class="prompt">$</code> echo ../../*/gtk2
3881: ../../x11/gtk2
3882: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3883: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3884: </pre>
3885: <p>The first try was definitely too broad. The second one had exactly
3886: one result, which is very good. But there is one pitfall with GNOME
3887: packages. Before GNOME 2 had been released, there were already many
3888: GNOME 1 packages in pkgsrc. To be able to continue to use these
3889: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3890: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3891: whether this was the case here, and indeed it was.</p>
3892: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3893: file, adding the dependency is very easy. I just inserted an
3894: <code class="literal">.include</code> line before the last line of the package
3895: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3896: <pre class="programlisting">
1.100 rillig 3897: [...]
3898: .include "../../x11/gtk2/buildlink3.mk"
3899: .include "../../mk/bsd.pkg.mk
1.91 rillig 3900: </pre>
1.110 hubertf 3901: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3902: was:</p>
3903: <pre class="programlisting">
1.100 rillig 3904: [...]
3905: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3906: checking for GTK - version >= 1.2.0... no
3907: *** Could not run GTK test program, checking why...
3908: *** The test program failed to compile or link. See the file config.log for the
3909: *** exact error that occured. This usually means GTK was incorrectly installed
3910: *** or that you have moved GTK since it was installed. In the latter case, you
3911: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3912: configure: error: Test for GTK failed.
3913: [...]
1.91 rillig 3914: </pre>
1.128 wiz 3915: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3916: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3917: told me that this package really wanted to have the GNOME 1 version of
3918: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3919: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3920: So I changed the <code class="literal">x11/gtk2</code> to
3921: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3922: and tried again.</p>
3923: <pre class="programlisting">
1.100 rillig 3924: [...]
1.166 jnemeth 3925: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3926: In file included from xpidl.c:42:
3927: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3928: In file included from xpidl.c:42:
3929: xpidl.h:132: error: parse error before "IDL_ns"
3930: [...]
1.91 rillig 3931: </pre>
3932: <p>The package still does not find all of its dependencies. Now the
3933: question is: Which package provides the
3934: <code class="filename">libIDL/IDL.h</code> header file?</p>
3935: <pre class="programlisting">
1.100 rillig 3936: <code class="prompt">$</code> echo ../../*/*idl*
3937: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3938: <code class="prompt">$</code> echo ../../*/*IDL*
3939: ../../net/libIDL
1.91 rillig 3940: </pre>
3941: <p>Let's take the one from the second try. So I included the
3942: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3943: again. But the error didn't change. After digging through some of the
3944: code, I concluded that the build process of the package was broken and
3945: couldn't have ever worked, but since the Mozilla source tree is quite
3946: large, I didn't want to fix it. So I added the following to the package
3947: <code class="filename">Makefile</code> and tried again:</p>
3948: <pre class="programlisting">
1.100 rillig 3949: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3950: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 3951: </pre>
3952: <p>The latter line is needed because the package expects the library
3953: <code class="filename">libIDL.so</code>, but only
3954: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3955: wrapper to rewrite that on the fly.</p>
3956: <p>The next problem was related to a recent change of the FreeType
3957: 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>
3958: which patch files were relevant for this issue and copied them to the
3959: <code class="filename">patches</code> directory. Then I retried, fixed the
3960: patches so that they applied cleanly and retried again. This time,
3961: everything worked.</p>
3962: </div>
1.148 asau 3963: <div class="sect3">
1.91 rillig 3964: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3965: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3966: <pre class="programlisting">
1.100 rillig 3967: <code class="prompt">$</code> bmake CHECK_FILES=no install
3968: [...]
3969: <code class="prompt">$</code> bmake print-PLIST >PLIST
3970: <code class="prompt">$</code> bmake deinstall
3971: <code class="prompt">$</code> bmake install
1.91 rillig 3972: </pre>
3973: </div>
3974: </div>
3975: </div>
1.77 rillig 3976: </div>
1.148 asau 3977: <div class="chapter">
1.75 rillig 3978: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3979: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3980: <div class="toc">
3981: <p><b>Table of Contents</b></p>
3982: <dl>
1.128 wiz 3983: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3984: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3985: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3986: <dd><dl>
3987: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3988: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3989: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3990: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3991: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3992: </dl></dd>
3993: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3994: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3995: <dd><dl>
3996: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3997: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3998: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3999: </dl></dd>
1.128 wiz 4000: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4001: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4002: </dl>
4003: </div>
1.87 wiz 4004: <p>Whenever you're preparing a package, there are a number of
4005: files involved which are described in the following
4006: sections.</p>
1.148 asau 4007: <div class="sect1">
1.75 rillig 4008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4009: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4010: </h2></div></div></div>
1.75 rillig 4011: <p>Building, installation and creation of a binary package are all
1.87 wiz 4012: controlled by the package's <code class="filename">Makefile</code>.
4013: The <code class="filename">Makefile</code> describes various things about
4014: a package, for example from where to get it, how to configure,
4015: build, and install it.</p>
1.76 rillig 4016: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4017: sections that describe the package.</p>
1.75 rillig 4018: <p>In the first section there are the following variables, which
1.87 wiz 4019: should appear exactly in the order given here. The order and
4020: grouping of the variables is mostly historical and has no further
4021: meaning.</p>
1.148 asau 4022: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4023: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4024: distribution file to be downloaded from the package's
4025: website.</p></li>
1.128 wiz 4026: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 4027: package, as used by pkgsrc. You need to provide it if
1.87 wiz 4028: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 4029: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
4030: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 4031: directory name together with the version number. It must match the
4032: regular expression
4033: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4034: starts with a letter or digit, and contains only letters, digits,
4035: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 4036: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.87 wiz 4037: the package file to create if the <code class="varname">PKGNAME</code>
4038: isn't unique on a SVR4 system. The default is
4039: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4040: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
1.87 wiz 4041: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4042: does not produce an unique package name on a SVR4 system.
4043: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4044: characters.</p></li>
1.128 wiz 4045: <li class="listitem">
1.75 rillig 4046: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4047: which the package fits in. You can choose any of the top-level
4048: directories of pkgsrc for it.</p>
1.75 rillig 4049: <p>Currently the following values are available for
1.87 wiz 4050: <code class="varname">CATEGORIES</code>. If more than
4051: one is used, they need to be separated by spaces:</p>
1.75 rillig 4052: <pre class="programlisting">
1.100 rillig 4053: archivers cross geography meta-pkgs security
4054: audio databases graphics misc shells
4055: benchmarks devel ham multimedia sysutils
4056: biology editors inputmethod net textproc
4057: cad emulators lang news time
4058: chat finance mail parallel wm
4059: comms fonts math pkgtools www
4060: converters games mbone print x11
4061: </pre>
1.75 rillig 4062: </li>
1.128 wiz 4063: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4064: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4065: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4066: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4067: <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 4068: </ul></div>
4069: <p>The second section contains information about separately
1.87 wiz 4070: downloaded patches, if any.
4071: </p>
1.148 asau 4072: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4073: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4074: Name(s) of additional files that contain distribution patches.
4075: There is no default. pkgsrc will look for them at
4076: <code class="varname">PATCH_SITES</code>.
4077: They will automatically be uncompressed before patching if
4078: the names end with <code class="filename">.gz</code> or
4079: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4080: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4081: Primary location(s) for distribution patch files (see
4082: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4083: </ul></div>
4084: <p>The third section contains the following variables.
1.87 wiz 4085: </p>
1.148 asau 4086: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4087: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4088: address of the person who feels responsible for this package,
4089: and who is most likely to look at problems or questions regarding
1.136 dholland 4090: 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 4091: Other developers may contact the <code class="varname">MAINTAINER</code>
4092: before making changes to the package, but are not required to
4093: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4094: to yourself. If you really can't maintain the package for future
4095: updates, set it to
1.110 hubertf 4096: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4097: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4098: of <code class="varname">MAINTAINER</code> when you do not want other
4099: developers to update or change the package without contacting
4100: you first. A package Makefile should contain one of
4101: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4102: not both. </p></li>
1.128 wiz 4103: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4104: find more information about the package.</p></li>
1.128 wiz 4105: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4106: description of the package (should not include the package
4107: name).</p></li>
1.75 rillig 4108: </ul></div>
4109: <p>Other variables that affect the build:
1.87 wiz 4110: </p>
1.148 asau 4111: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4112: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4113: interesting distribution files of the package are found. The
4114: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4115: works for most packages.</p>
1.75 rillig 4116: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4117: (most GNU software does, for instance), but extracts itself in
4118: the current directory, you should set
4119: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4120: <p>If a package doesn't create a subdirectory with the
4121: name of <code class="varname">DISTNAME</code> but some different name,
4122: set <code class="varname">WRKSRC</code> to point to the proper name in
4123: <code class="filename">${WRKDIR}</code>, for example
4124: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4125: <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 4126: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4127: taken from the <code class="varname">WRKDIR_BASENAME</code>
4128: variable. By default, its value is
4129: <code class="filename">work</code>. If you want to use the same
4130: pkgsrc tree for building different kinds of binary packages,
4131: you can change the variable according to your needs. Two
4132: other variables handle common cases of setting
4133: <code class="varname">WRKDIR_BASENAME</code> individually. If
4134: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4135: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4136: the host's name is attached to the directory name. If
4137: <code class="varname">OBJMACHINE</code> is defined, the platform name
4138: is attached, which might look like
4139: <code class="filename">work.i386</code> or
4140: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4141: </li></ul></div>
4142: <p>Please pay attention to the following gotchas:</p>
1.148 asau 4143: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4144: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4145: installed in compressed form by the package. For packages using
4146: BSD-style makefiles which honor MANZ, there is
4147: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4148: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4149: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4150: below).</p></li>
1.128 wiz 4151: <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 4152: </ul></div>
4153: </div>
1.148 asau 4154: <div class="sect1">
1.75 rillig 4155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4156: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4157: </h2></div></div></div>
1.76 rillig 4158: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4159: digest, or checksum, of each distfile needed for the package. This
4160: ensures that the distfiles retrieved from the Internet have not been
4161: corrupted during transfer or altered by a malign force to introduce
4162: a security hole. Due to recent rumor about weaknesses of digest
4163: algorithms, all distfiles are protected using both SHA1 and RMD160
4164: message digests, as well as the file size.</p>
1.76 rillig 4165: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4166: checksums for all the patches found in the
1.110 hubertf 4167: <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 4168: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4169: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4170: command.</p>
1.75 rillig 4171: <p>Some packages have different sets of distfiles depending on
1.128 wiz 4172: 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 4173: <code class="filename">distinfo</code> file and care should be taken when
4174: upgrading such a package to ensure distfile information is not
4175: lost.</p>
1.75 rillig 4176: </div>
1.148 asau 4177: <div class="sect1">
1.75 rillig 4178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4179: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4180: <p>Many packages still don't work out-of-the box on the various
4181: platforms that are supported by pkgsrc. Therefore, a number of custom
4182: patch files are needed to make the package work. These patch files are
4183: found in the <code class="filename">patches/</code> directory.</p>
4184: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4185: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4186: 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 4187: order</a>.</p>
1.148 asau 4188: <div class="sect2">
1.93 rillig 4189: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4190: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4191: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4192: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4193: problems. (To force patches to apply with fuzz you can set
4194: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4195: should contain only changes for a single file, and no file should be
1.93 rillig 4196: patched by more than one patch file. This helps to keep future
4197: modifications simple.</p>
4198: <p>Each patch file is structured as follows: In the first line,
4199: there is the RCS Id of the patch itself. The second line should be
4200: empty for aesthetic reasons. After that, there should be a comment for
4201: each change that the patch does. There are a number of standard
4202: cases:</p>
1.148 asau 4203: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4204: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4205: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4206: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4207: platform and other environment (for example, the compiler) that the
4208: patch is needed for.</p></li>
4209: </ul></div>
1.130 wiz 4210: <p>In all, the patch should be commented so that any
1.93 rillig 4211: developer who knows the code of the application can make some use of
4212: the patch. Special care should be taken for the upstream developers,
4213: since we generally want that they accept our patches, so we have less
4214: work in the future.</p>
4215: </div>
1.148 asau 4216: <div class="sect2">
1.93 rillig 4217: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4218: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4219: <p>One important thing to mention is to pay attention that no RCS
4220: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4221: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4222: <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 4223: problems.</p>
1.87 wiz 4224: <p>For even more automation, we recommend using
1.110 hubertf 4225: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4226: whole set of patches. You just have to backup files before you
4227: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4228: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4229: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4230: you upgrade a package this way, you can easily compare the new
4231: set of patches with the previously existing one with
1.130 wiz 4232: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4233: are replaced by new files, so carefully check if you want to take all
4234: the changes.</p>
1.87 wiz 4235: <p>When you have finished a package, remember to generate
1.110 hubertf 4236: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4237: 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 4238: <p>When adding a patch that corrects a problem in the
4239: distfile (rather than e.g. enforcing pkgsrc's view of where
4240: man pages should go), send the patch as a bug report to the
4241: maintainer. This benefits non-pkgsrc users of the package,
4242: and usually makes it possible to remove the patch in future
4243: version.</p>
1.101 rillig 4244: <p>The file names of the patch files are usually of the form
1.130 wiz 4245: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4246: Many packages still use the previous convention
4247: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4248: but new patches should be of the form containing the filename.
4249: <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
4250: automatically.</p>
1.93 rillig 4251: </div>
1.148 asau 4252: <div class="sect2">
1.93 rillig 4253: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4254: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4255: <p>If you want to share patches between multiple packages
4256: in pkgsrc, e.g. because they use the same distfiles, set
4257: <code class="varname">PATCHDIR</code> to the path where the patch files
4258: can be found, e.g.:</p>
4259: <pre class="programlisting">
1.100 rillig 4260: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4261: </pre>
1.75 rillig 4262: <p>Patch files that are distributed by the author or other
1.87 wiz 4263: maintainers can be listed in
4264: <code class="varname">PATCHFILES</code>.</p>
4265: <p>If it is desired to store any patches that should not be
4266: committed into pkgsrc, they can be kept outside the pkgsrc
4267: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4268: directory tree there is expected to have the same
1.128 wiz 4269: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4270: patches are expected to be stored inside these dirs (also
4271: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4272: example, if you want to keep a private patch for
4273: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4274: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4275: files in the named directory are expected to be patch files,
4276: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4277: applied</em></span>.</p>
1.93 rillig 4278: </div>
1.148 asau 4279: <div class="sect2">
1.85 jmmv 4280: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4281: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4282: <p>When fixing a portability issue in the code do not use
4283: preprocessor magic to check for the current operating system nor
4284: platform. Doing so hurts portability to other platforms because
4285: the OS-specific details are not abstracted appropriately.</p>
4286: <p>The general rule to follow is: instead of checking for the
4287: operating system the application is being built on, check for the
4288: specific <span class="emphasis"><em>features</em></span> you need. For example,
4289: instead of assuming that kqueue is available under NetBSD and
4290: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4291: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4292: yes, this generally involves patching the
1.110 hubertf 4293: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4294: that prevents some OSes from adopting interfaces from other OSes
4295: (e.g. Linux implementing kqueue), something that the above checks
4296: cannot take into account.</p>
4297: <p>Of course, checking for features generally involves more
4298: work on the developer's side, but the resulting changes are
1.87 wiz 4299: cleaner and there are chances they will work on many other
1.85 jmmv 4300: platforms. Not to mention that there are higher chances of being
4301: later integrated into the mainstream sources. Remember:
4302: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4303: <p>Some typical examples:</p>
4304: <div class="table">
1.106 rillig 4305: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4306: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4307: <colgroup>
4308: <col>
4309: <col>
4310: <col>
4311: </colgroup>
4312: <thead><tr>
4313: <th>Where</th>
4314: <th>Incorrect</th>
4315: <th>Correct</th>
4316: </tr></thead>
4317: <tbody>
4318: <tr>
4319: <td>configure script</td>
4320: <td>
1.100 rillig 4321: <pre class="programlisting">
4322: case ${target_os} in
4323: netbsd*) have_kvm=yes ;;
4324: *) have_kvm=no ;;
4325: esac
4326: </pre>
1.85 jmmv 4327: </td>
4328: <td>
1.100 rillig 4329: <pre class="programlisting">
4330: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4331: </pre>
1.85 jmmv 4332: </td>
4333: </tr>
4334: <tr>
4335: <td>C source file</td>
4336: <td>
1.100 rillig 4337: <pre class="programlisting">
4338: #if defined(__NetBSD__)
4339: # include <sys/event.h>
4340: #endif
4341: </pre>
1.85 jmmv 4342: </td>
4343: <td>
1.100 rillig 4344: <pre class="programlisting">
4345: #if defined(HAVE_SYS_EVENT_H)
4346: # include <sys/event.h>
4347: #endif
4348: </pre>
1.85 jmmv 4349: </td>
4350: </tr>
4351: <tr>
4352: <td>C source file</td>
4353: <td>
1.100 rillig 4354: <pre class="programlisting">
4355: int
4356: monitor_file(...)
4357: {
4358: #if defined(__NetBSD__)
4359: int fd = kqueue();
4360: ...
4361: #else
4362: ...
4363: #endif
4364: }
4365: </pre>
1.85 jmmv 4366: </td>
4367: <td>
1.100 rillig 4368: <pre class="programlisting">
4369: int
4370: monitor_file(...)
4371: {
4372: #if defined(HAVE_KQUEUE)
4373: int fd = kqueue();
4374: ...
4375: #else
4376: ...
4377: #endif
4378: }
4379: </pre>
1.85 jmmv 4380: </td>
4381: </tr>
4382: </tbody>
1.91 rillig 4383: </table></div>
1.85 jmmv 4384: </div>
1.91 rillig 4385: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4386: 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
4387: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4388: 2</a>). It summarizes multiple details on how to make
4389: software easier to package; all the suggestions in it were
4390: collected from our experience in pkgsrc work, so they are possibly
4391: helpful when creating patches too.</p>
4392: </div>
1.148 asau 4393: <div class="sect2">
1.85 jmmv 4394: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4395: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4396: <p>Always, always, <span class="strong"><strong>always</strong></span>
4397: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4398: improvements you do to a package to the mainstream developers.
4399: This is the only way to get their attention on portability issues
4400: and to ensure that future versions can be built out-of-the box on
4401: NetBSD. Furthermore, any user that gets newer distfiles will get
4402: the fixes straight from the packaged code.</p>
1.93 rillig 4403: <p>This generally involves cleaning up the patches
4404: (because sometimes the patches that are
1.147 wiz 4405: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4406: appropriate trackers for the projects and working with the
4407: mainstream authors to accept your changes. It is
4408: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4409: the packages in pkgsrc are kept simple and thus further changes
4410: can be done without much hassle.</p>
1.130 wiz 4411: <p>When you have done this, please add a URL to the upstream
4412: bug report to the patch comment.</p>
1.85 jmmv 4413: <p>Support the idea of free software!</p>
4414: </div>
1.75 rillig 4415: </div>
1.148 asau 4416: <div class="sect1">
1.75 rillig 4417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4418: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 4419: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4420: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4421: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4422: any credits where they are due. Please bear in mind that others do not
4423: share your sense of humour (or spelling idiosyncrasies), and that others
4424: will read everything that you write here.</p></dd>
1.76 rillig 4425: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4426: <dd><p>This file governs the files that are installed on your
4427: system: all the binaries, manual pages, etc. There are other
4428: directives which may be entered in this file, to control the
4429: creation and deletion of directories, and the location of
1.110 hubertf 4430: 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 4431: information.</p></dd>
1.75 rillig 4432: </dl></div>
4433: </div>
1.148 asau 4434: <div class="sect1">
1.75 rillig 4435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4436: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 4437: <div class="sect2">
1.78 rillig 4438: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4439: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 4440: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4441: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4442: <dd>
1.136 dholland 4443: <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 4444: First time after package extraction and before files are
4445: moved in place, the second time after the files to install
4446: are moved in place. This can be used to do any custom
4447: procedures not possible with @exec commands in
1.136 dholland 4448: <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
4449: <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 4450: Please note that you can modify variables in it easily by using
4451: <code class="varname">FILES_SUBST</code> in the package's
4452: <code class="filename">Makefile</code>:</p>
4453: <pre class="programlisting">
4454: FILES_SUBST+= SOMEVAR="somevalue"
4455: </pre>
4456: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4457: <code class="filename">INSTALL</code>. By default, substitution is
4458: performed for <code class="varname">PREFIX</code>,
4459: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4460: <code class="varname">VARBASE</code>, and a few others, type
4461: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4462: complete list.</p>
4463: </dd>
1.76 rillig 4464: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4465: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4466: this script's responsibility to clean up any additional messy details
4467: around the package's installation, since all pkg_delete knows is how to
4468: delete the files created in the original distribution.
1.136 dholland 4469: 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>
4470: 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 4471: The same methods to replace variables can be used as for
4472: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4473: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4474: <dd>
4475: <p>This file is displayed after installation of the package.
1.87 wiz 4476: Useful for things like legal notices on almost-free
4477: software and hints for updating config files after
4478: installing modules for apache, PHP etc.
4479: Please note that you can modify variables in it easily by using
4480: <code class="varname">MESSAGE_SUBST</code> in the package's
4481: <code class="filename">Makefile</code>:</p>
1.75 rillig 4482: <pre class="programlisting">
1.100 rillig 4483: MESSAGE_SUBST+= SOMEVAR="somevalue"
4484: </pre>
1.128 wiz 4485: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4486: <code class="filename">MESSAGE</code>. By default, substitution is
4487: performed for <code class="varname">PKGNAME</code>,
4488: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4489: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4490: <code class="varname">X11BASE</code>,
4491: <code class="varname">PKG_SYSCONFDIR</code>,
4492: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4493: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4494: <p>You can display a different or additional files by
4495: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4496: default is <code class="filename">MESSAGE</code>, if the file
4497: exists.</p>
1.75 rillig 4498: </dd>
1.78 rillig 4499: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 4500: <dd>
4501: <p>This file is used by the alternatives framework.
4502: It creates, configures, and destroys generic wrappers used to
4503: run programs with similar interfaces.
4504: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4505: for more information.</p>
4506: <p>Each line of the file contains two filenames, first
4507: the wrapper and then the alternative provided by the package.
4508: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4509: </dd>
1.78 rillig 4510: </dl></div>
4511: </div>
1.148 asau 4512: <div class="sect2">
1.78 rillig 4513: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4514: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4515: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4516: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4517: <dd><p>This file contains arbitrary things that could
4518: also go into a <code class="filename">Makefile</code>, but its purpose is
4519: to be used by more than one package. This file should only be
4520: used when the packages that will use the file are known in
4521: advance. For other purposes it is often better to write a
4522: <code class="filename">*.mk</code> file and give it a good name that
4523: describes what it does.</p></dd>
4524: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4525: <dd><p>This file contains the dependency information
1.110 hubertf 4526: 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 4527: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4528: <dd><p>This file contains workarounds for compiler bugs
4529: and similar things. It is included automatically by the pkgsrc
4530: infrastructure, so you don't need an extra
4531: <code class="literal">.include</code> line for
4532: it.</p></dd>
4533: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4534: <dd><p>This file contains the code for the
1.110 hubertf 4535: 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 4536: selected by the user. If a package has only one or two options,
4537: it is equally acceptable to put the code directly into the
4538: <code class="filename">Makefile</code>.</p></dd>
4539: </dl></div>
4540: </div>
1.148 asau 4541: <div class="sect2">
1.78 rillig 4542: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4543: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4544: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4545: <dt><span class="term"><code class="filename">README*</code></span></dt>
4546: <dd><p>These files do not take place in the creation of
4547: a package and thus are purely informative to the package
4548: developer.</p></dd>
4549: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4550: <dd><p>This file contains things that need to be done
4551: to make the package even
4552: better.</p></dd>
1.75 rillig 4553: </dl></div>
4554: </div>
1.78 rillig 4555: </div>
1.148 asau 4556: <div class="sect1">
1.75 rillig 4557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4558: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4559: </h2></div></div></div>
1.110 hubertf 4560: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4561: unpacked into the directory denoted by
4562: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4563: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4564: directory is also used to keep various timestamp files.
4565: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4566: The default is <code class="filename">${.CURDIR}/work</code>
4567: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4568: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4569: </div>
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="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4573: </h2></div></div></div>
1.75 rillig 4574: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4575: to configuration or building, you could place these files here and use
1.110 hubertf 4576: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4577: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4578: this. Alternatively, you could simply diff the file against
4579: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4580: the creation of this file.</p>
4581: <p>If you want to share files in this way with other
4582: packages, set the <code class="varname">FILESDIR</code> variable to point
4583: to the other package's <code class="filename">files</code> directory,
4584: e.g.:</p>
4585: <pre class="programlisting">
1.100 rillig 4586: FILESDIR=${.CURDIR}/../xemacs/files
4587: </pre>
1.75 rillig 4588: </div>
4589: </div>
1.148 asau 4590: <div class="chapter">
1.75 rillig 4591: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4592: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4593: <div class="toc">
4594: <p><b>Table of Contents</b></p>
4595: <dl>
1.106 rillig 4596: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4597: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4598: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4599: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4600: <dd><dl>
4601: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4602: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4603: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4604: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4605: <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 4606: </dl></dd>
4607: </dl>
4608: </div>
1.76 rillig 4609: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4610: each of which forms a well-defined part of the pkgsrc system. Using
1.136 dholland 4611: 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 4612: like pkgsrc requires some discipline to keep the code correct and
4613: understandable.</p>
1.76 rillig 4614: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4615: programming are variables (which are actually macros) and shell
4616: commands. Among these shell commands may even be more complex ones
1.136 dholland 4617: 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 4618: as intended it is necessary to quote all variables correctly when they
4619: are used.</p>
4620: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4621: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4622: with them.</p>
1.148 asau 4623: <div class="sect1">
1.75 rillig 4624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4625: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4626: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4627: <p>When you are creating a file as a
4628: target of a rule, always write the data to a temporary file first
4629: and finally rename that file. Otherwise there might occur an error
4630: in the middle of generating the file, and when the user runs
1.136 dholland 4631: <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 4632: regenerated properly. Example:</p>
4633: <pre class="programlisting">
1.100 rillig 4634: wrong:
4635: @echo "line 1" > ${.TARGET}
4636: @echo "line 2" >> ${.TARGET}
4637: @false
4638:
4639: correct:
4640: @echo "line 1" > ${.TARGET}.tmp
4641: @echo "line 2" >> ${.TARGET}.tmp
4642: @false
4643: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4644: </pre>
1.110 hubertf 4645: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4646: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4647: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4648: correct</strong></span> gives an error message twice, as expected.</p>
1.136 dholland 4649: <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 4650: <code class="literal">${.TARGET}</code> in case of error, but this only
4651: happens when it is interrupted, for example by pressing
4652: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.136 dholland 4653: 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 4654: </li></ul></div>
4655: </div>
1.148 asau 4656: <div class="sect1">
1.97 rillig 4657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4658: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4659: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4660: can be processed using the five operators ``='', ``+='', ``?='',
1.136 dholland 4661: ``:='', 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 4662: page.</p>
4663: <p>When a variable's value is parsed from a
1.76 rillig 4664: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4665: backslash character ``\'' are handled specially. If a backslash is
4666: followed by a newline, any whitespace immediately in front of the
4667: backslash, the backslash, the newline, and any whitespace
4668: immediately behind the newline are replaced with a single space. A
4669: backslash character and an immediately following hash character are
4670: replaced with a single hash character. Otherwise, the backslash is
4671: passed as is. In a variable assignment, any hash character that is
4672: not preceded by a backslash starts a comment that continues upto the
4673: end of the logical line.</p>
4674: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4675: the only way to create a variable consisting of a single backslash
4676: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4677: <p>So far for defining variables. The other thing you can do with
4678: variables is evaluating them. A variable is evaluated when it is
4679: part of the right side of the ``:='' or the ``!='' operator, or
4680: directly before executing a shell command which the variable is part
1.136 dholland 4681: 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 4682: is, variables are not evaluated until there's no other way. The
4683: ``modifiers'' mentioned in the man page also evaluate the
4684: variable.</p>
4685: <p>Some of the modifiers split the string into words and then
4686: operate on the words, others operate on the string as a whole. When
4687: a string is split into words, it is split as you would expect
1.136 dholland 4688: 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 4689: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4690: loop does not follow the shell quoting rules but splits at sequences
4691: of whitespace.</p>
4692: <p>There are several types of variables that should be handled
4693: differently. Strings and two types of lists.</p>
1.148 asau 4694: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4695: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4696: characters. Nevertheless, you should restrict yourself to only
4697: using printable characters. Examples are
4698: <code class="varname">PREFIX</code> and
4699: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4700: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4701: are never exported to any shell command. Their elements are
4702: separated by whitespace. Therefore, the elements themselves cannot
4703: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4704: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4705: Examples are <code class="varname">DEPENDS</code> and
4706: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4707: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4708: may be exported to a shell command. Their elements can contain any
4709: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4710: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4711: <code class="varname">DISTFILES</code> and
4712: <code class="varname">MASTER_SITES</code>.</p></li>
4713: </ul></div>
1.148 asau 4714: <div class="sect2">
1.75 rillig 4715: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4716: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4717: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4718: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4719: are reserved for use by the pkgsrc infrastructure. They shall
4720: not be used by package
1.76 rillig 4721: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4722: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4723: lowercase variable names for the iteration
4724: variables.</p></li>
1.128 wiz 4725: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4726: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4727: <code class="varname">DISTFILES</code>.</p></li>
4728: </ul></div>
4729: </div>
4730: </div>
1.148 asau 4731: <div class="sect1">
1.75 rillig 4732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4733: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4734: <p>This section presents you with some code snippets you should
4735: use in your own code. If you don't find anything appropriate here,
4736: you should test your code and add it here.</p>
1.148 asau 4737: <div class="sect2">
1.75 rillig 4738: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4739: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4740: <pre class="programlisting">
1.100 rillig 4741: STRING= foo * bar `date`
4742: INT_LIST= # empty
4743: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4744: EXT_LIST= # empty
4745: ANOTHER_EXT_LIST= a=b c=d
4746:
4747: INT_LIST+= ${STRING} # 1
4748: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4749: EXT_LIST+= ${STRING:Q} # 3
4750: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4751: </pre>
1.75 rillig 4752: <p>When you add a string to an external list (example 3), it
4753: must be quoted. In all other cases, you must not add a quoting
4754: level. You must not merge internal and external lists, unless you
4755: are sure that all entries are correctly interpreted in both
4756: lists.</p>
4757: </div>
1.148 asau 4758: <div class="sect2">
1.75 rillig 4759: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4760: <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 4761: <pre class="programlisting">
1.100 rillig 4762: EXT_LIST= # empty
4763: .for i in ${INT_LIST}
4764: EXT_LIST+= ${i:Q}""
4765: .endfor
1.1 grant 4766: </pre>
1.75 rillig 4767: <p>This code converts the internal list
4768: <code class="varname">INT_LIST</code> into the external list
4769: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4770: are unquoted they must be quoted here. The reason for appending
4771: <code class="varname">""</code> is explained below.</p>
4772: </div>
1.148 asau 4773: <div class="sect2">
1.75 rillig 4774: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4775: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4776: <p>Sometimes you may want to print an arbitrary string. There
4777: are many ways to get it wrong and only few that can handle every
4778: nastiness.</p>
1.75 rillig 4779: <pre class="programlisting">
1.100 rillig 4780: STRING= foo bar < > * `date` $$HOME ' "
4781: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4782:
1.100 rillig 4783: all:
4784: echo ${STRING} # 1
4785: echo "${STRING}" # 2
4786: echo "${STRING:Q}" # 3
4787: echo ${STRING:Q} # 4
4788: echo x${STRING:Q} | sed 1s,.,, # 5
4789: printf "%s\\n" ${STRING:Q}"" # 6
4790: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4791: </pre>
1.75 rillig 4792: <p>Example 1 leads to a syntax error in the shell, as the
4793: characters are just copied.</p>
4794: <p>Example 2 leads to a syntax error too, and if you leave out
4795: the last " character from <code class="varname">${STRING}</code>,
1.136 dholland 4796: <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 4797: variable would be evaluated, too.</p>
4798: <p>Example 3 outputs each space character preceded by a
4799: backslash (or not), depending on the implementation of the
1.136 dholland 4800: <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 4801: <p>Example 4 handles correctly every string that does not start
4802: with a dash. In that case, the result depends on the
1.136 dholland 4803: 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 4804: guarantee that your input does not start with a dash, this form is
4805: appropriate.</p>
4806: <p>Example 5 handles even the case of a leading dash
4807: correctly.</p>
1.79 rillig 4808: <p>Example 6 also works with every string and is the
4809: light-weight solution, since it does not involve a pipe, which has
4810: its own problems.</p>
1.75 rillig 4811: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4812: because the quoting has already been done when adding elements to
4813: the list.</p>
4814: <p>As internal lists shall not be passed to the shell, there is
4815: no example for it.</p>
4816: </div>
1.148 asau 4817: <div class="sect2">
1.75 rillig 4818: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4819: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4820: <p>There are many possible sources of wrongly quoted variables.
4821: This section lists some of the commonly known ones.</p>
1.148 asau 4822: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4823: <li class="listitem">
1.75 rillig 4824: <p>Whenever you use the value of a list, think
4825: about what happens to leading or trailing whitespace. If the
4826: list is a well-formed shell expression, you can apply the
4827: <code class="varname">:M*</code> modifier to strip leading and trailing
4828: whitespace from each word. The <code class="varname">:M</code> operator
4829: first splits its argument according to the rules of the shell,
4830: and then creates a new list consisting of all words that match
4831: the shell glob expression <code class="varname">*</code>, that is: all.
4832: One class of situations where this is needed is when adding a
4833: variable like <code class="varname">CPPFLAGS</code> to
4834: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4835: invokes other configure scripts, it strips the leading and
4836: trailing whitespace from the variable and then passes it to the
4837: other configure scripts. But these configure scripts expect the
4838: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4839: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4840: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4841: here is how we do it:</p>
4842: <pre class="programlisting">
1.100 rillig 4843: CPPFLAGS= # empty
4844: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4845: CPPFLAGS+= ${MY_CPPFLAGS}
4846:
4847: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4848:
4849: all:
4850: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4851: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4852: </pre>
1.75 rillig 4853: </li>
1.128 wiz 4854: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 4855: <code class="varname">${PREFIX}</code> is a properly quoted shell
4856: expression, but there is the C compiler after it, which also
4857: expects a properly quoted string (this time in C syntax). The
4858: version above is therefore only correct if
4859: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4860: or double quotes. If you want to allow these, you have to add
4861: another layer of quoting to each variable that is used as a C
4862: string literal. You cannot use the <code class="varname">:Q</code>
4863: operator for it, as this operator only works for the
4864: shell.</p></li>
1.128 wiz 4865: <li class="listitem">
1.75 rillig 4866: <p>Whenever a variable can be empty, the
4867: <code class="varname">:Q</code> operator can have surprising results. Here
4868: are two completely different cases which can be solved with the
4869: same trick.</p>
4870: <pre class="programlisting">
1.100 rillig 4871: EMPTY= # empty
4872: empty_test:
4873: for i in a ${EMPTY:Q} c; do \
4874: echo "$$i"; \
4875: done
4876:
4877: for_test:
4878: .for i in a:\ a:\test.txt
4879: echo ${i:Q}
4880: echo "foo"
4881: .endfor
1.1 grant 4882: </pre>
1.75 rillig 4883: <p>The first example will only print two of the three lines
4884: we might have expected. This is because
4885: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4886: the shell cannot see. The workaround is to write
4887: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4888: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4889: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4890: <p>The second example will only print three lines instead of
4891: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4892: This is because the backslash of the value
4893: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.136 dholland 4894: <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
4895: <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 4896: <code class="varname">${i:Q}""</code>.</p>
4897: </li>
4898: </ul></div>
4899: </div>
1.148 asau 4900: <div class="sect2">
1.75 rillig 4901: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4902: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 4903: <p>The pkgsrc bmake program does not handle the following
4904: assignment correctly. In case <code class="varname">_othervar_</code>
4905: contains a ``-'' character, one of the closing braces is included
4906: in <code class="varname">${VAR}</code> after this code executes.</p>
4907: <pre class="programlisting">
1.100 rillig 4908: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 4909: </pre>
1.75 rillig 4910: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 4911: 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 4912: <code class="varname">bug1</code>.</p>
4913: </div>
4914: </div>
4915: </div>
1.148 asau 4916: <div class="chapter">
1.75 rillig 4917: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4918: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4919: <div class="toc">
4920: <p><b>Table of Contents</b></p>
4921: <dl>
1.106 rillig 4922: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4923: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4924: <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 4925: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4926: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4927: <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 4928: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
4929: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 4930: </dl>
4931: </div>
1.87 wiz 4932: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4933: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4934: the package (relative to the <code class="filename">${PREFIX}</code>
4935: directory it's been installed in) plus some additional statements
1.136 dholland 4936: - 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 4937: This chapter addresses some issues that need attention when
4938: dealing with the <code class="filename">PLIST</code> file (or files, see
4939: below!).</p>
1.148 asau 4940: <div class="sect1">
1.75 rillig 4941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4942: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4943: <p>Be sure to add a RCS ID line as the first thing in any
4944: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4945: <pre class="programlisting">
1.100 rillig 4946: @comment $NetBSD$
1.87 wiz 4947: </pre>
1.75 rillig 4948: </div>
1.148 asau 4949: <div class="sect1">
1.75 rillig 4950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4951: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4952: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4953: to output a PLIST that matches any new files since the package
1.110 hubertf 4954: 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 4955: more information on this target.</p>
1.75 rillig 4956: </div>
1.148 asau 4957: <div class="sect1">
1.75 rillig 4958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 4959: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4960: </h2></div></div></div>
1.87 wiz 4961: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 4962: <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
4963: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 4964: <code class="varname">@comment</code>s instead of real
4965: <code class="varname">@dirrm</code> lines. You can also do this for
4966: specific directories and files, so that the results of that
4967: command are very close to reality. This helps <span class="emphasis"><em>a
4968: lot</em></span> during the update of packages.</p>
4969: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4970: of AWK patterns and actions that are used to filter the output of
4971: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4972: scripting you like to it, but be careful with quoting.</p>
4973: <p>For example, to get all files inside the
4974: <code class="filename">libdata/foo</code> directory removed from the
4975: resulting PLIST:</p>
4976: <pre class="programlisting">
1.100 rillig 4977: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 4978: </pre>
4979: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4980: to a specific (shared) directory converted to
4981: <code class="varname">@comment</code>s:</p>
1.75 rillig 4982: <pre class="programlisting">
1.100 rillig 4983: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 4984: </pre>
1.75 rillig 4985: </div>
1.148 asau 4986: <div class="sect1">
1.75 rillig 4987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4988: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4989: <p>A number of variables are substituted automatically in
4990: PLISTs when a package is installed on a system. This includes the
4991: following variables:</p>
1.148 asau 4992: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4993: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4994: <dd>
4995: <p>Some packages like emacs and perl embed information
1.87 wiz 4996: about which architecture they were built on into the
4997: pathnames where they install their files. To handle this
4998: case, PLIST will be preprocessed before actually used, and
4999: the symbol
1.128 wiz 5000: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 5001: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5002: same is done if the string
5003: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5004: PLIST somewhere - use this on packages that have GNU
5005: autoconf-created configure scripts.</p>
1.148 asau 5006: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 5007: <h3 class="title">Legacy note</h3>
5008: <p>There used to be a symbol
1.128 wiz 5009: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 5010: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5011: -m</strong></span>, but that's no longer supported and has
5012: been removed.</p>
1.75 rillig 5013: </div>
5014: </dd>
5015: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5016: <dd>
5017: <p>Some packages want to embed the OS name and version
1.87 wiz 5018: into some paths. To do this, use these variables in the
5019: <code class="filename">PLIST</code>:
5020: </p>
1.148 asau 5021: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5022: <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>
5023: <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>
5024: <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 5025: </ul></div>
5026: </dd>
5027: </dl></div>
1.87 wiz 5028: <p>For a complete list of values which are replaced by
5029: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5030: search for <code class="varname">PLIST_SUBST</code>).</p>
5031: <p>If you want to change other variables not listed above, you
5032: can add variables and their expansions to this variable in the
1.110 hubertf 5033: 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 5034: <pre class="programlisting">
1.100 rillig 5035: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5036: </pre>
1.128 wiz 5037: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 5038: in the <code class="filename">PLIST</code> with
1.128 wiz 5039: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 5040: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 5041: the common case of conditionally including some
5042: <code class="filename">PLIST</code> entries. It can be done by adding
5043: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5044: setting the corresponding <code class="varname">PLIST.foo</code> variable
5045: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 5046: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 5047: in the <code class="filename">PLIST</code> with either
1.128 wiz 5048: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5049: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5050: For example, in <code class="filename">Makefile</code>:</p>
5051: <pre class="programlisting">
5052: PLIST_VARS+= foo
5053: .if <em class="replaceable"><code>condition</code></em>
5054: PLIST.foo= yes
5055: .else
5056: </pre>
5057: <p>And then in <code class="filename">PLIST</code>:</p>
5058: <pre class="programlisting">
5059: @comment $NetBSD$
5060: bin/bar
5061: man/man1/bar.1
5062: ${PLIST.foo}bin/foo
5063: ${PLIST.foo}man/man1/foo.1
5064: ${PLIST.foo}share/bar/foo.data
5065: ${PLIST.foo}@dirrm share/bar
5066: </pre>
1.75 rillig 5067: </div>
1.148 asau 5068: <div class="sect1">
1.75 rillig 5069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5070: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5071: <p>Man pages should be installed in compressed form if
1.87 wiz 5072: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5073: and uncompressed otherwise. To handle this in the
1.128 wiz 5074: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5075: appended/removed automatically for man pages according to
5076: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5077: or not, see above for details. This modification of the
5078: <code class="filename">PLIST</code> file is done on a copy of it, not
5079: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5080: </div>
1.148 asau 5081: <div class="sect1">
1.75 rillig 5082: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5083: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5084: </h2></div></div></div>
1.76 rillig 5085: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5086: in generating the binary package, set the variable
5087: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.136 dholland 5088: 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 5089: important. The default for <code class="varname">PLIST_SRC</code> is
5090: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5091: </div>
1.148 asau 5092: <div class="sect1">
1.75 rillig 5093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5094: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5095: <p>Some packages decide to install a different set of files based on
1.87 wiz 5096: the operating system being used. These differences can be
5097: automatically handled by using the following files:</p>
1.148 asau 5098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5099: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5100: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5101: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5102: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5103: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5104: </ul></div>
5105: </div>
1.148 asau 5106: <div class="sect1">
1.75 rillig 5107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5108: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5109: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5110: multiple (and unrelated) packages install files. These
1.125 wiz 5111: directories were problematic because you had to add special
5112: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5113: centralized package handle them.</p>
1.125 wiz 5114: <p>In pkgsrc, it is now easy: Each package should create
5115: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5116: will remove any directories left empty after uninstalling a
5117: package.</p>
5118: <p>If a package needs an empty directory to work, create
5119: the directory during installation as usual, and also add an
5120: entry to the PLIST:
5121: </p>
1.87 wiz 5122: <pre class="programlisting">
1.125 wiz 5123: @pkgdir path/to/empty/directory
1.87 wiz 5124: </pre>
1.125 wiz 5125: <p>
5126: </p>
1.75 rillig 5127: </div>
5128: </div>
1.148 asau 5129: <div class="chapter">
1.75 rillig 5130: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5131: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5132: <div class="toc">
5133: <p><b>Table of Contents</b></p>
5134: <dl>
1.106 rillig 5135: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5136: <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 5137: <dd><dl>
1.106 rillig 5138: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5139: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5140: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5141: and
5142: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5143: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5144: </dl></dd>
1.128 wiz 5145: <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 5146: <dd><dl>
1.128 wiz 5147: <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 5148: <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 5149: </dl></dd>
5150: </dl>
5151: </div>
5152: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5153: are seen by a package's configure and build processes. This is implemented
5154: in a two step process:</p>
1.128 wiz 5155: <div class="orderedlist"><ol class="orderedlist" type="1">
5156: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5157: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5158: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5159: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5160: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5161: <code class="option">-L${LOCALBASE}/lib</code> into references to
5162: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5163: native compiler on some operating systems look like GCC, so that
5164: packages that expect GCC won't require modifications to build with
5165: those native compilers.</p></li>
1.75 rillig 5166: </ol></div>
5167: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5168: package may be built consistently despite what other software may be
5169: installed. Please note that the normal system header and library paths,
5170: e.g. <code class="filename">/usr/include</code>,
5171: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5172: designed to insulate the package build from non-system-supplied
5173: software.</p>
1.148 asau 5174: <div class="sect1">
1.75 rillig 5175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5176: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5177: <p>The process of converting packages to use the buildlink3
1.128 wiz 5178: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5179: The things to keep in mind are:</p>
1.128 wiz 5180: <div class="orderedlist"><ol class="orderedlist" type="1">
5181: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5182: instead of the actual toolchain. Some packages are tricky,
5183: and the only way to know for sure is the check
5184: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5185: wrappers are being invoked.</p></li>
1.128 wiz 5186: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5187: the package Makefile, e.g. Java VMs, standalone shells,
5188: etc., because the code to symlink files into
5189: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5190: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5191: </p></li>
1.128 wiz 5192: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5193: <code class="filename">buildlink3.mk</code> files that you list in a
5194: package's Makefile are added as dependencies for that package.
5195: </p></li>
1.75 rillig 5196: </ol></div>
1.87 wiz 5197: <p>If a dependency on a particular package is required for its libraries and
5198: headers, then we replace:</p>
1.75 rillig 5199: <pre class="programlisting">
1.100 rillig 5200: DEPENDS+= foo>=1.1.0:../../category/foo
5201: </pre>
1.75 rillig 5202: <p>with</p>
5203: <pre class="programlisting">
1.100 rillig 5204: .include "../../category/foo/buildlink3.mk"
5205: </pre>
1.75 rillig 5206: <p>The buildlink3.mk files usually define the required dependencies.
5207: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5208: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5209: <pre class="programlisting">
1.100 rillig 5210: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5211: .include "../../category/foo/buildlink3.mk"
5212: </pre>
1.76 rillig 5213: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5214: files in <code class="filename">pkgsrc/mk</code>
5215: that handle special package issues:</p>
1.148 asau 5216: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5217: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5218: the native or a pkgsrc Berkeley DB implementation based on
5219: the values of <code class="varname">BDB_ACCEPTED</code> and
5220: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5221: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5222: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5223: 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 5224: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5225: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5226: adding a dependency on Heimdal or MIT-krb5 for packages that
5227: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5228: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5229: system-provided Motif installation or adds a dependency on
1.151 obache 5230: <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 5231: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.151 obache 5232: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5233: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5234: which Motif version will be used.</p></li>
1.161 ryoon 5235: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 5236: system-provided GNU readline or editline (libedit) installation,
1.161 ryoon 5237: 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>,
5238: <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
5239: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5240: If your package really needs GNU readline library, its Makefile
5241: should include <code class="filename">devel/readline/buildlink3.mk</code>
5242: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 5243: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5244: variables that may be used by packages that use the
5245: Open Sound System (OSS) API.</p></li>
1.128 wiz 5246: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5247: any of the Postgres versions in the variable
5248: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5249: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5250: the file for more information.</p></li>
1.128 wiz 5251: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5252: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5253: 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 5254: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5255: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5256: library.</p></li>
1.75 rillig 5257: </ul></div>
1.76 rillig 5258: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5259: files provide a more complete
5260: description of how to use them properly.</p>
1.75 rillig 5261: </div>
1.148 asau 5262: <div class="sect1">
1.75 rillig 5263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5264: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5265: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5266: included by Makefiles to indicate the need to compile and link
5267: against header files and libraries provided by the package. A
5268: <code class="filename">buildlink3.mk</code> file should always provide
5269: enough information to add the correct type of dependency
5270: relationship and include any other
5271: <code class="filename">buildlink3.mk</code> files that it needs to find
5272: headers and libraries that it needs in turn.</p>
5273: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5274: 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 5275: package is highly recommended. For most packages, the following
5276: command will generate a good starting point for
5277: <code class="filename">buildlink3.mk</code> files:</p>
5278: <pre class="screen">
5279: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5280: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5281: </pre>
1.148 asau 5282: <div class="sect2">
1.75 rillig 5283: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5284: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5285: <p>The following real-life example
1.87 wiz 5286: <code class="filename">buildlink3.mk</code> is taken
5287: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5288: <pre class="programlisting">
1.120 snj 5289: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5290:
1.120 snj 5291: BUILDLINK_TREE+= tiff
1.1 grant 5292:
1.120 snj 5293: .if !defined(TIFF_BUILDLINK3_MK)
5294: TIFF_BUILDLINK3_MK:=
1.87 wiz 5295:
1.120 snj 5296: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5297: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5298: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5299:
1.100 rillig 5300: .include "../../devel/zlib/buildlink3.mk"
5301: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5302: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5303:
1.120 snj 5304: BUILDLINK_TREE+= -tiff
1.100 rillig 5305: </pre>
1.87 wiz 5306: <p>The header and footer manipulate
1.120 snj 5307: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5308: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5309: the dependency tree.</p>
5310: <p>The main section is protected from multiple inclusion
1.87 wiz 5311: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5312: added. Several important variables are set in the section:</p>
1.148 asau 5313: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5314: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5315: is the actual dependency recorded in the installed
5316: package; this should always be set using
1.110 hubertf 5317: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5318: we're appending to any pre-existing list of values. This
5319: variable should be set to the first version of the
1.133 wiz 5320: package that had an backwards-incompatible API change.
1.87 wiz 5321: </p></li>
1.128 wiz 5322: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5323: is the location of the <em class="replaceable"><code>pkg</code></em>
5324: pkgsrc directory.</p></li>
1.128 wiz 5325: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5326: (not shown above) controls whether we use
5327: <code class="varname">BUILD_DEPENDS</code> or
5328: <code class="varname">DEPENDS</code> to add the dependency on
5329: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5330: selected by setting
5331: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5332: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5333: used.</p></li>
1.128 wiz 5334: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5335: and
5336: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5337: (not shown above) are lists of subdirectories of
1.76 rillig 5338: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5339: to add to the header and library search paths. These
1.128 wiz 5340: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5341: respectively.</p></li>
1.128 wiz 5342: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5343: (not shown above) is the list of preprocessor flags to add
5344: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5345: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5346: should be avoided and instead be handled using
5347: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5348: above.</p></li>
1.75 rillig 5349: </ul></div>
1.87 wiz 5350: <p>The following variables are all optionally defined within
5351: this second section (protected against multiple inclusion) and
5352: control which package files are symlinked into
5353: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5354: transformed during the symlinking:</p>
1.148 asau 5355: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5356: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5357: (not shown above) is a shell glob pattern relative to
1.76 rillig 5358: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5359: to be symlinked into
1.76 rillig 5360: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5361: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5362: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5363: (not shown above) is a shell pipeline that
5364: outputs to stdout a list of files relative to
5365: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5366: The resulting files are to be symlinked
5367: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5368: this takes the <code class="filename">+CONTENTS</code> of a
5369: <em class="replaceable"><code>pkg</code></em> and filters it through
5370: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5371: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5372: (not shown above) is a filter command that filters
1.76 rillig 5373: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5374: relative to
1.76 rillig 5375: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5376: on stdout. By default for overwrite packages,
5377: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5378: outputs the contents of the <code class="filename">include</code>
5379: and <code class="filename">lib</code> directories in the package
5380: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5381: it outputs any libtool archives in
1.87 wiz 5382: <code class="filename">lib</code> directories.</p></li>
1.128 wiz 5383: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5384: (not shown above) is a list of sed arguments used to
5385: transform the name of the source filename into a
1.110 hubertf 5386: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5387: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5388: </ul></div>
1.120 snj 5389: <p>This section can additionally include any
1.87 wiz 5390: <code class="filename">buildlink3.mk</code> needed for
5391: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5392: Including these <code class="filename">buildlink3.mk</code> files
5393: means that the headers and libraries for these
5394: dependencies are also symlinked into
5395: <code class="filename">${BUILDLINK_DIR}</code>
5396: whenever the <em class="replaceable"><code>pkg</code></em>
5397: <code class="filename">buildlink3.mk</code>
1.120 snj 5398: file is included. Dependencies are only added for directly
5399: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 5400: <p>When providing a <code class="filename">buildlink3.mk</code> and
5401: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 5402: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 5403: header files are automatically exposed when the package is
5404: use.</p>
5405: <p>In particular, if only an executable
5406: (<code class="filename">bin/foo</code>) is linked against a library, that
5407: library does not need to be propagated in the
5408: <code class="filename">buildlink3.mk</code> file.</p>
5409: <p>The following steps should help you decide if a
5410: <code class="filename">buildlink3.mk</code> file needs to be included:
5411: </p>
5412: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5413: <li class="listitem"><p>Look at the installed header files: What
5414: headers do they include? The packages providing these files
5415: must be buildlinked.</p></li>
1.155 wiz 5416: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5417: libraries and look against what other libraries they link.
5418: Some of the packages providing these probably need to be
5419: buildlinked; however, it's not automatic, since e.g. GTK on
5420: some systems pulls in the X libraries, so they will show up in
5421: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 5422: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 5423: used as a hint.</p></li>
1.153 wiz 5424: </ul></div>
5425: <p>
5426: </p>
1.75 rillig 5427: </div>
1.148 asau 5428: <div class="sect2">
1.75 rillig 5429: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5430: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5431: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5432: and
5433: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5434: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5435: <p>These two variables differ in that one describes source
5436: compatibility (API) and the other binary compatibility (ABI).
5437: The difference is that a change in the API breaks compilation of
5438: programs while changes in the ABI stop compiled programs from
5439: running.</p>
5440: <p>Changes to the
1.134 wiz 5441: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5442: variable in a <code class="filename">buildlink3.mk</code> file happen
5443: very rarely. One possible reason is that all packages depending
5444: on this already need a newer version. In case it is bumped see
5445: the description below.</p>
5446: <p>The most common example of an ABI change is that the major
5447: version of a shared library is increased. In this case,
5448: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5449: should be adjusted to require at least the new package version.
5450: Then the packages that depend on this package need their
5451: <code class="varname">PKGREVISION</code>s increased and, if they have
5452: <code class="filename">buildlink3.mk</code> files, their
5453: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5454: adjusted, too. This is needed so pkgsrc will require the correct
5455: package dependency and not settle for an older one when building
5456: the source.</p>
1.110 hubertf 5457: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5458: more information about dependencies on other packages,
5459: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5460: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5461: <p>Please take careful consideration before adjusting
5462: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5463: or
5464: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5465: as we don't want to cause unneeded package deletions and
5466: rebuilds. In many cases, new versions of packages work just
5467: fine with older dependencies.</p>
5468: <p>Also it is not needed to set
1.133 wiz 5469: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5470: when it is identical to
1.87 wiz 5471: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5472: </div>
5473: </div>
1.148 asau 5474: <div class="sect1">
1.75 rillig 5475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5476: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5477: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5478: coincide with headers and libraries present in the base system.
1.76 rillig 5479: Aside from a <code class="filename">buildlink3.mk</code> file, these
5480: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5481: file that includes the necessary checks to decide whether using
5482: the built-in software or the pkgsrc software is
1.87 wiz 5483: appropriate.</p>
5484: <p>The only requirements of a builtin.mk file for
5485: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5486: <div class="orderedlist"><ol class="orderedlist" type="1">
5487: <li class="listitem"><p>It should set
1.87 wiz 5488: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5489: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5490: after it is included.</p></li>
1.128 wiz 5491: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5492: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5493: which is already set before the
5494: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5495: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5496: is <span class="emphasis"><em>very</em></span> important and takes careful
5497: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5498: </ol></div>
1.148 asau 5499: <div class="sect2">
1.75 rillig 5500: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5501: <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 5502: <p>The following is the recommended template for builtin.mk
1.87 wiz 5503: files:</p>
1.75 rillig 5504: <pre class="programlisting">
1.100 rillig 5505: .if !defined(IS_BUILTIN.foo)
5506: #
5507: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5508: # genuinely exists in the system or not.
5509: #
5510: IS_BUILTIN.foo?= no
5511:
5512: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5513: # version can be determined.
5514: #
5515: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5516: BUILTIN_PKG.foo?= foo-1.0
5517: . endif
5518: .endif # IS_BUILTIN.foo
5519:
5520: .if !defined(USE_BUILTIN.foo)
5521: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5522: . if defined(BUILTIN_PKG.foo)
5523: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5524: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5525: USE_BUILTIN.foo!= \
5526: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5527: && ${ECHO} "yes" || ${ECHO} "no"
5528: . endif
5529: . endfor
5530: . endif
5531: .endif # USE_BUILTIN.foo
5532:
5533: CHECK_BUILTIN.foo?= no
5534: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5535: #
5536: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5537: # "yes" or "no".
5538: #
5539: .endif # CHECK_BUILTIN.foo
5540: </pre>
1.87 wiz 5541: <p>The first section sets
5542: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5543: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5544: in the base system. This should not be a base system software
5545: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5546: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5547: included as part of the base system. This variable is only
5548: used internally within the <code class="filename">builtin.mk</code>
5549: file.</p>
5550: <p>The second section sets
5551: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5552: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5553: system if it exists (if
5554: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5555: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5556: within the <code class="filename">builtin.mk</code> file.</p>
5557: <p>The third section sets
5558: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5559: and is <span class="emphasis"><em>required</em></span> in all
5560: <code class="filename">builtin.mk</code> files. The code in this
5561: section must make the determination whether the built-in
5562: software is adequate to satisfy the dependencies listed in
5563: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5564: This is typically done by comparing
5565: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5566: against each of the dependencies in
5567: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5568: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5569: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5570: end of the <code class="filename">builtin.mk</code> file. Note that
5571: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5572: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5573: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5574: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5575: that the built-in version of the software is similar enough to
5576: be used as a replacement.</p>
5577: <p>The last section is guarded by
5578: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5579: and includes code that uses the value of
5580: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5581: set in the previous section. This typically includes, e.g.,
5582: adding additional dependency restrictions and listing additional
5583: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5584: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5585: </div>
1.148 asau 5586: <div class="sect2">
1.75 rillig 5587: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5588: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5589: <p>When building packages, it's possible to choose whether to set
5590: a global preference for using either the built-in (native)
5591: version or the pkgsrc version of software to satisfy a
5592: dependency. This is controlled by setting
5593: <code class="varname">PREFER_PKGSRC</code> and
5594: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5595: 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 5596: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5597: use the pkgsrc versions of software, while
5598: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5599: built-in versions. Preferences are determined by the most
5600: specific instance of the package in either
5601: <code class="varname">PREFER_PKGSRC</code> or
5602: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5603: in neither or in both variables, then
5604: <code class="varname">PREFER_PKGSRC</code> has precedence over
5605: <code class="varname">PREFER_NATIVE</code>. For example, to require
5606: using pkgsrc versions of software for all but the most basic
5607: bits on a NetBSD system, you can set:</p>
5608: <pre class="programlisting">
1.100 rillig 5609: PREFER_PKGSRC= yes
5610: PREFER_NATIVE= getopt skey tcp_wrappers
5611: </pre>
1.87 wiz 5612: <p>A package <span class="emphasis"><em>must</em></span> have a
5613: <code class="filename">builtin.mk</code>
5614: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5615: otherwise it is simply ignored in that list.</p>
1.75 rillig 5616: </div>
5617: </div>
5618: </div>
1.148 asau 5619: <div class="chapter">
1.75 rillig 5620: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5621: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5622: <div class="toc">
5623: <p><b>Table of Contents</b></p>
5624: <dl>
1.106 rillig 5625: <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 5626: <dd><dl>
1.106 rillig 5627: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5628: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5629: </dl></dd>
1.106 rillig 5630: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5631: <dd><dl>
1.128 wiz 5632: <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 5633: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5634: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5635: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5636: </dl></dd>
5637: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5638: <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>
5639: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5640: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5641: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5642: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5643: <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 5644: </dl>
5645: </div>
5646: <p>This chapter describes the framework known as
5647: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5648: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5649: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5650: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5651: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5652: provided that packages are correctly designed.</p></li>
1.128 wiz 5653: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5654: <li class="listitem"><p>Registration of system users and groups.</p></li>
5655: <li class="listitem"><p>Registration of system shells.</p></li>
5656: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5657: </ul></div>
5658: <p>The following sections inspect each of the above points in detail.</p>
5659: <p>You may be thinking that many of the things described here could be
5660: easily done with simple code in the package's post-installation target
5661: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5662: as the code in them is only executed when building from source. Machines
5663: using binary packages could not benefit from it at all (as the code itself
5664: could be unavailable). Therefore, the only way to achieve any of the items
5665: described above is by means of the installation scripts, which are
5666: automatically generated by pkginstall.</p>
1.148 asau 5667: <div class="sect1">
1.75 rillig 5668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5669: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5670: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5671: of files and directories that belong to a package. The names used in it
1.76 rillig 5672: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5673: which means that it cannot register files outside this directory (absolute
5674: path names are not allowed). Despite this restriction, some packages need
5675: to install files outside this location; e.g., under
1.76 rillig 5676: <code class="filename">${VARBASE}</code> or
1.87 wiz 5677: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5678: is to create such files during installation time by using
5679: installation scripts.</p>
5680: <p>The generic installation scripts are shell scripts that can
5681: contain arbitrary code. The list of scripts to execute is taken from
5682: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5683: <code class="filename">INSTALL</code>. A similar variable exists for package
5684: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5685: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5686: commands, so they have the potential to create and manage files
5687: anywhere in the file system.</p>
5688: <p>Using these general installation files is not recommended, but
5689: may be needed in some special cases. One reason for avoiding them is
5690: that the user has to trust the packager that there is no unwanted or
5691: simply erroneous code included in the installation script. Also,
5692: previously there were many similar scripts for the same functionality,
5693: and fixing a common error involved finding and changing all of
5694: them.</p>
5695: <p>The pkginstall framework offers another, standardized way. It
5696: provides generic scripts to abstract the manipulation of such files
5697: and directories based on variables set in the package's
5698: <code class="filename">Makefile</code>. The rest of this section describes
5699: these variables.</p>
1.148 asau 5700: <div class="sect2">
1.75 rillig 5701: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5702: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5703: <p>The following variables can be set to request the creation of
5704: directories anywhere in the file system:</p>
1.148 asau 5705: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5706: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5707: contain a list of directories that should be created and should attempt
5708: to be destroyed by the installation scripts. The difference between
5709: the two is that the latter prompts the administrator to remove any
5710: directories that may be left after deinstallation (because they were
5711: not empty), while the former does not.</p></li>
1.128 wiz 5712: <li class="listitem">
1.75 rillig 5713: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5714: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5715: which directories should be created and should attempt to be destroyed
5716: by the installation scripts. Each tuple holds the following values,
5717: separated by spaces: the directory name, its owner, its group and its
5718: numerical mode. For example:</p>
5719: <pre class="programlisting">
1.100 rillig 5720: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5721: </pre>
1.75 rillig 5722: <p>The difference between the two is exactly the same as their
5723: non-<code class="varname">PERMS</code> counterparts.</p>
5724: </li>
5725: </ul></div>
5726: </div>
1.148 asau 5727: <div class="sect2">
1.75 rillig 5728: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5729: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5730: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5731: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5732: To overcome this problem, the only solution is to extract the file in the
5733: known place (i.e., inside the installation prefix) and copy it to the
5734: appropriate location during installation (done by the installation scripts
5735: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5736: file</em></span> in the following paragraphs, which describe the variables
5737: that can be used to automatically and consistently handle files outside the
5738: installation prefix:</p>
1.148 asau 5739: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5740: <li class="listitem">
1.75 rillig 5741: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5742: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5743: During installation time, the master file is copied to the target one
5744: if and only if the latter does not exist. Upon deinstallation, the
5745: target file is removed provided that it was not modified by the
5746: installation.</p>
5747: <p>The difference between the two is that the latter prompts the
5748: administrator to remove any files that may be left after
5749: deinstallation (because they were not empty), while the former does
5750: not.</p>
5751: </li>
1.128 wiz 5752: <li class="listitem">
1.75 rillig 5753: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5754: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5755: files as well as their target locations. For each of them, it also
5756: specifies their owner, their group and their numeric permissions, in
5757: this order. For example:</p>
5758: <pre class="programlisting">
1.137 wiz 5759: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5760: </pre>
1.75 rillig 5761: <p>The difference between the two is exactly the same as their
5762: non-<code class="varname">PERMS</code> counterparts.</p>
5763: </li>
5764: </ul></div>
5765: </div>
5766: </div>
1.148 asau 5767: <div class="sect1">
1.75 rillig 5768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5769: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5770: <p>Configuration files are special in the sense that they are installed
5771: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5772: need special treatment during installation (most of which is automated by
5773: pkginstall). The main concept you must bear in mind is that files marked
5774: as configuration files are automatically copied to the right place (somewhere
5775: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5776: and only if</em></span> they didn't exist before. Similarly, they will not
5777: be removed if they have local modifications. This ensures that
5778: administrators never lose any custom changes they may have made.</p>
1.148 asau 5779: <div class="sect2">
1.75 rillig 5780: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5781: <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 5782: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5783: specifies where configuration files shall be installed. Its contents are
5784: set based upon the following variables:</p>
1.148 asau 5785: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5786: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5787: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5788: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5789: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5790: Packages must not use it directly.</p></li>
1.128 wiz 5791: <li class="listitem">
1.75 rillig 5792: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5793: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5794: for the package being built shall be installed. The definition of this
5795: variable only makes sense in the package's
1.76 rillig 5796: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5797: <p>As an example, consider the Apache package,
1.177 joerg 5798: <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 5799: configuration files under the
1.76 rillig 5800: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5801: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5802: Makefile.</p>
5803: </li>
1.128 wiz 5804: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5805: variable that holds this package's configuration directory (if
5806: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5807: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5808: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5809: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5810: directory where the configuration files for the package identified by
5811: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5812: </ul></div>
5813: <p>Based on the above variables, pkginstall determines the value of
5814: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5815: variable that can be used within a package to refer to its configuration
5816: directory. The algorithm used to set its value is basically the
5817: following:</p>
1.128 wiz 5818: <div class="orderedlist"><ol class="orderedlist" type="1">
5819: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5820: its value is used.</p></li>
1.128 wiz 5821: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5822: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5823: <code class="filename">Makefile</code>, the resulting value is
5824: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5825: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5826: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5827: </ol></div>
1.76 rillig 5828: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5829: 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
5830: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5831: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5832: </div>
1.148 asau 5833: <div class="sect2">
1.75 rillig 5834: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5835: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5836: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5837: known place, you need to teach each package where it shall install its
5838: files. In some cases you will have to patch the package Makefiles to
5839: achieve it. If you are lucky, though, it may be as easy as passing an
5840: extra flag to the configuration script; this is the case of GNU Autoconf-
5841: generated files:</p>
5842: <pre class="programlisting">
1.100 rillig 5843: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5844: </pre>
1.75 rillig 5845: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5846: for</em></span> its configuration files, not where they will be originally
5847: installed (although the difference is never explicit,
5848: unfortunately).</p>
5849: </div>
1.148 asau 5850: <div class="sect2">
1.75 rillig 5851: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5852: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5853: <p>As said before, pkginstall automatically handles configuration files.
5854: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5855: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5856: directly</strong></span>. Bad news is that many software installation scripts
5857: will, out of the box, mess with the contents of that directory. So what is
5858: the correct procedure to fix this issue?</p>
5859: <p>You must teach the package (usually by manually patching it) to
5860: install any configuration files under the examples hierarchy,
1.76 rillig 5861: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5862: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5863: has the original copies available.</p>
5864: <p>Once the required configuration files are in place (i.e., under the
5865: examples hierarchy), the pkginstall framework can use them as master copies
5866: during the package installation to update what is in
1.76 rillig 5867: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5868: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5869: 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 5870: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 5871: <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 5872: <pre class="programlisting">
1.100 rillig 5873: EGDIR= ${PREFIX}/share/doc/mutt/samples
5874: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5875: </pre>
1.75 rillig 5876: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5877: package and has no meaning outside it.</p>
5878: </div>
1.148 asau 5879: <div class="sect2">
1.75 rillig 5880: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5881: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5882: <p>The automatic copying of config files can be toggled by setting the
5883: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5884: installation.</p>
5885: </div>
5886: </div>
1.148 asau 5887: <div class="sect1">
1.75 rillig 5888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5889: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5890: <p>System startup scripts are special files because they must be
5891: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5892: 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 5893: can be used. However, pkginstall provides a special mechanism to handle
5894: these files.</p>
5895: <p>In order to provide system startup scripts, the package has
5896: to:</p>
1.128 wiz 5897: <div class="orderedlist"><ol class="orderedlist" type="1">
5898: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5899: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 5900: <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 5901: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5902: <li class="listitem">
1.75 rillig 5903: <p>Tell pkginstall to handle it, appending the name of the script,
5904: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5905: Continuing the previous example:</p>
5906: <pre class="programlisting">
1.100 rillig 5907: RCD_SCRIPTS+= cupsd
1.1 grant 5908: </pre>
1.75 rillig 5909: </li>
5910: </ol></div>
5911: <p>Once this is done, pkginstall will do the following steps for each
5912: script in an automated fashion:</p>
1.128 wiz 5913: <div class="orderedlist"><ol class="orderedlist" type="1">
5914: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5915: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5916: variable.</p></li>
1.128 wiz 5917: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5918: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5919: that this master file must be explicitly registered in the
1.76 rillig 5920: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5921: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5922: from the examples hierarchy into the system-wide startup scripts
5923: directory.</p></li>
5924: </ol></div>
1.148 asau 5925: <div class="sect2">
1.75 rillig 5926: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5927: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5928: <p>The automatic copying of config files can be toggled by setting the
5929: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5930: installation. Note that the scripts will be always copied inside the
1.76 rillig 5931: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5932: matter what the value of this variable is.</p>
5933: </div>
5934: </div>
1.148 asau 5935: <div class="sect1">
1.75 rillig 5936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5937: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5938: <p>If a package needs to create special users and/or groups during
5939: installation, it can do so by using the pkginstall framework.</p>
5940: <p>Users can be created by adding entries to the
5941: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5942: syntax:</p>
5943: <pre class="programlisting">
1.100 rillig 5944: user:group
1.1 grant 5945: </pre>
1.87 wiz 5946: <p>Further specification of user details may be done by setting
5947: per-user variables.
5948: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5949: numeric UID for the user.
5950: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5951: user's description or comment.
5952: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5953: user's home directory, and defaults to
5954: <code class="filename">/nonexistent</code> if not specified.
5955: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5956: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5957: not specified.</p>
1.75 rillig 5958: <p>Similarly, groups can be created by adding entries to the
5959: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5960: <pre class="programlisting">
1.100 rillig 5961: group
1.1 grant 5962: </pre>
1.93 rillig 5963: <p>The numeric GID of the group may be set by defining
1.75 rillig 5964: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5965: <p>If a package needs to create the users and groups at an earlier
5966: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5967: either <code class="literal">configure</code> or <code class="literal">build</code> to
5968: indicate the phase before which the users and groups are created. In
5969: this case, the numeric UIDs and GIDs of the created users and groups
5970: are automatically hardcoded into the final installation scripts.</p>
5971: </div>
1.148 asau 5972: <div class="sect1">
1.75 rillig 5973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5974: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5975: <p>Packages that install system shells should register them in the shell
1.76 rillig 5976: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5977: administrator. This must be done from the installation scripts to keep
5978: binary packages working on any system. pkginstall provides an easy way to
5979: accomplish this task.</p>
5980: <p>When a package provides a shell interpreter, it has to set the
5981: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5982: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 5983: 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 5984: <pre class="programlisting">
1.100 rillig 5985: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5986: </pre>
1.148 asau 5987: <div class="sect2">
1.75 rillig 5988: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5989: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5990: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5991: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5992: environment variable to <code class="literal">NO</code>.</p>
5993: </div>
5994: </div>
1.148 asau 5995: <div class="sect1">
1.75 rillig 5996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5997: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5998: <p>Packages that install X11 fonts should update the database files
5999: that index the fonts within each fonts directory. This can easily be
6000: accomplished within the pkginstall framework.</p>
6001: <p>When a package installs X11 fonts, it must list the directories in
6002: which fonts are installed in the
6003: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 6004: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
6005: <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 6006: installation scripts to run the appropriate commands to update the fonts
6007: database files within each of those directories. For convenience, if the
6008: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6009: 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 6010: <pre class="programlisting">
1.175 wiz 6011: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 6012: </pre>
1.148 asau 6013: <div class="sect2">
1.75 rillig 6014: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6015: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6016: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6017: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6018: environment variable to <code class="literal">NO</code>.</p>
6019: </div>
6020: </div>
6021: </div>
1.148 asau 6022: <div class="chapter">
1.75 rillig 6023: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6024: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6025: <div class="toc">
6026: <p><b>Table of Contents</b></p>
6027: <dl>
1.106 rillig 6028: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 6029: <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 6030: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6031: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6032: </dl>
6033: </div>
6034: <p>Many packages have the ability to be built to support different
1.76 rillig 6035: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6036: in pkgsrc that provides generic handling of those options that
6037: determine different ways in which the packages can be built. It's
6038: possible for the user to specify exactly which sets of options will be
6039: built into a package or to allow a set of global default options
6040: apply.</p>
1.107 rillig 6041: <p>There are two broad classes of behaviors that one might want to
6042: control via options. One is whether some particular feature is
6043: enabled in a program that will be built anyway, often by including or
6044: not including a dependency on some other package. The other is
6045: whether or not an additional program will be built as part of the
6046: package. Generally, it is better to make a split package for such
6047: additional programs instead of using options, because it enables
6048: binary packages to be built which can then be added separately. For
6049: example, the foo package might have minimal dependencies (those
6050: packages without which foo doesn't make sense), and then the foo-gfoo
6051: package might include the GTK frontend program gfoo. This is better
6052: than including a gtk option to foo that adds gfoo, because either that
6053: option is default, in which case binary users can't get foo without
6054: gfoo, or not default, in which case they can't get gfoo. With split
6055: packages, they can install foo without having GTK, and later decide to
6056: install gfoo (pulling in GTK at that time). This is an advantage to
6057: source users too, avoiding the need for rebuilds.</p>
6058: <p>Plugins with widely varying dependencies should usually be split
6059: instead of options.</p>
6060: <p>It is often more work to maintain split packages, especially if
6061: the upstream package does not support this. The decision of split
6062: vs. option should be made based on the likelihood that users will want
6063: or object to the various pieces, the size of the dependencies that are
6064: included, and the amount of work.</p>
6065: <p>A further consideration is licensing. Non-free parts, or parts
6066: that depend on non-free dependencies (especially plugins) should
6067: almost always be split if feasible.</p>
1.148 asau 6068: <div class="sect1">
1.75 rillig 6069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6070: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6071: <p>Global default options are listed in
6072: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6073: that should be built into every package if that option is supported.
1.110 hubertf 6074: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6075: </div>
1.148 asau 6076: <div class="sect1">
1.75 rillig 6077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6078: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6079: </h2></div></div></div>
1.75 rillig 6080: <p>The following example shows how
1.76 rillig 6081: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6082: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6083: <code class="filename">Makefile</code>, or in a file,
6084: e.g. <code class="filename">options.mk</code>, that is included by the
6085: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6086: <pre class="programlisting">
1.100 rillig 6087: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6088: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6089: PKG_OPTIONS_OPTIONAL_GROUPS= database
6090: PKG_OPTIONS_GROUP.database= mysql pgsql
6091: PKG_SUGGESTED_OPTIONS= wibble-foo
6092: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6093: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6094:
6095: .include "../../mk/bsd.prefs.mk"
6096:
6097: # this package was previously named wibble2
6098: .if defined(PKG_OPTIONS.wibble2)
6099: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6100: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6101: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6102: .endif
6103:
6104: .include "../../mk/bsd.options.mk"
6105:
6106: # Package-specific option-handling
6107:
6108: ###
6109: ### FOO support
6110: ###
6111: .if !empty(PKG_OPTIONS:Mwibble-foo)
6112: CONFIGURE_ARGS+= --enable-foo
6113: .endif
6114:
6115: ###
6116: ### LDAP support
6117: ###
6118: .if !empty(PKG_OPTIONS:Mldap)
6119: . include "../../databases/openldap-client/buildlink3.mk"
6120: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6121: .endif
6122:
6123: ###
6124: ### database support
6125: ###
6126: .if !empty(PKG_OPTIONS:Mmysql)
6127: . include "../../mk/mysql.buildlink3.mk"
6128: .endif
6129: .if !empty(PKG_OPTIONS:Mpgsql)
6130: . include "../../mk/pgsql.buildlink3.mk"
6131: .endif
1.75 rillig 6132: </pre>
6133: <p>The first section contains the information about which build
6134: options are supported by the package, and any default options settings
6135: if needed.</p>
1.128 wiz 6136: <div class="orderedlist"><ol class="orderedlist" type="1">
6137: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.136 dholland 6138: <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 6139: options. It should be set to
1.78 rillig 6140: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6141: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6142: at the point where the options are processed.</p></li>
1.128 wiz 6143: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6144: build options supported by the package.</p></li>
1.128 wiz 6145: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6146: list of names of groups of mutually exclusive options. The options in
6147: each group are listed in
6148: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6149: The most specific setting of any option from the group takes
6150: precedence over all other options in the group. Options from the
6151: groups will be automatically added to
6152: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6153: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6154: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6155: packages will fail if no option from the group is
6156: selected.</p></li>
1.128 wiz 6157: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6158: of names of sets of options. At least one option from each set must
6159: be selected. The options in each set are listed in
6160: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6161: Options from the sets will be automatically added to
6162: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6163: fail if no option from the set is selected.</p></li>
1.128 wiz 6164: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6165: build options which are enabled by default.</p></li>
1.128 wiz 6166: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6167: of
1.128 wiz 6168: <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 6169: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6170: their option counterparts. Pairs should be added with
1.128 wiz 6171: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6172: warning will be issued if the user uses a legacy
6173: variable.</p></li>
1.128 wiz 6174: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6175: of
1.128 wiz 6176: <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 6177: pairs that map options that have been renamed to their new
1.128 wiz 6178: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6179: the listing of global legacy options. A warning will be issued if
6180: the user uses a legacy option.</p></li>
1.128 wiz 6181: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6182: options implied by deprecated variables used. This can be used for
6183: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6184: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6185: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6186: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6187: a list of warnings about deprecated variables or options used, and
6188: what to use instead.</p></li>
6189: </ol></div>
6190: <p>A package should never modify
6191: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6192: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6193: To suggest a default set of options, use
6194: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6195: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6196: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6197: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6198: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6199: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6200: happen with platform-specific options if none of them is supported on
6201: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6202: empty list and the package is otherwise treated as not using the
6203: options framework.</p>
1.76 rillig 6204: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6205: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6206: build options, properly filtered to remove unsupported and duplicate
6207: options.</p>
6208: <p>The remaining sections contain the logic that is specific to
6209: each option. The correct way to check for an option is to check
6210: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6211: <pre class="programlisting">
1.100 rillig 6212: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6213: </pre>
6214: </div>
1.148 asau 6215: <div class="sect1">
1.75 rillig 6216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6217: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6218: <p>Options that enable similar features in different packages (like
6219: optional support for a library) should use a common name in all
6220: packages that support it (like the name of the library). If another
6221: package already has an option with the same meaning, use the same
6222: name.</p>
6223: <p>Options that enable features specific to one package, where it's
6224: unlikely that another (unrelated) package has the same (or a similar)
6225: optional feature, should use a name prefixed with
6226: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6227: <p>If a group of related packages share an optional feature
6228: specific to that group, prefix it with the name of the
1.128 wiz 6229: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6230: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6231: <p>For new options, add a line to
1.76 rillig 6232: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6233: fields, separated by tab. The first field is the option name, the
6234: second its description. The description should be a whole sentence
6235: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6236: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6237: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6238: </div>
1.148 asau 6239: <div class="sect1">
1.107 rillig 6240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6241: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6242: <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 6243: different dependencies based on the options with which the package was
6244: built. For querying these options, the file
6245: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6246: typical example looks like this:</p>
6247: <pre class="programlisting">
6248: pkgbase := libpurple
6249: .include "../../mk/pkg-build-options.mk"
6250:
6251: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6252: ...
6253: .endif
6254: </pre>
6255: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6256: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6257: options of the libpurple package, which can then be queried like
6258: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6259: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6260: details.</p>
6261: </div>
1.75 rillig 6262: </div>
1.148 asau 6263: <div class="chapter">
1.75 rillig 6264: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6265: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6266: <div class="toc">
6267: <p><b>Table of Contents</b></p>
6268: <dl>
1.106 rillig 6269: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6270: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6271: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6272: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6273: <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 6274: <dd><dl>
6275: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6276: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6277: </dl></dd>
1.128 wiz 6278: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6279: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6280: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6281: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6282: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6283: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6284: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6285: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6286: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6287: <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 6288: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6289: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6290: </dl>
6291: </div>
1.148 asau 6292: <div class="sect1">
1.75 rillig 6293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6294: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6295: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6296: built. Building a package is separated into different
6297: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6298: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6299: described in the following sections. Each phase is split into
1.87 wiz 6300: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6301: containing phase, prefixed by one of <code class="varname">pre-</code>,
6302: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6303: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6304: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6305: <p>Never override the regular targets (like
6306: <code class="varname">fetch</code>), if you have to, override the
6307: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6308: <p>The basic steps for building a program are always the same. First
1.87 wiz 6309: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6310: the local system and then extracted. After any pkgsrc-specific patches
6311: to compile properly are applied, the software can be configured, then
6312: built (usually by compiling), and finally the generated binaries, etc.
6313: can be put into place on the system.</p>
1.97 rillig 6314: <p>To get more details about what is happening at each step,
6315: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6316: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6317: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6318: </div>
1.148 asau 6319: <div class="sect1">
1.75 rillig 6320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6321: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6322: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6323: the next section, here's a brief discussion on where programs are
6324: installed, and which variables influence this.</p>
1.75 rillig 6325: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6326: where all files of the final program shall be installed. It is
6327: usually set to <code class="varname">LOCALBASE</code>
6328: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6329: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6330: <code class="varname">PREFIX</code> needs to be put
6331: into the various places in the program's source where paths to
1.110 hubertf 6332: 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 6333: <p>When choosing which of these variables to use,
1.87 wiz 6334: follow the following rules:</p>
1.148 asau 6335: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6336: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6337: where the current pkg will be installed. When referring to a
6338: pkg's own installation path, use
1.128 wiz 6339: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6340: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6341: are installed. If you need to construct a -I or -L argument
6342: to the compiler to find includes and libraries installed by
1.128 wiz 6343: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6344: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6345: installed all packages in <code class="filename">/usr/local</code>. As
6346: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6347: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6348: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6349: distribution (from xsrc, etc.) is installed. When looking for
6350: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6351: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6352: <li class="listitem">
1.88 wiz 6353: <p>X11-based packages are special in that they may be
6354: installed in either <code class="varname">X11BASE</code> or
6355: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6356: <p>Usually, X11 packages should be installed under
1.88 wiz 6357: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6358: will need to include
6359: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6360: request the presence of X11 and to get the right compilation
6361: flags.</p>
1.75 rillig 6362: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6363: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6364: files. These packages are special and they must be placed under
6365: <code class="varname">X11BASE</code>. To accomplish this, set either
6366: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6367: your package.</p>
1.75 rillig 6368: <p>Some notes: If you need
1.87 wiz 6369: to find includes or libraries installed by a pkg that has
6370: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6371: its pkg <code class="filename">Makefile</code>, you need to look in
6372: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6373: <code class="filename">${LOCALBASE}</code>. To force installation of
6374: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6375: <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 6376: is enabled by default.</p>
1.75 rillig 6377: </li>
1.128 wiz 6378: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6379: the installed location of an X11
6380: package. <code class="varname">X11PREFIX</code> will be set to
6381: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6382: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6383: installed.</p></li>
1.128 wiz 6384: <li class="listitem">
1.88 wiz 6385: <p>If xpkgwedge is installed, it is possible to have some
6386: packages installed in <code class="varname">X11BASE</code> and some in
6387: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6388: installed package, the <code class="varname">EVAL_PREFIX</code>
6389: definition can be used. It takes pairs in the format
1.136 dholland 6390: <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 6391: variable <code class="varname">DIRNAME</code> will be set to the prefix
6392: of the installed package <package>, or
1.128 wiz 6393: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6394: installed.</p>
1.75 rillig 6395: <p>This is best illustrated by example.</p>
6396: <p>The following lines are taken from
1.87 wiz 6397: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6398: <pre class="programlisting">
1.100 rillig 6399: EVAL_PREFIX+= GTKDIR=gtk+
6400: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6401: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6402: CONFIGURE_ARGS+= --enable-multibyte
6403: </pre>
1.88 wiz 6404: <p>Specific defaults can be defined for the packages
6405: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6406: definition of the form:</p>
1.75 rillig 6407: <pre class="programlisting">
1.100 rillig 6408: GTKDIR_DEFAULT= ${LOCALBASE}
6409: </pre>
1.75 rillig 6410: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6411: to the first definition in
6412: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6413: </li>
1.128 wiz 6414: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.136 dholland 6415: 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 6416: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6417: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6418: </ul></div>
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.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6423: <p>When building a package, various directories are used to store
1.87 wiz 6424: source files, temporary files, pkgsrc-internal files, and so on. These
6425: directories are explained here.</p>
1.75 rillig 6426: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6427: are two common base directories for these relative directories:
6428: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6429: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6430: inside the package itself.</p>
1.148 asau 6431: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6432: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6433: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6434: root directory. Generally, you don't need
6435: it.</p></dd>
1.97 rillig 6436: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6437: <dd><p>This is an absolute pathname that points to the
6438: current package.</p></dd>
1.75 rillig 6439: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6440: <dd><p>This is a pathname relative to
1.87 wiz 6441: <code class="varname">PKGSRCDIR</code> that points to the current
6442: package.</p></dd>
1.75 rillig 6443: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6444: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6445: where all work takes place. The distfiles are extracted to this
1.87 wiz 6446: directory. It also contains temporary directories and log files used by
6447: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6448: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6449: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6450: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6451: where the distfiles are extracted. It is usually a direct subdirectory
6452: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6453: that isn't hidden. This variable may be changed by a package
6454: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6455: </dl></div>
1.114 jmcneill 6456: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6457: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6458: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6459: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6460: If users would like to have their pkgsrc trees behave in a
6461: read-only manner, then the value of
6462: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6463: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6464: </div>
1.148 asau 6465: <div class="sect1">
1.75 rillig 6466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6467: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6468: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6469: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6470: phase. This will automatically run all phases that are required for this
6471: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6472: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6473: the package will be built, but not installed.</p>
1.75 rillig 6474: </div>
1.148 asau 6475: <div class="sect1">
1.75 rillig 6476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6477: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6478: <p>The first step in building a package is to fetch the
1.88 wiz 6479: distribution files (distfiles) from the sites that are providing
6480: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6481: phase.</p>
1.148 asau 6482: <div class="sect2">
1.81 rillig 6483: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6484: <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 6485: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6486: defines all URLs from where the distfile, whose name is
6487: derived from the <code class="varname">DISTNAME</code> variable, is
6488: fetched. The more complicated cases are described
6489: below.</p>
6490: <p>The variable <code class="varname">DISTFILES</code> specifies
6491: the list of distfiles that have to be fetched. Its value
1.174 asau 6492: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6493: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 6494: so that most packages don't need to define it at all.
6495: <code class="varname">EXTRACT_SUFX</code> is
6496: <code class="literal">.tar.gz</code> by default, but can be changed
6497: freely. Note that if your package requires additional
6498: distfiles to the default one, you cannot just append the
6499: additional filenames using the <code class="literal">+=</code>
6500: operator, but you have write for example:</p>
1.81 rillig 6501: <pre class="programlisting">
1.174 asau 6502: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 6503: </pre>
1.88 wiz 6504: <p>Each distfile is fetched from a list of sites, usually
6505: <code class="varname">MASTER_SITES</code>. If the package has multiple
6506: <code class="varname">DISTFILES</code> or multiple
6507: <code class="varname">PATCHFILES</code> from different sites, you can
6508: set
6509: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6510: to the list of URLs where the file
6511: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6512: (including the suffix) can be found.</p>
6513: <pre class="programlisting">
1.100 rillig 6514: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6515: DISTFILES+= foo-file.tar.gz
6516: SITES.foo-file.tar.gz= \
6517: http://www.somewhere.com/somehow/ \
6518: http://www.somewhereelse.com/mirror/somehow/
6519: </pre>
1.81 rillig 6520: <p>When actually fetching the distfiles, each item from
1.88 wiz 6521: <code class="varname">MASTER_SITES</code> or
6522: <code class="varname">SITES.*</code> gets the name of each distfile
6523: appended to it, without an intermediate slash. Therefore,
6524: all site values have to end with a slash or other separator
6525: character. This allows for example to set
6526: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6527: that gets the name of the distfile as a parameter. In this
6528: case, the definition would look like:</p>
1.81 rillig 6529: <pre class="programlisting">
1.100 rillig 6530: MASTER_SITES= http://www.example.com/download.cgi?file=
6531: </pre>
1.125 wiz 6532: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 6533: In that case the URL is taken as is, fetched and the result
6534: stored under the name of the distfile. You can use this style
6535: for the case when the download URL style does not match the
6536: above common case. For example, if permanent download URL is a
6537: redirector to the real download URL, or the download file name
6538: is offered by an HTTP Content-Disposition header. In the
6539: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6540: created instead of the default
6541: <code class="filename">v1.0.0.tar.gz</code>.</p>
6542: <pre class="programlisting">
6543: DISTNAME= foo-1.0.0
6544: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6545: </pre>
1.81 rillig 6546: <p>There are some predefined values for
1.88 wiz 6547: <code class="varname">MASTER_SITES</code>, which can be used in
6548: packages. The names of the variables should speak for
6549: themselves.</p>
6550: <pre class="programlisting">
1.100 rillig 6551: ${MASTER_SITE_APACHE}
6552: ${MASTER_SITE_BACKUP}
6553: ${MASTER_SITE_CYGWIN}
6554: ${MASTER_SITE_DEBIAN}
6555: ${MASTER_SITE_FREEBSD}
6556: ${MASTER_SITE_FREEBSD_LOCAL}
6557: ${MASTER_SITE_GENTOO}
6558: ${MASTER_SITE_GNOME}
6559: ${MASTER_SITE_GNU}
6560: ${MASTER_SITE_GNUSTEP}
1.174 asau 6561: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 6562: ${MASTER_SITE_IFARCHIVE}
6563: ${MASTER_SITE_KDE}
6564: ${MASTER_SITE_MOZILLA}
1.174 asau 6565: ${MASTER_SITE_MOZILLA_ALL}
6566: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 6567: ${MASTER_SITE_MYSQL}
1.174 asau 6568: ${MASTER_SITE_NETLIB}
1.100 rillig 6569: ${MASTER_SITE_OPENOFFICE}
6570: ${MASTER_SITE_PERL_CPAN}
6571: ${MASTER_SITE_PGSQL}
1.174 asau 6572: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 6573: ${MASTER_SITE_R_CRAN}
6574: ${MASTER_SITE_SOURCEFORGE}
6575: ${MASTER_SITE_SOURCEFORGE_JP}
6576: ${MASTER_SITE_SUNSITE}
6577: ${MASTER_SITE_SUSE}
6578: ${MASTER_SITE_TEX_CTAN}
6579: ${MASTER_SITE_XCONTRIB}
6580: ${MASTER_SITE_XEMACS}
1.174 asau 6581: ${MASTER_SITE_XORG}
1.100 rillig 6582: </pre>
1.88 wiz 6583: <p>Some explanations for the less self-explaining ones:
6584: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6585: 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 6586: 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 6587: <p>If you choose one of these predefined sites, you may
6588: want to specify a subdirectory of that site. Since these
6589: macros may expand to more than one actual site, you
6590: <span class="emphasis"><em>must</em></span> use the following construct to
6591: specify a subdirectory:</p>
1.81 rillig 6592: <pre class="programlisting">
1.100 rillig 6593: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6594: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6595: </pre>
1.81 rillig 6596: <p>Note the trailing slash after the subdirectory
1.88 wiz 6597: name.</p>
1.81 rillig 6598: </div>
1.148 asau 6599: <div class="sect2">
1.81 rillig 6600: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6601: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6602: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6603: all the distfiles exist in a local directory
1.93 rillig 6604: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6605: user). If the files do not exist, they are fetched using
6606: commands of the form</p>
1.75 rillig 6607: <pre class="programlisting">
1.100 rillig 6608: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6609: </pre>
1.88 wiz 6610: <p>where <code class="literal">${site}</code> varies through
6611: several possibilities in turn: first,
6612: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6613: sites specified in either <code class="varname">SITES.file</code> if
6614: defined, else <code class="varname">MASTER_SITES</code> or
6615: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6616: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6617: all except the first and the last can be optionally sorted
6618: by the user, via setting either
6619: <code class="varname">MASTER_SORT_RANDOM</code>, and
6620: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6621: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6622: <p> The specific command and arguments used depend on the
6623: <code class="varname">FETCH_USING</code> parameter. The example above is
6624: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6625: <p>The distfiles mirror run by the NetBSD Foundation uses the
6626: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6627: distfiles, if they are freely distributable. Packages setting
6628: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6629: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6630: mirrored.</p>
1.81 rillig 6631: </div>
1.75 rillig 6632: </div>
1.148 asau 6633: <div class="sect1">
1.75 rillig 6634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6635: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6636: <p>After the distfile(s) are fetched, their checksum is
6637: generated and compared with the checksums stored in the
6638: distinfo file. If the checksums don't match, the build is
6639: aborted. This is to ensure the same distfile is used for
6640: building, and that the distfile wasn't changed, e.g. by some
6641: malign force, deliberately changed distfiles on the master
6642: distribution site or network lossage.</p>
1.75 rillig 6643: </div>
1.148 asau 6644: <div class="sect1">
1.75 rillig 6645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6646: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6647: <p>When the distfiles are present on the local system, they
1.88 wiz 6648: need to be extracted, as they usually come in the form of some
6649: compressed archive format.</p>
1.75 rillig 6650: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6651: extracted. If you only need some of them, you can set the
6652: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6653: files.</p>
6654: <p>Extracting the files is usually done by a little
1.93 rillig 6655: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6656: already knows how to extract various archive formats, so most
6657: likely you will not need to change anything here. But if you
6658: need, the following variables may help you:</p>
1.148 asau 6659: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6660: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6661: <dd><p>Use these variables to override the default
1.88 wiz 6662: options for an extract command, which are defined in
1.93 rillig 6663: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6664: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6665: <dd><p>This variable can be set to
1.114 jmcneill 6666: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6667: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6668: absolute pathname pointing to the command with which tar
1.114 jmcneill 6669: archives should be extracted. It is preferred to choose bsdtar over gtar
6670: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6671: </dl></div>
1.88 wiz 6672: <p>If the <code class="filename">extract</code> program doesn't
6673: serve your needs, you can also override the
6674: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6675: command used for extracting the files. This command is
6676: executed in the <code class="filename">${WRKSRC}</code>
6677: directory. During execution of this command, the shell
6678: variable <code class="varname">extract_file</code> holds the absolute
6679: pathname of the file that is going to be extracted.</p>
1.75 rillig 6680: <p>And if that still does not suffice, you can override the
1.88 wiz 6681: <code class="varname">do-extract</code> target in the package
6682: Makefile.</p>
1.75 rillig 6683: </div>
1.148 asau 6684: <div class="sect1">
1.75 rillig 6685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6686: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6687: <p>After extraction, all the patches named by the
1.88 wiz 6688: <code class="varname">PATCHFILES</code>, those present in the patches
6689: subdirectory of the package as well as in
6690: $LOCALPATCHES/$PKGPATH (e.g.
6691: <code class="filename">/usr/local/patches/graphics/png</code>) are
6692: applied. Patchfiles ending in <code class="filename">.Z</code> or
6693: <code class="filename">.gz</code> are uncompressed before they are
6694: applied, files ending in <code class="filename">.orig</code> or
6695: <code class="filename">.rej</code> are ignored. Any special options to
1.136 dholland 6696: <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 6697: <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.136 dholland 6698: <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 6699: it fail if the patches apply with some lines of fuzz. Please
6700: fix (regen) the patches so that they apply cleanly. The
6701: rationale behind this is that patches that don't apply cleanly
6702: may end up being applied in the wrong place, and cause severe
6703: harm there.</p>
1.75 rillig 6704: </div>
1.148 asau 6705: <div class="sect1">
1.75 rillig 6706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6707: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6708: <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 6709: </p>
1.75 rillig 6710: </div>
1.148 asau 6711: <div class="sect1">
1.75 rillig 6712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6713: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6714: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6715: linkers. The following variables can be used to tweak the
6716: wrappers.</p>
1.148 asau 6717: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6718: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6719: <dd><p>The command used to print progress
1.88 wiz 6720: messages. Does nothing by default. Set to
6721: <code class="literal">${ECHO}</code> to see the progress
6722: messages.</p></dd>
1.75 rillig 6723: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6724: <dd><p>This variable can be set to
1.88 wiz 6725: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6726: depending on whether you want additional information in the
6727: wrapper log file.</p></dd>
1.75 rillig 6728: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6729: <dd><p>This variable can be set to
1.88 wiz 6730: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6731: on whether the wrapper should use its cache, which will
6732: improve the speed. The default value is
6733: <code class="literal">yes</code>, but is forced to
6734: <code class="literal">no</code> if the platform does not support
6735: it.</p></dd>
1.75 rillig 6736: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6737: <dd><p>A list of reordering commands. A reordering
6738: command has the form
6739: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6740: It ensures that that
6741: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6742: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6743: </p></dd>
1.75 rillig 6744: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6745: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6746: investigate further]</p></dd>
1.75 rillig 6747: </dl></div>
6748: </div>
1.148 asau 6749: <div class="sect1">
1.75 rillig 6750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6751: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6752: <p>Most pieces of software need information on the header
6753: files, system calls, and library routines which are available
6754: on the platform they run on. The process of determining this
6755: information is known as configuration, and is usually
6756: automated. In most cases, a script is supplied with the
6757: distfiles, and its invocation results in generation of header
6758: files, Makefiles, etc.</p>
6759: <p>If the package contains a configure script, this can be
6760: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6761: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6762: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6763: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6764: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6765: <pre class="programlisting">
1.100 rillig 6766: .for d in ${CONFIGURE_DIRS}
6767: cd ${WRKSRC} \
6768: && cd ${d} \
6769: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6770: .endfor
6771: </pre>
1.88 wiz 6772: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6773: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6774: <code class="varname">WRKSRC</code>. In each of these directories, the
6775: configure script is run with the environment
6776: <code class="varname">CONFIGURE_ENV</code> and arguments
6777: <code class="varname">CONFIGURE_ARGS</code>. The variables
6778: <code class="varname">CONFIGURE_ENV</code>,
6779: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6780: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6781: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6782: package.</p>
1.144 wiz 6783: <p>If the program uses the Perl way of configuration (mainly Perl
6784: modules, but not only), i.e. a file called
6785: <code class="filename">Makefile.PL</code>, it should include
6786: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6787: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6788: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6789: <p>If the program uses an <code class="filename">Imakefile</code>
6790: for configuration, the appropriate steps can be invoked by
6791: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6792: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6793: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6794: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6795: xmkmf's environment by adding them to the
6796: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6797: <p>If the program uses <code class="filename">cmake</code>
6798: for configuration, the appropriate steps can be invoked by
1.128 wiz 6799: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6800: You can add variables to cmake's environment by adding them to the
6801: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6802: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6803: The top directory argument is given by the
6804: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6805: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6806: <p>If there is no configure step at all, set
1.128 wiz 6807: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6808: </div>
1.148 asau 6809: <div class="sect1">
1.75 rillig 6810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6811: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6812: <p>For building a package, a rough equivalent of the
6813: following code is executed.</p>
1.75 rillig 6814: <pre class="programlisting">
1.100 rillig 6815: .for d in ${BUILD_DIRS}
6816: cd ${WRKSRC} \
6817: && cd ${d} \
6818: && env ${MAKE_ENV} \
6819: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6820: -f ${MAKE_FILE} \
6821: ${BUILD_TARGET}
6822: .endfor
6823: </pre>
1.88 wiz 6824: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6825: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6826: <code class="varname">WRKSRC</code>. In each of these directories,
6827: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6828: <code class="varname">MAKE_ENV</code> and arguments
6829: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6830: <code class="varname">MAKE_ENV</code>,
6831: <code class="varname">BUILD_MAKE_FLAGS</code>,
6832: <code class="varname">MAKE_FILE</code> and
6833: <code class="varname">BUILD_TARGET</code> may all be changed by the
6834: package.</p>
1.75 rillig 6835: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6836: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6837: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6838: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6839: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6840: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6841: <p>If there is no build step at all, set
1.128 wiz 6842: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6843: </div>
1.148 asau 6844: <div class="sect1">
1.75 rillig 6845: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6846: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6847: <p>[TODO]</p>
6848: </div>
1.148 asau 6849: <div class="sect1">
1.75 rillig 6850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6851: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6852: <p>Once the build stage has completed, the final step is to
1.88 wiz 6853: install the software in public directories, so users can
6854: access the programs and files.</p>
1.75 rillig 6855: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6856: equivalent of the following code is executed. Additionally,
6857: before and after this code, much magic is performed to do
6858: consistency checks, registering the package, and so on.</p>
6859: <pre class="programlisting">
1.100 rillig 6860: .for d in ${INSTALL_DIRS}
6861: cd ${WRKSRC} \
6862: && cd ${d} \
6863: && env ${MAKE_ENV} \
6864: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6865: -f ${MAKE_FILE} \
6866: ${INSTALL_TARGET}
6867: .endfor
6868: </pre>
1.75 rillig 6869: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6870: <span class="emphasis"><em>build</em></span> phase.
6871: <code class="varname">INSTALL_DIRS</code> defaults to
6872: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6873: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6874: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6875: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6876: defined.</p>
1.75 rillig 6877: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6878: variables are useful. They are all variations of the
1.136 dholland 6879: <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 6880: permissions preset. <code class="varname">INSTALL</code> is the plain
6881: install command. The specialized variants, together with their
6882: intended use, are:</p>
1.148 asau 6883: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6884: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6885: <dd><p>directories that contain
6886: binaries</p></dd>
1.75 rillig 6887: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6888: <dd><p>directories that contain
6889: scripts</p></dd>
1.75 rillig 6890: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6891: <dd><p>directories that contain shared and static
6892: libraries</p></dd>
1.75 rillig 6893: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6894: <dd><p>directories that contain data
6895: files</p></dd>
1.75 rillig 6896: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6897: <dd><p>directories that contain man
6898: pages</p></dd>
1.75 rillig 6899: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6900: <dd><p>binaries that can be stripped from debugging
6901: symbols</p></dd>
1.75 rillig 6902: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6903: <dd><p>binaries that cannot be
6904: stripped</p></dd>
1.75 rillig 6905: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6906: <dd><p>game
6907: binaries</p></dd>
1.75 rillig 6908: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6909: <dd><p>shared and static
6910: libraries</p></dd>
1.75 rillig 6911: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6912: <dd><p>data files</p></dd>
6913: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6914: <dd><p>data files for
6915: games</p></dd>
1.75 rillig 6916: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6917: <dd><p>man pages</p></dd>
6918: </dl></div>
6919: <p>Some other variables are:</p>
1.148 asau 6920: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6921: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6922: <dd><p>A list of directories relative to
1.88 wiz 6923: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6924: beginning of the <span class="emphasis"><em>install</em></span> phase.
6925: The package is supposed to create all needed directories itself
6926: before installing files to it and list all other directories here.
6927: </p></dd>
1.75 rillig 6928: </dl></div>
1.97 rillig 6929: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6930: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6931: mostly relevant for packages in the <code class="filename">regress</code>
6932: category.</p>
1.75 rillig 6933: </div>
1.148 asau 6934: <div class="sect1">
1.75 rillig 6935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6936: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6937: <p>Once the install stage has completed, a binary package of
6938: the installed files can be built. These binary packages can be
6939: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6940: the <span class="command"><strong>make bin-install</strong></span> or by using
6941: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6942: <p>By default, the binary packages are created in
6943: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6944: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6945: one for each category in the <code class="varname">CATEGORIES</code>
6946: variable. <code class="varname">PACKAGES</code> defaults to
6947: <code class="filename">pkgsrc/packages</code>.</p>
6948: </div>
1.148 asau 6949: <div class="sect1">
1.88 wiz 6950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6951: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6952: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6953: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6954: to clean the work directories of all dependencies too, use
1.110 hubertf 6955: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6956: </div>
1.148 asau 6957: <div class="sect1">
1.75 rillig 6958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6959: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6960: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6961: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6962: <dd><p>For any of the main targets described in the
6963: previous section, two auxiliary targets exist with
1.128 wiz 6964: <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 6965: prefix for the main target's name. These targets are
1.88 wiz 6966: invoked before and after the main target is called,
6967: allowing extra configuration or installation steps be
6968: performed from a package's Makefile, for example, which
6969: a program's configure script or install target
6970: omitted.</p></dd>
1.75 rillig 6971: <dt><span class="term">do-*</span></dt>
1.88 wiz 6972: <dd><p>Should one of the main targets do the wrong thing,
6973: and should there be no variable to fix this, you can
6974: redefine it with the do-* target. (Note that redefining
6975: the target itself instead of the do-* target is a bad
6976: idea, as the pre-* and post-* targets won't be called
6977: anymore, etc.) You will not usually need to do
6978: this.</p></dd>
1.75 rillig 6979: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6980: <dd>
1.110 hubertf 6981: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6982: you noticed some file was not installed properly, you
6983: can repeat the installation with this target, which will
1.128 wiz 6984: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6985: <p>This is the default value of
6986: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6987: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6988: package</strong></span>, where the defaults are
1.128 wiz 6989: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6990: respectively.</p>
6991: </dd>
1.75 rillig 6992: <dt><span class="term">deinstall</span></dt>
6993: <dd>
1.136 dholland 6994: <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 6995: current directory, effectively de-installing the
6996: package. The following variables can be used to tune the
6997: behaviour:</p>
1.148 asau 6998: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6999: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.136 dholland 7000: <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 7001: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7002: <dd><p>Remove all packages that require (depend on)
7003: the given package. This can be used to remove any
7004: packages that may have been pulled in by a given
1.110 hubertf 7005: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7006: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7007: <code class="filename">pkgsrc/x11/kde</code>, this is
7008: likely to remove whole KDE. Works by adding
1.136 dholland 7009: <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 7010: command line.</p></dd>
1.75 rillig 7011: </dl></div>
7012: </dd>
1.88 wiz 7013: <dt><span class="term">bin-install</span></dt>
7014: <dd><p>Install a binary package from local disk and via FTP
7015: from a list of sites (see the
7016: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7017: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7018: available anywhere. The arguments given to
1.110 hubertf 7019: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7020: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7021: operation, etc.</p></dd>
1.75 rillig 7022: <dt><span class="term">update</span></dt>
7023: <dd>
1.88 wiz 7024: <p>This target causes the current package to be
7025: updated to the latest version. The package and all
7026: depending packages first get de-installed, then current
7027: versions of the corresponding packages get compiled and
7028: installed. This is similar to manually noting which
7029: packages are currently installed, then performing a
1.110 hubertf 7030: series of <span class="command"><strong>make deinstall</strong></span> and
7031: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7032: <code class="varname">UPDATE_TARGET</code> is set to) for these
7033: packages.</p>
1.128 wiz 7034: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 7035: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7036: update</strong></span> was interrupted for some reason.
7037: However, in this case, make sure you don't call
1.110 hubertf 7038: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7039: list of dependent packages in <code class="varname">WRKDIR</code>.
7040: Otherwise, you lose the ability to automatically update
7041: the current package along with the dependent packages
7042: you have installed.</p>
1.110 hubertf 7043: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7044: update</strong></span> will only work as long as the package
7045: tree remains unchanged. If the source code for one of
7046: the packages to be updated has been changed, resuming
1.110 hubertf 7047: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7048: fail!</p>
7049: <p>The following variables can be used either on the
1.110 hubertf 7050: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7051: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7052: update</strong></span>:</p>
1.148 asau 7053: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7054: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7055: <dd><p>Install target to recursively use for the
7056: updated package and the dependent packages.
7057: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7058: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7059: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7060: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7061: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7062: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7063: endless loop!</p></dd>
1.75 rillig 7064: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7065: <dd><p>Don't clean up after updating. Useful if
7066: you want to leave the work sources of the updated
7067: packages around for inspection or other purposes.
7068: Be sure you eventually clean up the source tree
1.128 wiz 7069: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7070: or you may run into troubles with old source code
7071: still lying around on your next
1.110 hubertf 7072: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7073: update</strong></span>.</p></dd>
1.75 rillig 7074: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7075: <dd><p>Deinstall each package before installing
7076: (making <code class="varname">DEPENDS_TARGET</code>). This
7077: may be necessary if the
1.128 wiz 7078: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7079: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7080: update</strong></span>.</p></dd>
1.75 rillig 7081: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7082: <dd><p>Allows you to disable recursion and hardcode
7083: the target for packages. The default is
1.128 wiz 7084: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7085: facilitating a recursive update of prerequisite
7086: packages. Only set
7087: <code class="varname">DEPENDS_TARGET</code> if you want to
7088: disable recursive updates. Use
7089: <code class="varname">UPDATE_TARGET</code> instead to just
7090: set a specific target for each package to be
1.110 hubertf 7091: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7092: (see above).</p></dd>
1.75 rillig 7093: </dl></div>
7094: </dd>
7095: <dt><span class="term">clean-update</span></dt>
7096: <dd>
1.88 wiz 7097: <p>Clean the source tree for all packages that would
1.110 hubertf 7098: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7099: from the current directory. This target should not be
7100: used if the current package (or any of its depending
7101: packages) have already been de-installed (e.g., after
1.110 hubertf 7102: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7103: some packages you intended to update. As a rule of
7104: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7105: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7106: and only if you have a dirty package tree (e.g., if you
7107: used <code class="varname">NOCLEAN</code>).</p>
7108: <p>If you are unsure about whether your tree is
1.110 hubertf 7109: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7110: clean</strong></span> at the top of the tree, or use the
7111: following sequence of commands from the directory of the
7112: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7113: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7114: time, otherwise you lose all the packages you wanted to
7115: update!):</p>
1.87 wiz 7116: <pre class="screen">
7117: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7118: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7119: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7120: </pre>
1.88 wiz 7121: <p>The following variables can be used either on the
1.110 hubertf 7122: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7123: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 7124: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7125: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7126: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7127: reconstruct the list of directories to update for
1.110 hubertf 7128: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7129: update</strong></span> successfully installed all
7130: packages you wanted to update. Normally, this is
1.110 hubertf 7131: done automatically on <span class="command"><strong>make
1.88 wiz 7132: update</strong></span>, but may have been suppressed by
7133: the <code class="varname">NOCLEAN</code> variable (see
7134: above).</p></dd>
1.75 rillig 7135: </dl></div>
7136: </dd>
1.88 wiz 7137: <dt><span class="term">replace</span></dt>
7138: <dd>
7139: <p>Update the installation of the current package. This
7140: differs from update in that it does not replace dependent
1.93 rillig 7141: 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 7142: target to work.</p>
7143: <p><span class="emphasis"><em>Be careful when using this
7144: target!</em></span> There are no guarantees that dependent
7145: packages will still work, in particular they will most
1.110 hubertf 7146: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7147: library package whose shared library major version changed
7148: between your installed version and the new one. For this
7149: reason, this target is not officially supported and only
7150: recommended for advanced users.</p>
7151: </dd>
1.75 rillig 7152: <dt><span class="term">info</span></dt>
1.136 dholland 7153: <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 7154: package. You can use this to check which version of a
7155: package is installed.</p></dd>
7156: <dt><span class="term">index</span></dt>
7157: <dd>
7158: <p>This is a top-level command, i.e. it should be used in
7159: the <code class="filename">pkgsrc</code> directory. It creates a
7160: database of all packages in the local pkgsrc tree, including
7161: dependencies, comment, maintainer, and some other useful
7162: information. Individual entries are created by running
1.110 hubertf 7163: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7164: directories. This index file is saved as
7165: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7166: verbose format by running <span class="command"><strong>make
1.88 wiz 7167: print-index</strong></span>. You can search in it with
1.110 hubertf 7168: <span class="command"><strong>make search
1.88 wiz 7169: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7170: extract a list of all packages that depend on a particular
1.110 hubertf 7171: one by running <span class="command"><strong>make show-deps
1.88 wiz 7172: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7173: <p>Running this command takes a very long time, some
7174: hours even on fast machines!</p>
7175: </dd>
1.75 rillig 7176: <dt><span class="term">readme</span></dt>
1.88 wiz 7177: <dd>
7178: <p>This target generates a
7179: <code class="filename">README.html</code> file, which can be
1.91 rillig 7180: 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 7181: contain references to any packages which are in the
7182: <code class="varname">PACKAGES</code> directory on the local
7183: host. The generated files can be made to refer to URLs
7184: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7185: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7186: wanted to generate <code class="filename">README.html</code>
7187: files which pointed to binary packages on the local
7188: machine, in the directory
7189: <code class="filename">/usr/packages</code>, set
7190: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7191: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7192: <code class="varname">${PACKAGES}</code> directory and its
7193: subdirectories will be searched for all the binary
7194: packages.</p>
7195: <p>The target can be run at the toplevel or in category
7196: directories, in which case it descends recursively.</p>
7197: </dd>
1.75 rillig 7198: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7199: <dd><p>This is a top-level command, run it in
7200: <code class="filename">pkgsrc</code>. Use this target to create a
7201: file <code class="filename">README-all.html</code> which contains a
7202: list of all packages currently available in the NetBSD
7203: Packages Collection, together with the category they belong
7204: to and a short description. This file is compiled from the
7205: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7206: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7207: readme</strong></span>.</p></dd>
1.75 rillig 7208: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7209: <dd><p>This is very much the same as the
1.128 wiz 7210: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7211: used when generating a pkgsrc tree to be written to a
7212: CD-ROM. This target also produces
7213: <code class="filename">README.html</code> files, and can be made
7214: to refer to URLs based on
7215: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7216: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7217: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7218: <dd><p>This target shows which distfiles and patchfiles
7219: are needed to build the package
7220: (<code class="varname">ALLFILES</code>, which contains all
7221: <code class="varname">DISTFILES</code> and
1.87 wiz 7222: <code class="varname">PATCHFILES</code>, but not
7223: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7224: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7225: <dd><p>This target shows nothing if the package is not
7226: installed. If a version of this package is installed,
7227: but is not the version provided in this version of
7228: pkgsrc, then a warning message is displayed. This target
7229: can be used to show which of your installed packages are
7230: downlevel, and so the old versions can be deleted, and
7231: the current ones added.</p></dd>
1.75 rillig 7232: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7233: <dd><p>This target shows the directory in the pkgsrc
7234: hierarchy from which the package can be built and
7235: installed. This may not be the same directory as the one
7236: from which the package was installed. This target is
7237: intended to be used by people who may wish to upgrade
7238: many packages on a single host, and can be invoked from
7239: the top-level pkgsrc Makefile by using the
1.128 wiz 7240: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7241: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7242: <dd><p>This target shows which installed packages match
7243: the current package's <code class="varname">DEPENDS</code>. Useful
7244: if out of date dependencies are causing build
7245: problems.</p></dd>
1.75 rillig 7246: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7247: <dd><p>After a package is installed, check all its
7248: binaries and (on ELF platforms) shared libraries to see
7249: if they find the shared libs they need. Run by default
1.110 hubertf 7250: 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 7251: <dt><span class="term">print-PLIST</span></dt>
7252: <dd>
1.128 wiz 7253: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7254: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7255: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7256: -newer work/.extract_done</strong></span>. An attempt is made
7257: to care for shared libs etc., but it is
1.87 wiz 7258: <span class="emphasis"><em>strongly</em></span> recommended to review the
7259: result before putting it into
7260: <code class="filename">PLIST</code>. On upgrades, it's useful to
7261: diff the output of this command against an already
7262: existing <code class="filename">PLIST</code> file.</p>
1.136 dholland 7263: <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 7264: other methods that don't update file access times, be
7265: sure to add these files manually to your
1.128 wiz 7266: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7267: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7268: them!</p>
1.128 wiz 7269: <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 7270: information on this target.</p>
1.75 rillig 7271: </dd>
7272: <dt><span class="term">bulk-package</span></dt>
7273: <dd>
1.88 wiz 7274: <p>Used to do bulk builds. If an appropriate binary
7275: package already exists, no action is taken. If not, this
7276: target will compile, install and package it (and its
7277: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 7278: 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
7279: builds)</i></a>).
1.88 wiz 7280: After creating the binary package, the sources, the
7281: just-installed package and its required packages are
7282: removed, preserving free disk space.</p>
7283: <p><span class="emphasis"><em>Beware that this target may deinstall
7284: all packages installed on a system!</em></span></p>
1.75 rillig 7285: </dd>
7286: <dt><span class="term">bulk-install</span></dt>
7287: <dd>
1.88 wiz 7288: <p>Used during bulk-installs to install required
7289: packages. If an up-to-date binary package is available,
1.136 dholland 7290: 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 7291: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7292: but the installed binary won't be removed.</p>
1.88 wiz 7293: <p>A binary package is considered
1.128 wiz 7294: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.136 dholland 7295: <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 7296: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7297: <li class="listitem"><p>None of the package's files
1.88 wiz 7298: (<code class="filename">Makefile</code>, ...) were modified
7299: since it was built.</p></li>
1.128 wiz 7300: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7301: packages were modified since it was built.</p></li>
1.75 rillig 7302: </ul></div>
1.88 wiz 7303: <p><span class="emphasis"><em>Beware that this target may deinstall
7304: all packages installed on a system!</em></span></p>
1.75 rillig 7305: </dd>
7306: </dl></div>
7307: </div>
7308: </div>
1.148 asau 7309: <div class="chapter">
1.75 rillig 7310: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7311: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7312: <div class="toc">
7313: <p><b>Table of Contents</b></p>
7314: <dl>
1.106 rillig 7315: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7316: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7317: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7318: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7319: </dl>
7320: </div>
1.87 wiz 7321: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7322: by pkgsrc and also for individual packages to define what commands
7323: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7324: or for later run-time of an installed packaged (such as
7325: <code class="varname">DEPENDS</code>).
7326: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7327: package will not be used.</p>
7328: <p>When building a package, the replacement tools are
1.75 rillig 7329: made available in a directory (as symlinks or wrapper scripts)
7330: that is early in the executable search path. Just like the buildlink
1.87 wiz 7331: system, this helps with consistent builds.</p>
7332: <p>A tool may be needed to help build a specific package. For example,
7333: perl, GNU make (gmake) or yacc may be needed.</p>
7334: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7335: tool may be inefficient for building a package with pkgsrc.
7336: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7337: yacc) or a better sed.</p>
7338: <p>The tools used by a package can be listed by running
1.110 hubertf 7339: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 7340: <div class="sect1">
1.75 rillig 7341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7342: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7343: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7344: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7345: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7346: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7347: These can be seen by running:
1.110 hubertf 7348: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7349: <p>If a package needs a specific program to build
1.75 rillig 7350: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7351: to define the tools needed.</p>
1.75 rillig 7352: </div>
1.148 asau 7353: <div class="sect1">
1.75 rillig 7354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7355: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7356: <p>In the following examples, the :run means that it is needed at
7357: run-time (and becomes a DEPENDS).
1.75 rillig 7358: The default is a build dependency which can be set with
7359: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7360: and pkg-config:build.)</p>
1.75 rillig 7361: <pre class="programlisting">
7362: USE_TOOLS+= gmake perl:run pkg-config
7363: </pre>
1.87 wiz 7364: <p>When using the tools framework, a
1.75 rillig 7365: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7366: which contains the full path to the appropriate tool. For example,
1.128 wiz 7367: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7368: on Linux systems.</p>
7369: <p>If you always need a pkgsrc version of the
1.75 rillig 7370: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7371: </p>
7372: </div>
1.148 asau 7373: <div class="sect1">
1.75 rillig 7374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7375: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7376: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7377: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7378: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7379: the name of the common tools. For example:</p>
7380: <pre class="programlisting">
7381: .if exists(/usr/bin/bzcat)
7382: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7383: .elif exists(/usr/bin/bzip2)
7384: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7385: .endif
1.69 rillig 7386:
1.75 rillig 7387: TOOLS_PLATFORM.true?= true # shell builtin
7388: </pre>
7389: </div>
1.148 asau 7390: <div class="sect1">
1.97 rillig 7391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7392: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 asau 7393: <div class="qandaset">
1.178 ! asau 7394: <a name="idm31250244"></a><dl>
1.106 rillig 7395: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7396: </dt>
1.106 rillig 7397: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7398: tools?</a>
7399: </dt>
1.106 rillig 7400: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7401: package is using while being built? I want to know whether it
7402: uses sed or not.</a>
7403: </dt>
7404: </dl>
1.148 asau 7405: <table border="0" style="width: 100%;">
7406: <colgroup>
1.97 rillig 7407: <col align="left" width="1%">
1.128 wiz 7408: <col>
1.148 asau 7409: </colgroup>
1.97 rillig 7410: <tbody>
1.148 asau 7411: <tr class="question">
1.97 rillig 7412: <td align="left" valign="top">
1.178 ! asau 7413: <a name="tools.new"></a><a name="idm31250052"></a><p><b>18.4.1.</b></p>
1.97 rillig 7414: </td>
7415: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7416: </tr>
7417: <tr class="answer">
7418: <td align="left" valign="top"></td>
7419: <td align="left" valign="top"><p>TODO</p></td>
7420: </tr>
1.148 asau 7421: <tr class="question">
1.97 rillig 7422: <td align="left" valign="top">
1.178 ! asau 7423: <a name="tools.listall"></a><a name="idm31249540"></a><p><b>18.4.2.</b></p>
1.97 rillig 7424: </td>
7425: <td align="left" valign="top"><p>How do I get a list of all available
7426: tools?</p></td>
7427: </tr>
7428: <tr class="answer">
7429: <td align="left" valign="top"></td>
7430: <td align="left" valign="top"><p>TODO</p></td>
7431: </tr>
1.148 asau 7432: <tr class="question">
1.97 rillig 7433: <td align="left" valign="top">
1.178 ! asau 7434: <a name="tools.used"></a><a name="idm31249028"></a><p><b>18.4.3.</b></p>
1.97 rillig 7435: </td>
7436: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7437: package is using while being built? I want to know whether it
7438: uses sed or not.</p></td>
7439: </tr>
7440: <tr class="answer">
7441: <td align="left" valign="top"></td>
7442: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7443: to do it.)</p></td>
7444: </tr>
7445: </tbody>
7446: </table>
7447: </div>
7448: </div>
1.75 rillig 7449: </div>
1.148 asau 7450: <div class="chapter">
1.75 rillig 7451: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7452: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7453: <div class="toc">
7454: <p><b>Table of Contents</b></p>
7455: <dl>
1.106 rillig 7456: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7457: <dd><dl>
1.106 rillig 7458: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7459: <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 7460: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7461: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7462: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7463: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7464: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7465: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7466: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7467: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7468: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7469: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7470: </dl></dd>
1.128 wiz 7471: <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 7472: <dd><dl>
7473: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7474: <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>
7475: </dl></dd>
1.128 wiz 7476: <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 7477: <dd><dl>
7478: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7479: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7480: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7481: </dl></dd>
7482: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7483: <dd><dl>
7484: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7485: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7486: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7487: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7488: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7489: </dl></dd>
1.128 wiz 7490: <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 7491: <dd><dl>
7492: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7493: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7494: <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 7495: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7496: </dl></dd>
1.128 wiz 7497: <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 7498: <dd><dl>
7499: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7500: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7501: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7502: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7503: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7504: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7505: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7506: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7507: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7508: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7509: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7510: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7511: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7512: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7513: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7514: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7515: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7516: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7517: emulation</a></span></dt>
1.106 rillig 7518: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7519: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7520: </dl></dd>
1.106 rillig 7521: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7522: </dl>
7523: </div>
1.148 asau 7524: <div class="sect1">
1.75 rillig 7525: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7526: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 asau 7527: <div class="sect2">
1.75 rillig 7528: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7529: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7530: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7531: different platforms. As a result, it is important to ensure,
7532: where possible, that packages in pkgsrc are portable. This
7533: chapter mentions some particular details you should pay
7534: attention to while working on pkgsrc.</p>
1.78 rillig 7535: </div>
1.148 asau 7536: <div class="sect2">
1.78 rillig 7537: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7538: <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 7539: </h3></div></div></div>
1.78 rillig 7540: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7541: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7542: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7543: want to use those variables in the preprocessor directives of
1.136 dholland 7544: <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 7545: <code class="literal">.for</code>), you need to include the file
7546: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7547: loads the user preferences.</p>
1.78 rillig 7548: <p>But note that some variables may not be completely defined
1.87 wiz 7549: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7550: included, as they may contain references to variables that are
7551: not yet defined. In shell commands this is no problem, since
7552: variables are actually macros, which are only expanded when they
7553: are used. But in the preprocessor directives mentioned above and
7554: in dependency lines (of the form <code class="literal">target:
7555: dependencies</code>) the variables are expanded at load
7556: time.</p>
1.148 asau 7557: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7558: <h3 class="title">Note</h3>
7559: <p>Currently there is no exhaustive list of all
1.87 wiz 7560: variables that tells you whether they can be used at load time
7561: or only at run time, but it is in preparation.</p>
1.78 rillig 7562: </div>
7563: </div>
1.148 asau 7564: <div class="sect2">
1.78 rillig 7565: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7566: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7567: <p>Occasionally, packages require interaction from the user,
7568: and this can be in a number of ways:</p>
1.148 asau 7569: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7570: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7571: interaction such as entering username/password or accepting a
7572: license on a web page.</p></li>
1.128 wiz 7573: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7574: passwords.</p></li>
1.128 wiz 7575: <li class="listitem"><p>help to configure the package before it is built</p></li>
7576: <li class="listitem"><p>help during the build process</p></li>
7577: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7578: </ul></div>
1.88 wiz 7579: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7580: provided to notify the pkgsrc mechanism of an interactive stage
7581: which will be needed, and this should be set in the package's
7582: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7583: <pre class="programlisting">
1.100 rillig 7584: INTERACTIVE_STAGE= build
1.87 wiz 7585: </pre>
1.78 rillig 7586: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7587: <pre class="programlisting">
1.100 rillig 7588: INTERACTIVE_STAGE= configure install
1.87 wiz 7589: </pre>
1.88 wiz 7590: <p>The user can then decide to skip this package by setting the
7591: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7592: </div>
1.148 asau 7593: <div class="sect2">
1.75 rillig 7594: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7595: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7596: <p>Authors of software can choose the licence under which
7597: software can be copied. This is due to copyright law, and reasons
7598: for license choices are outside the scope of pkgsrc. The pkgsrc
7599: system recognizes that there are a number of licenses which some
7600: users may find objectionable or difficult or impossible to comply
7601: with. The Free Software Foundation has declared some licenses
7602: "Free", and the Open Source Initiative has a definition of "Open
7603: Source". The pkgsrc system, as a policy choice, does not label
7604: packages which have licenses that are Free or Open Source.
7605: However, packages without a license meeting either of those tests
7606: are labeled with a license tag denoting the license. Note that a
7607: package with no license to copy trivially does not meet either the
7608: Free or Open Source test.</p>
7609: <p>For packages which are not Free or Open Source, pkgsrc will
7610: not build the package unless the user has indicated to pkgsrc that
7611: packages with that particular license may be built. Note that
7612: this documentation avoids the term "accepted the license". The
7613: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7614: accidentally building a package with a non-free license;
1.98 wiz 7615: judgement and responsibility remain with the user. (Installation
7616: of binary packages are not currently subject to this mechanism;
7617: this is a bug.)</p>
7618: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7619: or the GPL, and not the other. The free licenses are added to the
7620: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7621: user can override the default by setting the
7622: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7623: of "+=". The licenses accepted by default are:
7624: </p>
7625: <pre class="programlisting">
1.154 rodent 7626: apache-1.1 apache-2.0
7627: arphic-public
7628: artistic artistic-2.0
7629: boost-license
7630: cc-by-sa-v3.0
1.161 ryoon 7631: cc0-1.0-universal
1.154 rodent 7632: cddl-1.0
7633: cpl-1.0
7634: epl-v1.0
7635: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7636: gnu-gpl-v1
7637: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7638: gnu-gpl-v3 gnu-lgpl-v3
7639: ibm-public-license-1.0
7640: ipafont
7641: isc
7642: lppl-1.3c
7643: lucent
7644: miros
7645: mit
7646: mpl-1.0 mpl-1.1 mpl-2.0
7647: mplusfont
7648: ofl-v1.0 ofl-v1.1
7649: original-bsd modified-bsd 2-clause-bsd
7650: php
7651: png-license
7652: postgresql-license
7653: public-domain
7654: python-software-foundation
7655: qpl-v1.0
1.158 rodent 7656: sgi-free-software-b-v2.0
1.154 rodent 7657: sleepycat-public
7658: unlicense
7659: x11
7660: zlib
7661: zpl
1.121 jnemeth 7662: </pre>
7663: <p>
7664: </p>
1.78 rillig 7665: <p>The license tag mechanism is intended to address
1.87 wiz 7666: copyright-related issues surrounding building, installing and
7667: using a package, and not to address redistribution issues (see
7668: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7669: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7670: Packages with redistribution restrictions should set these
7671: tags.</p>
1.98 wiz 7672: <p>Denoting that a package may be copied according to a
7673: particular license is done by placing the license in
1.87 wiz 7674: <code class="filename">pkgsrc/licenses</code> and setting the
7675: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7676: 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 7677: <pre class="programlisting">
1.100 rillig 7678: LICENSE= xv-license
1.87 wiz 7679: </pre>
7680: <p>When trying to build, the user will get a notice that the
1.98 wiz 7681: package is covered by a license which has not been placed in the
7682: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7683: <pre class="programlisting">
1.100 rillig 7684: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7685: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7686: ===> To view the license, enter "/usr/bin/make show-license".
7687: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7688: ===> ACCEPTABLE_LICENSES+=xv-license
7689: *** Error code 1
1.87 wiz 7690: </pre>
1.110 hubertf 7691: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7692: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7693: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7694: convey to pkgsrc that it should not in the future fail because of
7695: that license:</p>
1.78 rillig 7696: <pre class="programlisting">
1.100 rillig 7697: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7698: </pre>
1.154 rodent 7699: <p>When adding a package with a new license, the following steps
7700: are required:</p>
7701: <div class="orderedlist"><ol class="orderedlist" type="1">
7702: <li class="listitem">
7703: <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>
7704: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7705: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7706: <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 7707: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154 rodent 7708: </ul></div>
7709: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7710: </li>
7711: <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>
7712: </ol></div>
1.98 wiz 7713: <p>When the license changes (in a way other than formatting),
7714: please make sure that the new license has a different name (e.g.,
7715: append the version number if it exists, or the date). Just
7716: because a user told pkgsrc to build programs under a previous
7717: version of a license does not mean that pkgsrc should build
1.99 rillig 7718: programs under the new licenses. The higher-level point is that
1.98 wiz 7719: pkgsrc does not evaluate licenses for reasonableness; the only
7720: test is a mechanistic test of whether a particular text has been
7721: approved by either of two bodies.</p>
1.78 rillig 7722: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7723: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7724: is deprecated because it does not crisply refer to a particular
7725: license text. Another problem with such usage is that it does not
7726: enable a user to tell pkgsrc to proceed for a single package
7727: without also telling pkgsrc to proceed for all packages with that
7728: tag.</p>
1.75 rillig 7729: </div>
1.148 asau 7730: <div class="sect2">
1.75 rillig 7731: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7732: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7733: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7734: Because a license tag is required unless the package is Free or
7735: Open Source, all packages with restrictions should have license
7736: tags. By declaring the restrictions, package tools can
7737: automatically refrain from e.g. placing binary packages on FTP
7738: sites.</p>
7739: <p>There are four restrictions that may be encoded, which are
7740: the cross product of sources (distfiles) and binaries not being
7741: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7742: language in any license, and because non-Free licenses tend to be
7743: different from each other, pkgsrc adopts a definition of FTP and
7744: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7745: should not be made available over the Internet at no charge.
7746: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7747: made available on some kind of media, together with other source
7748: and binary packages, and which is sold for a distribution charge.
7749: </p>
7750: <p>In order to encode these restrictions, the package system
1.87 wiz 7751: defines five make variables that can be set to note these
7752: restrictions:</p>
1.148 asau 7753: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7754: <li class="listitem">
1.75 rillig 7755: <p><code class="varname">RESTRICTED</code></p>
7756: <p>This variable should be set whenever a restriction
1.87 wiz 7757: exists (regardless of its kind). Set this variable to a
1.98 wiz 7758: string containing the reason for the restriction. It should
7759: be understood that those wanting to understand the restriction
7760: will have to read the license, and perhaps seek advice of
7761: counsel.</p>
1.75 rillig 7762: </li>
1.128 wiz 7763: <li class="listitem">
1.75 rillig 7764: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7765: <p>Binaries may not be placed on CD-ROM containing other
7766: binary packages, for which a distribution charge may be made.
7767: In this case, set this variable to
7768: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7769: </li>
1.128 wiz 7770: <li class="listitem">
1.75 rillig 7771: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7772: <p>Binaries may not made available on the Internet without
7773: charge. In this case, set this variable to
7774: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7775: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7776: </li>
1.128 wiz 7777: <li class="listitem">
1.75 rillig 7778: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7779: <p>Distfiles may not be placed on CD-ROM, together with
7780: other distfiles, for which a fee may be charged. In this
7781: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7782: </p>
1.75 rillig 7783: </li>
1.128 wiz 7784: <li class="listitem">
1.75 rillig 7785: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7786: <p>Distfiles may not made available via FTP at no charge.
7787: In this case, set this variable to
7788: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7789: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7790: </li>
7791: </ul></div>
1.139 wiz 7792: <p>Please note that packages will to be removed from pkgsrc
7793: when the distfiles are not distributable and cannot be obtained
7794: for a period of one full quarter branch. Packages with manual /
7795: interactive fetch must have a maintainer and it is his/her
7796: responsibility to ensure this.</p>
1.75 rillig 7797: </div>
1.148 asau 7798: <div class="sect2">
1.75 rillig 7799: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7800: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7801: <p>Your package may depend on some other package being present
1.88 wiz 7802: - and there are various ways of expressing this dependency.
7803: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7804: <code class="varname">DEPENDS</code> definitions, the
7805: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7806: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7807: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7808: 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 7809: <p>The basic difference between the two variables is as
1.87 wiz 7810: follows: The <code class="varname">DEPENDS</code> definition registers
7811: that pre-requisite in the binary package so it will be pulled in
7812: when the binary package is later installed, whilst the
7813: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7814: dependency that is only needed for building the package.</p>
1.75 rillig 7815: <p>This means that if you only need a package present whilst
1.87 wiz 7816: you are building, it should be noted as a
7817: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7818: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7819: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7820: <pre class="programlisting">
1.100 rillig 7821: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7822: </pre>
1.128 wiz 7823: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7824: may include any of the wildcard version numbers recognized by
1.136 dholland 7825: <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 7826: <div class="orderedlist"><ol class="orderedlist" type="1">
7827: <li class="listitem">
1.75 rillig 7828: <p>If your package needs another package's binaries or
1.160 wiz 7829: libraries to build and run, and if that package has a
1.87 wiz 7830: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7831: <pre class="programlisting">
1.100 rillig 7832: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7833: </pre>
1.75 rillig 7834: </li>
1.128 wiz 7835: <li class="listitem">
1.160 wiz 7836: <p>If your package needs another package's binaries or
7837: libraries only for building, and if that package has a
7838: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7839: <pre class="programlisting">
7840: .include "../../graphics/jpeg/buildlink3.mk"
7841: </pre>
7842: <p>but set
7843: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7844: to make it a build dependency only. This case is rather
7845: rare.</p>
7846: </li>
7847: <li class="listitem">
1.132 spz 7848: <p>If your package needs binaries from another package to build,
7849: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7850: <pre class="programlisting">
1.132 spz 7851: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 7852: </pre>
1.75 rillig 7853: </li>
1.132 spz 7854: <li class="listitem"><p>If your package needs a library with which to link and
7855: there is no <code class="filename">buildlink3.mk</code> file
7856: available, create one. Using
7857: <code class="varname">DEPENDS</code> won't be sufficient because the
7858: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7859: <li class="listitem">
1.132 spz 7860: <p>If your package needs some executable to be able to run
7861: correctly and if there's no
7862: <code class="filename">buildlink3.mk</code> file, this is specified
7863: using the <code class="varname">DEPENDS</code> variable. The
7864: <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
7865: be able to execute the latex binary from the teTeX package
7866: when it runs, and that is specified:</p>
1.75 rillig 7867: <pre class="programlisting">
1.132 spz 7868: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7869: </pre>
1.132 spz 7870: </li>
7871: <li class="listitem">
7872: <p>You can use wildcards in package dependencies. Note that
7873: such wildcard dependencies are retained when creating binary
7874: packages. The dependency is checked when installing the binary
7875: package and any package which matches the pattern will be
7876: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7877: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7878: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7879: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7880: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7881: <p>Wildcards can also be used to specify that a package
1.87 wiz 7882: will only build against a certain minimum version of a
7883: pre-requisite:</p>
1.75 rillig 7884: <pre class="programlisting">
1.132 spz 7885: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 7886: </pre>
1.132 spz 7887: <p>This means that the package will build using version 6.0
7888: of ImageMagick or newer. Such a dependency may be warranted
7889: if, for example, the command line options of an executable
7890: have changed.</p>
7891: <p>If you need to depend on minimum versions of libraries,
7892: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7893: <p>For security fixes, please update the package
1.110 hubertf 7894: 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 7895: information.</p>
1.75 rillig 7896: </li>
1.165 bsiegert 7897: <li class="listitem">
7898: <p>If the package depends on either one of two (or more)
7899: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7900: comma-separated list between curly braces.</p>
7901: <p>As an example, take a package that depends on the Perl
7902: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7903: itself since version 5.10.0. This either/or dependency is
7904: expressed as:</p>
7905: <pre class="programlisting">
7906: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7907: </pre>
7908: </li>
1.75 rillig 7909: </ol></div>
7910: <p>If your package needs files from another package to build,
1.87 wiz 7911: add the relevant distribution files to
7912: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 7913: 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 7914: (It relies on the jpeg sources being present in source form
7915: during the build.)</p>
1.75 rillig 7916: </div>
1.148 asau 7917: <div class="sect2">
1.75 rillig 7918: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7919: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7920: <p>Your package may conflict with other packages a user might
1.87 wiz 7921: already have installed on his system, e.g. if your package
1.88 wiz 7922: installs the same set of files as another package in the pkgsrc
7923: tree.</p>
1.75 rillig 7924: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7925: space-separated list of packages (including version string) your
7926: package conflicts with.</p>
1.91 rillig 7927: <p>For example, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw3d/README.html" target="_top"><code class="filename">x11/Xaw3d</code></a>
7928: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.87 wiz 7929: install the same shared library, thus you set in
7930: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7931: <pre class="programlisting">
1.100 rillig 7932: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 7933: </pre>
7934: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7935: <pre class="programlisting">
1.100 rillig 7936: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 7937: </pre>
1.75 rillig 7938: <p>Packages will automatically conflict with other packages
1.87 wiz 7939: with the name prefix and a different version
1.128 wiz 7940: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
7941: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.75 rillig 7942: </div>
1.148 asau 7943: <div class="sect2">
1.75 rillig 7944: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7945: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7946: <p>There are several reasons why a package might be
1.88 wiz 7947: instructed to not build under certain circumstances. If the
1.87 wiz 7948: package builds and runs on most platforms, the exceptions
7949: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7950: the package builds and runs on a small handful of platforms,
7951: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7952: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7953: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7954: (OS-version-platform) that can use glob-style
7955: wildcards.</p>
1.88 wiz 7956: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 7957: 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 7958: backwards compatible with other versions of the OS, and should be
7959: uploaded to a version specific directory on the FTP server. Mark
7960: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7961: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7962: the package system internals, but may be used in the
7963: future.</p>
1.75 rillig 7964: <p>If the package should be skipped (for example, because it
1.87 wiz 7965: provides functionality already provided by the system), set
1.88 wiz 7966: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7967: the package should fail because some preconditions are not met,
7968: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7969: message.</p>
1.75 rillig 7970: </div>
1.148 asau 7971: <div class="sect2">
1.75 rillig 7972: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7973: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7974: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7975: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7976: be set in the package Makefile. This will be carried into any
7977: binary package that is made from this pkgsrc entry. A
1.128 wiz 7978: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.136 dholland 7979: 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 7980: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7981: </div>
1.148 asau 7982: <div class="sect2">
1.75 rillig 7983: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7984: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7985: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7986: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7987: and after committing that file, ask pkgsrc-security@NetBSD.org to
7988: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7989: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7990: <code class="varname">PKGREVISION</code> should be increased (this is of
7991: course not necessary if the problem is fixed by using a newer
7992: release of the software), and the pattern in the
7993: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7994: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7995: branch, be sure to submit a pullup request!</p>
1.75 rillig 7996: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7997: semi-automatically by a weekly cron job.</p>
1.75 rillig 7998: </div>
1.148 asau 7999: <div class="sect2">
1.75 rillig 8000: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8001: <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 8002: <p>When making fixes to an existing package it can be useful
1.87 wiz 8003: to change the version number in <code class="varname">PKGNAME</code>. To
8004: avoid conflicting with future versions by the original author, a
1.128 wiz 8005: <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 8006: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 8007: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8008: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 8009: <pre class="programlisting">
1.100 rillig 8010: DISTNAME= foo-17.42
8011: PKGREVISION= 9
1.87 wiz 8012: </pre>
1.75 rillig 8013: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 8014: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8015: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 8016: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8017: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8018: <p>When a new release of the package is released, the
1.87 wiz 8019: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8020: minor release of the above package, things should be like:</p>
1.75 rillig 8021: <pre class="programlisting">
1.100 rillig 8022: DISTNAME= foo-17.43
1.87 wiz 8023: </pre>
8024: <p><code class="varname">PKGREVISION</code> should be incremented for any
8025: non-trivial change in the resulting binary package. Without a
8026: <code class="varname">PKGREVISION</code> bump, someone with the previous
8027: version installed has no way of knowing that their package is out
8028: of date. Thus, changes without increasing
8029: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8030: trivial that no reasonable person would want to upgrade", and this
8031: is the rough test for when increasing
8032: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8033: changes that do not merit increasing
8034: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 8035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8036: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 8037: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8038: or comments in Makefile.</p></li>
1.128 wiz 8039: <li class="listitem"><p>
1.100 rillig 8040: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 8041: <li class="listitem"><p>
1.100 rillig 8042: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8043: <li class="listitem"><p>
1.100 rillig 8044: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8045: </ul></div>
1.87 wiz 8046: <p>Examples of changes that do merit an increase to
8047: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 8048: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8049: <li class="listitem"><p>
1.100 rillig 8050: Security fixes</p></li>
1.128 wiz 8051: <li class="listitem"><p>
1.100 rillig 8052: Changes or additions to a patch file</p></li>
1.128 wiz 8053: <li class="listitem"><p>
1.100 rillig 8054: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8055: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8056: </ul></div>
1.78 rillig 8057: <p>PKGREVISION must also be incremented when dependencies have ABI
8058: changes.</p>
1.75 rillig 8059: </div>
1.148 asau 8060: <div class="sect2">
1.79 rillig 8061: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8062: <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 8063: <p>When you want to replace the same text in multiple files
1.87 wiz 8064: or when the replacement text varies, patches alone cannot help.
8065: This is where the SUBST framework comes in. It provides an
8066: easy-to-use interface for replacing text in files.
8067: Example:</p>
8068: <pre class="programlisting">
1.100 rillig 8069: SUBST_CLASSES+= fix-paths
8070: SUBST_STAGE.fix-paths= pre-configure
8071: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8072: SUBST_FILES.fix-paths= src/*.c
8073: SUBST_FILES.fix-paths+= scripts/*.sh
8074: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8075: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8076: </pre>
1.79 rillig 8077: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8078: that are used to identify the different SUBST blocks that are
8079: defined. The SUBST framework is heavily used by pkgsrc, so it is
8080: important to always use the <code class="literal">+=</code> operator with
8081: this variable. Otherwise some substitutions may be
8082: skipped.</p>
1.79 rillig 8083: <p>The remaining variables of each SUBST block are
1.87 wiz 8084: parameterized with the identifier from the first line
8085: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8086: parameters to a function call.</p>
1.79 rillig 8087: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8088: which the replacement will take place. All combinations of
8089: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8090: <code class="literal">post-</code> together with a phase name are
8091: possible, though only few are actually used. Most commonly used
8092: are <code class="literal">post-patch</code> and
8093: <code class="literal">pre-configure</code>. Of these two,
8094: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8095: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8096: have the state after applying the patches but before making any
8097: other changes. This is especially useful when you are debugging
8098: a package in order to create new patches for it. Similarly,
8099: <code class="literal">post-build</code> is preferred over
8100: <code class="literal">pre-install</code>, because the install phase should
8101: generally be kept as simple as possible. When you use
8102: <code class="literal">post-build</code>, you have the same files in the
8103: working directory that will be installed later, so you can check
8104: if the substitution has succeeded.</p>
1.79 rillig 8105: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8106: that is printed just before the substitution is done.</p>
1.79 rillig 8107: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8108: globbing patterns that specifies the files in which the
8109: substitution will take place. The patterns are interpreted
8110: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8111: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.136 dholland 8112: <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 8113: command should be prefixed with <code class="literal">-e</code>, so that
8114: all SUBST blocks look uniform.</p>
1.79 rillig 8115: <p>There are some more variables, but they are so seldomly
1.87 wiz 8116: used that they are only documented in the
8117: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8118: </div>
1.75 rillig 8119: </div>
1.148 asau 8120: <div class="sect1">
1.75 rillig 8121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8122: <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 8123: <div class="sect2">
1.75 rillig 8124: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8125: <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 8126: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8127: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8128: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8129: with the name of each file to download as an argument, expecting
8130: it to output the URL of the directory from which to download
1.91 rillig 8131: 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 8132: example of this usage.</p>
1.75 rillig 8133: <p>If the download can't be automated, because the user must
1.87 wiz 8134: submit personal information to apply for a password, or must pay
8135: for the source, or whatever, you can set
8136: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8137: displayed to the user before aborting the build. Example:</p>
8138: <pre class="programlisting">
1.100 rillig 8139: FETCH_MESSAGE= "Please download the files"
8140: FETCH_MESSAGE+= " "${DISTFILES:Q}
8141: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8142: </pre>
1.75 rillig 8143: </div>
1.148 asau 8144: <div class="sect2">
1.75 rillig 8145: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8146: <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 8147: <p>Sometimes authors of a software package make some
1.87 wiz 8148: modifications after the software was released, and they put up a
8149: new distfile without changing the package's version number. If a
8150: package is already in pkgsrc at that time, the checksum will
8151: no longer match. The contents of the new distfile should be
8152: compared against the old one before changing anything, to make
8153: sure the distfile was really updated on purpose, and that
8154: no trojan horse or so crept in.
1.97 rillig 8155: Please mention that the distfiles were compared and what was found
1.159 rodent 8156: in your commit message.</p>
8157: <p>Then, the correct way to work around this is to
1.87 wiz 8158: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8159: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8160: <code class="varname">DISTFILES</code> and
1.93 rillig 8161: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8162: subdirectory of the local distfiles directory.
1.110 hubertf 8163: (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 8164: In case this
1.87 wiz 8165: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8166: including the <code class="filename">nbX</code> suffix) or a date stamp
1.159 rodent 8167: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8168: <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>
8169: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8170: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8171: path in the filenames.
1.159 rodent 8172: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8173: Furthermore, a mail to the package's authors seems appropriate
8174: telling them that changing distfiles after releases without
8175: changing the file names is not good practice.</p>
1.75 rillig 8176: </div>
8177: </div>
1.148 asau 8178: <div class="sect1">
1.75 rillig 8179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8180: <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 8181: <div class="sect2">
1.75 rillig 8182: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8183: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8184: <p>pkgsrc supports many different machines, with different
1.87 wiz 8185: object formats like a.out and ELF, and varying abilities to do
8186: shared library and dynamic loading at all. To accompany this,
8187: varying commands and options have to be passed to the
8188: compiler, linker, etc. to get the Right Thing, which can be
8189: pretty annoying especially if you don't have all the machines
8190: at your hand to test things. The
1.91 rillig 8191: <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 8192: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8193: both static and dynamic libraries from a set of source files,
8194: thus being platform-independent.</p>
8195: <p>Here's how to use libtool in a package in seven simple
8196: steps:</p>
1.128 wiz 8197: <div class="orderedlist"><ol class="orderedlist" type="1">
8198: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8199: Makefile.</p></li>
1.128 wiz 8200: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8201: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8202: add it to the definition of <code class="varname">CC</code>, if only
8203: libraries are being built in a given Makefile. This one command
8204: will build both PIC and non-PIC library objects, so you need not
8205: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8206: <li class="listitem">
1.75 rillig 8207: <p>For the linking of the library, remove any
1.128 wiz 8208: <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
8209: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8210: <pre class="programlisting">
1.100 rillig 8211: ${LIBTOOL} --mode=link \
8212: ${CC} -o ${.TARGET:.a=.la} \
8213: ${OBJS:.o=.lo} \
8214: -rpath ${PREFIX}/lib \
8215: -version-info major:minor
1.87 wiz 8216: </pre>
1.75 rillig 8217: <p>Note that the library is changed to have a
1.87 wiz 8218: <code class="filename">.la</code> extension, and the objects are
8219: changed to have a <code class="filename">.lo</code>
8220: extension. Change <code class="varname">OBJS</code> as
8221: necessary. This automatically creates all of the
8222: <code class="filename">.a</code>,
8223: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8224: necessary) in the build directory. Be sure to include
1.128 wiz 8225: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8226: minor are zero, as libtool will otherwise strip off the
8227: shared library version.</p>
1.75 rillig 8228: <p>From the libtool manual:</p>
8229: <pre class="programlisting">
1.100 rillig 8230: So, libtool library versions are described by three integers:
1.69 rillig 8231:
1.100 rillig 8232: CURRENT
8233: The most recent interface number that this library implements.
1.69 rillig 8234:
1.100 rillig 8235: REVISION
8236: The implementation number of the CURRENT interface.
1.69 rillig 8237:
1.100 rillig 8238: AGE
8239: The difference between the newest and oldest interfaces that
8240: this library implements. In other words, the library implements
8241: all the interface numbers in the range from number `CURRENT -
8242: AGE' to `CURRENT'.
1.1 grant 8243:
1.100 rillig 8244: If two libraries have identical CURRENT and AGE numbers, then the
8245: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8246: </pre>
1.128 wiz 8247: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8248: different results for a.out and ELF (excluding symlinks)
8249: in only one case. An ELF library of the form
1.128 wiz 8250: <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 8251: will have a symlink of
1.128 wiz 8252: <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 8253: on an a.out platform. This is handled
8254: automatically.</p>
1.128 wiz 8255: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8256: directory of the library being built.</p>
1.76 rillig 8257: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8258: <code class="filename">.la</code> file, the other files will be
8259: added automatically.</p>
1.75 rillig 8260: </li>
1.128 wiz 8261: <li class="listitem">
1.76 rillig 8262: <p>When linking shared object (<code class="filename">.so</code>)
1.136 dholland 8263: 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 8264: shared libraries, use <span class="quote">“<span class="quote">-module
8265: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8266: tacked on.</p>
1.76 rillig 8267: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8268: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8269: </li>
1.128 wiz 8270: <li class="listitem">
1.75 rillig 8271: <p>When linking programs that depend on these libraries
1.87 wiz 8272: <span class="emphasis"><em>before</em></span> they are installed, preface
1.136 dholland 8273: 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 8274: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8275: libraries (static or shared), but please be aware that
8276: libtool will not allow you to specify a relative path in
1.128 wiz 8277: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8278: expects you to change that argument to be the
8279: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8280: <pre class="programlisting">
1.100 rillig 8281: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8282: </pre>
1.75 rillig 8283: <p>should be changed to:</p>
8284: <pre class="programlisting">
1.100 rillig 8285: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8286: </pre>
1.75 rillig 8287: <p>and it will do the right thing with the libraries.</p>
8288: </li>
1.128 wiz 8289: <li class="listitem">
1.136 dholland 8290: <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>
8291: 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 8292: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8293: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8294: <pre class="programlisting">
1.126 jakllsch 8295: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8296: </pre>
1.76 rillig 8297: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8298: shared library, any needed symlinks, and run
1.136 dholland 8299: <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 8300: </li>
1.128 wiz 8301: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8302: the <code class="filename">.la</code>
8303: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8304: </ol></div>
8305: </div>
1.148 asau 8306: <div class="sect2">
1.75 rillig 8307: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8308: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8309: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8310: package Makefile. This will override the package's own libtool
8311: in most cases. For older libtool using packages, libtool is
8312: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8313: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8314: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8315: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8316: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8317: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8318: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8319: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8320: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8321: libraries built and installed, then use
8322: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8323: <p>If your package makes use of the platform-independent library
1.87 wiz 8324: for loading dynamic shared objects, that comes with libtool
8325: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8326: <p>Some packages use libtool incorrectly so that the package
8327: may not work or build in some circumstances. Some of the more
8328: common errors are:</p>
1.148 asau 8329: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8330: <li class="listitem">
1.75 rillig 8331: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8332: executable or library. This in itself isn't a problem if one of two things
8333: has been done:</p>
1.128 wiz 8334: <div class="orderedlist"><ol class="orderedlist" type="1">
8335: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8336: <code class="filename">libfoo.la</code>, not
8337: <code class="filename">foo.la</code></p></li>
1.128 wiz 8338: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8339: </ol></div>
8340: </li>
1.128 wiz 8341: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8342: The function lt_dlinit() should be called and the macro
8343: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8344: executables.</p></li>
1.75 rillig 8345: </ul></div>
8346: </div>
1.148 asau 8347: <div class="sect2">
1.75 rillig 8348: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8349: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8350: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8351: to regenerate the configure script and Makefile.in makefile
8352: templates, then they should be executed in a pre-configure
8353: target.</p>
1.75 rillig 8354: <p>For packages that need only autoconf:</p>
8355: <pre class="programlisting">
1.100 rillig 8356: AUTOCONF_REQD= 2.50 # if default version is not good enough
8357: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8358: ...
1.1 grant 8359:
1.100 rillig 8360: pre-configure:
8361: cd ${WRKSRC} && autoconf
1.1 grant 8362:
1.100 rillig 8363: ...
1.87 wiz 8364: </pre>
1.75 rillig 8365: <p>and for packages that need automake and autoconf:</p>
8366: <pre class="programlisting">
1.100 rillig 8367: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8368: USE_TOOLS+= automake # use "automake14" for automake-1.4
8369: ...
8370:
8371: pre-configure:
8372: set -e; cd ${WRKSRC}; \
8373: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8374:
1.100 rillig 8375: ...
1.87 wiz 8376: </pre>
1.75 rillig 8377: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8378: require GNU Make.</p>
1.75 rillig 8379: <p>There are times when the configure process makes
1.87 wiz 8380: additional changes to the generated files, which then causes
8381: the build process to try to re-execute the automake sequence.
8382: This is prevented by touching various files in the configure
8383: stage. If this causes problems with your package you can set
8384: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8385: Makefile.</p>
1.75 rillig 8386: </div>
8387: </div>
1.148 asau 8388: <div class="sect1">
1.75 rillig 8389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8390: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 8391: <div class="sect2">
1.87 wiz 8392: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8393: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8394: <p>Compilers for the C, C++, and Fortran languages comes with
8395: the NetBSD base system. By default, pkgsrc assumes that a package
8396: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8397: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8398: <p>To declare which language's compiler a package needs, set
8399: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8400: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8401: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8402: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8403: written in C++, usually need a C compiler for the configure
8404: phase.</p>
8405: </div>
1.148 asau 8406: <div class="sect2">
1.87 wiz 8407: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8408: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8409: <p>If a program is written in Java, use the Java framework in
8410: pkgsrc. The package must include
8411: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8412: provides the following variables:</p>
1.148 asau 8413: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8414: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8415: dependency on the JDK is added. If
1.128 wiz 8416: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8417: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8418: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8419: JDK.</p></li>
1.128 wiz 8420: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8421: a package needs a Java2 implementation. The supported values
1.128 wiz 8422: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8423: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8424: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8425: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8426: above. This variable is not set by default.</p></li>
1.130 wiz 8427: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8428: automatically set to the runtime location of the used Java
8429: implementation dependency. It may be used to set
8430: <code class="varname">JAVA_HOME</code> to a good value if the program
8431: needs this variable to be defined.
8432: </p></li>
1.87 wiz 8433: </ul></div>
8434: </div>
1.148 asau 8435: <div class="sect2">
1.87 wiz 8436: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8437: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8438: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8439: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8440: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8441: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8442: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8443: that you want adjusted. Every occurrence of
8444: <code class="filename">*/bin/perl</code> will be replaced with the full
8445: path to the perl executable.</p>
8446: <p>If a particular version of perl is needed, set the
8447: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8448: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8449: <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 8450: about handling perl modules.</p>
8451: </div>
1.148 asau 8452: <div class="sect2">
1.87 wiz 8453: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8454: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8455: <p><code class="varname">REPLACE_SH</code>,
8456: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8457: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8458: hash bangs in files. Please use the appropriate one, prefering
8459: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
8460: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8461: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8462: </div>
1.148 asau 8463: <div class="sect2">
1.147 wiz 8464: <div class="titlepage"><div><div><h3 class="title">
8465: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8466: <p>Currently, there is no special handling for other languages
8467: in pkgsrc. If a compiler package provides a
8468: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8469: just add a (build) dependency on the appropriate compiler
8470: package.</p>
8471: </div>
8472: </div>
1.148 asau 8473: <div class="sect1">
1.87 wiz 8474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8475: <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 8476: <p>The most common failures when building a package are that
8477: some platforms do not provide certain header files, functions or
8478: libraries, or they provide the functions in a library that the
8479: original package author didn't know. To work around this, you
8480: can rewrite the source code in most cases so that it does not
8481: use the missing functions or provides a replacement function.</p>
1.148 asau 8482: <div class="sect2">
1.77 rillig 8483: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8484: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8485: <p>If a package already comes with a GNU configure script, the
8486: preferred way to fix the build failure is to change the
8487: configure script, not the code. In the other cases, you can
8488: utilize the C preprocessor, which defines certain macros
8489: depending on the operating system and hardware architecture it
8490: compiles for. These macros can be queried using for example
8491: <code class="varname">#if defined(__i386)</code>. Almost every operating
8492: system, hardware architecture and compiler has its own macro.
8493: For example, if the macros <code class="varname">__GNUC__</code>,
8494: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8495: are all defined, you know that you are using NetBSD on an i386
8496: compatible CPU, and your compiler is GCC.</p>
8497: <p>The list of the following macros for hardware and
8498: operating system depends on the compiler that is used. For
8499: example, if you want to conditionally compile code on Solaris,
8500: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8501: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8502: <div class="sect3">
1.75 rillig 8503: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8504: <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 8505: <p>To distinguish between 4.4 BSD-derived systems and the
8506: rest of the world, you should use the following code.</p>
8507: <pre class="programlisting">
1.100 rillig 8508: #include <sys/param.h>
8509: #if (defined(BSD) && BSD >= 199306)
8510: /* BSD-specific code goes here */
8511: #else
8512: /* non-BSD-specific code goes here */
8513: #endif
1.75 rillig 8514: </pre>
1.77 rillig 8515: <p>If this distinction is not fine enough, you can also test
8516: for the following macros.</p>
1.75 rillig 8517: <pre class="programlisting">
1.151 obache 8518: Cygwin __CYGWIN__
8519: DragonFly __DragonFly__
1.100 rillig 8520: FreeBSD __FreeBSD__
1.151 obache 8521: Haiku __HAIKU__
1.100 rillig 8522: Interix __INTERIX
8523: IRIX __sgi (TODO: get a definite source for this)
8524: Linux linux, __linux, __linux__
1.151 obache 8525: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8526: Minix3 __minix
1.100 rillig 8527: NetBSD __NetBSD__
8528: OpenBSD __OpenBSD__
8529: Solaris sun, __sun
1.75 rillig 8530: </pre>
8531: </div>
1.148 asau 8532: <div class="sect3">
1.75 rillig 8533: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8534: <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 8535: <pre class="programlisting">
1.100 rillig 8536: i386 i386, __i386, __i386__
8537: MIPS __mips
8538: SPARC sparc, __sparc
1.75 rillig 8539: </pre>
8540: </div>
1.148 asau 8541: <div class="sect3">
1.75 rillig 8542: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8543: <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 8544: <pre class="programlisting">
1.100 rillig 8545: GCC __GNUC__ (major version), __GNUC_MINOR__
8546: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8547: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8548: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8549: </pre>
8550: </div>
8551: </div>
1.148 asau 8552: <div class="sect2">
1.78 rillig 8553: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8554: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8555: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8556: combinations of compiler version and architecture and almost
8557: always relation to optimisation being enabled. Common symptoms
8558: are gcc internal errors or never finishing compiling a
1.78 rillig 8559: file.</p>
8560: <p>Typically, a workaround involves testing the
8561: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8562: optimisation for that combination of file,
8563: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8564: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8565: number of examples.</p>
8566: </div>
1.148 asau 8567: <div class="sect2">
1.78 rillig 8568: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8569: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8570: </h3></div></div></div>
1.92 rillig 8571: <p>This error message often means that a package did not
1.78 rillig 8572: link to a shared library it needs. The following functions are
8573: known to cause this error message over and over.</p>
8574: <div class="informaltable">
8575: <a name="undefined-reference-functions"></a><table border="1">
8576: <colgroup>
8577: <col>
8578: <col>
8579: <col>
8580: </colgroup>
8581: <thead><tr>
8582: <th>Function</th>
8583: <th>Library</th>
8584: <th>Affected platforms</th>
8585: </tr></thead>
8586: <tbody>
8587: <tr>
8588: <td>accept, bind, connect</td>
8589: <td>-lsocket</td>
8590: <td>Solaris</td>
8591: </tr>
8592: <tr>
8593: <td>crypt</td>
8594: <td>-lcrypt</td>
8595: <td>DragonFly, NetBSD</td>
8596: </tr>
8597: <tr>
8598: <td>dlopen, dlsym</td>
8599: <td>-ldl</td>
8600: <td>Linux</td>
8601: </tr>
8602: <tr>
8603: <td>gethost*</td>
8604: <td>-lnsl</td>
8605: <td>Solaris</td>
8606: </tr>
8607: <tr>
8608: <td>inet_aton</td>
8609: <td>-lresolv</td>
8610: <td>Solaris</td>
8611: </tr>
8612: <tr>
8613: <td>nanosleep, sem_*, timer_*</td>
8614: <td>-lrt</td>
8615: <td>Solaris</td>
8616: </tr>
8617: <tr>
8618: <td>openpty</td>
8619: <td>-lutil</td>
8620: <td>Linux</td>
8621: </tr>
8622: </tbody>
8623: </table>
8624: </div>
8625: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8626: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8627: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8628: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8629: bmake</strong></span>.</p>
1.148 asau 8630: <div class="sect3">
1.92 rillig 8631: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8632: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8633: <p>When you are using the SunPro compiler, there is another
8634: possibility. That compiler cannot handle the following code:</p>
8635: <pre class="programlisting">
1.100 rillig 8636: extern int extern_func(int);
1.93 rillig 8637:
1.100 rillig 8638: static inline int
8639: inline_func(int x)
8640: {
1.92 rillig 8641: return extern_func(x);
1.100 rillig 8642: }
1.93 rillig 8643:
1.100 rillig 8644: int main(void)
8645: {
1.92 rillig 8646: return 0;
1.100 rillig 8647: }
1.92 rillig 8648: </pre>
8649: <p>It generates the code for <code class="function">inline_func</code> even if
8650: that function is never used. This code then refers to
8651: <code class="function">extern_func</code>, which can usually not be resolved. To
8652: solve this problem you can try to tell the package to disable inlining
8653: of functions.</p>
8654: </div>
1.87 wiz 8655: </div>
1.148 asau 8656: <div class="sect2">
1.87 wiz 8657: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8658: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8659: <p>Sometimes packages fail to build because the compiler runs
8660: into an operating system specific soft limit. With the
8661: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8662: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8663: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8664: Setting this variable is similar to running the shell builtin
1.110 hubertf 8665: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8666: segment size or maximum stack size of a process, respectively, to
8667: their hard limits.</p>
1.78 rillig 8668: </div>
1.75 rillig 8669: </div>
1.148 asau 8670: <div class="sect1">
1.75 rillig 8671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8672: <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 8673: <div class="sect2">
1.75 rillig 8674: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8675: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8676: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8677: with some operating systems cannot create more than one
8678: directory at a time. As such, you should call
8679: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8680: <pre class="programlisting">
1.100 rillig 8681: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8682: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8683: </pre>
1.128 wiz 8684: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8685: dir2</code></span>”</span> to the
1.87 wiz 8686: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8687: automatically do the right thing.</p>
1.75 rillig 8688: </div>
1.148 asau 8689: <div class="sect2">
1.75 rillig 8690: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8691: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8692: <p>In general, documentation should be installed into
1.87 wiz 8693: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8694: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8695: includes the version number of the package).</p>
1.84 wiz 8696: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8697: directory where HTML documentation is installed with the
1.128 wiz 8698: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8699: is needed because otherwise the documentation ends up in
8700: <code class="filename">${PREFIX}/share/doc/html</code> or other
8701: places.</p>
8702: <p>An exception to the above is that library API documentation
1.91 rillig 8703: 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 8704: browsers (devhelp) should be left at their default location, which
8705: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8706: documentation can be recognized from files ending in
8707: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8708: (It is also acceptable to install such files in
8709: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8710: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8711: <code class="filename">.devhelp*</code> file must be directly in that
8712: directory then, no additional subdirectory level is allowed in
8713: this case. This is usually achieved by using
1.128 wiz 8714: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8715: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8716: though.)</p>
1.75 rillig 8717: </div>
1.148 asau 8718: <div class="sect2">
1.75 rillig 8719: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8720: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8721: <p>Certain packages, most of them in the games category, install
1.87 wiz 8722: a score file that allows all users on the system to record their
8723: highscores. In order for this to work, the binaries need to be
8724: installed setgid and the score files owned by the appropriate
1.142 wiz 8725: group and/or owner (traditionally the "games" user/group). Set
8726: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8727: following variables, documented in more detail in
8728: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8729: behaviour: <code class="varname">GAMEDATAMODE</code>,
8730: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8731: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 8732: <p>A package should therefore never hard code file ownership or
1.87 wiz 8733: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8734: <code class="varname">INSTALL_GAME_DATA</code> to set these
8735: correctly.</p>
1.75 rillig 8736: </div>
1.148 asau 8737: <div class="sect2">
1.75 rillig 8738: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8739: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8740: <p><code class="varname">DESTDIR</code> support means that a package
8741: installs into a staging directory, not the final location of the
8742: files. Then a binary package is created which can be used for
8743: installation as usual. There are two ways: Either the package must
1.128 wiz 8744: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8745: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8746: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8747: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 8748: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8749: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8750: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8751: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8752: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8753: the inclusion.</p></li>
1.128 wiz 8754: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8755: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8756: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8757: automatically. Many manual rules and pre/post-install often are
8758: incorrect; fix them.</p></li>
1.128 wiz 8759: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8760: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8761: <li class="listitem"><p>In general, packages should support
1.103 wiz 8762: <code class="varname">UNPRIVILEGED</code> to be able to use
8763: DESTDIR.</p></li>
8764: </ul></div>
8765: </div>
1.148 asau 8766: <div class="sect2">
1.103 wiz 8767: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8768: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8769: <p>Your package may also contain scripts with hardcoded paths to
8770: other interpreters besides (or as well as) perl. To correct the
8771: full pathname to the script interpreter, you need to set the
8772: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8773: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8774: <pre class="programlisting">
1.100 rillig 8775: REPLACE_INTERPRETER+= tcl
8776: REPLACE.tcl.old= .*/bin/tclsh
8777: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8778: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8779: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8780: </pre>
1.148 asau 8781: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8782: <h3 class="title">Note</h3>
8783: <p>Before March 2006, these variables were called
1.87 wiz 8784: <code class="varname">_REPLACE.*</code> and
8785: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8786: </div>
8787: </div>
1.148 asau 8788: <div class="sect2">
1.75 rillig 8789: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8790: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8791: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8792: the Makefile fragment
8793: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8794: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8795: configuration for such modules as well as various hooks to tune
8796: this configuration. See comments in this file for
8797: details.</p>
1.75 rillig 8798: <p>Perl5 modules will install into different places depending
1.87 wiz 8799: on the version of perl used during the build process. To
8800: address this, pkgsrc will append lines to the
8801: <code class="filename">PLIST</code> corresponding to the files listed in
8802: the installed <code class="filename">.packlist</code> file generated by
8803: most perl5 modules. This is invoked by defining
8804: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8805: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8806: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8807: e.g.:</p>
1.75 rillig 8808: <pre class="programlisting">
1.153 wiz 8809: PERL5_PACKLIST= auto/Pg/.packlist
1.87 wiz 8810: </pre>
1.153 wiz 8811: <p>The perl5 config variables
8812: <code class="varname">installarchlib</code>,
8813: <code class="varname">installscript</code>,
8814: <code class="varname">installvendorbin</code>,
8815: <code class="varname">installvendorscript</code>,
8816: <code class="varname">installvendorarch</code>,
8817: <code class="varname">installvendorlib</code>,
8818: <code class="varname">installvendorman1dir</code>, and
8819: <code class="varname">installvendorman3dir</code> represent those
8820: locations in which components of perl5 modules may be installed,
8821: provided as variable with uppercase and prefixed with
8822: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8823: and may be used by perl5 packages that don't have a packlist.
8824: These variables are also substituted for in the
8825: <code class="filename">PLIST</code> as uppercase prefixed with
8826: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8827: </div>
1.148 asau 8828: <div class="sect2">
1.75 rillig 8829: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8830: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8831: <p>Some packages install info files or use the
1.128 wiz 8832: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8833: commands. <code class="varname">INFO_FILES</code> should be defined in
8834: the package Makefile so that <code class="filename">INSTALL</code> and
8835: <code class="filename">DEINSTALL</code> scripts will be generated to
8836: handle registration of the info files in the Info directory
1.128 wiz 8837: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8838: files registration is either provided by the system, or by a
8839: special purpose package automatically added as dependency if
8840: needed.</p>
1.75 rillig 8841: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8842: <code class="filename">${PREFIX}</code> where info files are primarily
8843: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8844: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8845: <p>The info files for the package should be listed in the
1.87 wiz 8846: package <code class="filename">PLIST</code>; however any split info files
8847: need not be listed.</p>
1.128 wiz 8848: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8849: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8850: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8851: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8852: should be noted with the <code class="varname">TEXINFO_REQD</code>
8853: variable in the package <code class="filename">Makefile</code>. By
8854: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8855: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8856: does not match the required minimum, a build dependency on the
1.91 rillig 8857: <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 8858: be added automatically.</p>
1.75 rillig 8859: <p>The build and installation process of the software provided
1.87 wiz 8860: by the package should not use the
1.110 hubertf 8861: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8862: info files is the task of the package
8863: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8864: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8865: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8866: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8867: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8868: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8869: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8870: no effect except the logging of a message. The script overriding
1.110 hubertf 8871: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8872: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8873: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8874: </div>
1.148 asau 8875: <div class="sect2">
1.75 rillig 8876: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8877: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8878: <p>All packages that install manual pages should install them
1.87 wiz 8879: into the same directory, so that there is one common place to look
8880: for them. In pkgsrc, this place is
8881: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8882: should be used in packages. The default for
8883: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8884: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8885: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8886: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8887: <h3 class="title">Note</h3>
1.87 wiz 8888: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8889: is far from complete.</p>
1.75 rillig 8890: </div>
1.81 rillig 8891: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8892: <code class="filename">man/</code> as the top level directory for the man
8893: page file entries, and the pkgsrc framework will convert as
8894: needed. In all other places, the correct
8895: <code class="varname">PKGMANDIR</code> must be used.</p>
8896: <p>Packages that are
8897: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8898: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8899: <code class="filename">./configure</code>
8900: --mandir switch to set where the man pages should be installed.
8901: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8902: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8903: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8904: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8905: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8906: Or if the <code class="filename">./configure</code> script uses
8907: a non-standard use of --mandir, you can set
8908: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8909: <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 8910: information on installation of compressed manual pages.</p>
1.75 rillig 8911: </div>
1.148 asau 8912: <div class="sect2">
1.75 rillig 8913: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8914: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8915: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8916: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8917: you need to take some extra steps to make sure they get registered
8918: in the database:</p>
1.128 wiz 8919: <div class="orderedlist"><ol class="orderedlist" type="1">
8920: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8921: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8922: takes care of rebuilding the GConf database at installation and
1.87 wiz 8923: deinstallation time, and tells the package where to install
1.107 rillig 8924: GConf data files using some standard configure arguments. It
1.87 wiz 8925: also disallows any access to the database directly from the
8926: package.</p></li>
1.128 wiz 8927: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8928: <code class="filename">.schemas</code> files under
8929: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8930: installed under <code class="filename">${PREFIX}/etc</code>, you will
8931: need to manually patch the package.</p></li>
1.128 wiz 8932: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8933: directory, as they will be handled automatically. See
1.173 wiz 8934: <a class="xref" href="#faq.conf" title="9.14. How do I change the location of configuration files?">Section 9.14, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.128 wiz 8935: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8936: your <code class="filename">Makefile</code> with a list of all
8937: <code class="filename">.schemas</code> files installed by the package, if
8938: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8939: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8940: your <code class="filename">Makefile</code> with a
8941: list of all <code class="filename">.entries</code> files installed by the
8942: package, if any. Names must not contain any directories in
8943: them.</p></li>
1.75 rillig 8944: </ol></div>
8945: </div>
1.148 asau 8946: <div class="sect2">
1.75 rillig 8947: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 8948: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8949: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8950: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8951: get registered in the database:</p>
1.128 wiz 8952: <div class="orderedlist"><ol class="orderedlist" type="1">
8953: <li class="listitem"><p>Include
1.119 mishka 8954: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8955: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8956: takes care of rebuilding the scrollkeeper database at
8957: installation and deinstallation time, and disallows any access
8958: to it directly from the package.</p></li>
1.128 wiz 8959: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8960: <code class="filename">libdata/scrollkeeper</code> directory, as they
8961: will be handled automatically.</p></li>
1.128 wiz 8962: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 8963: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8964: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 8965: </ol></div>
8966: </div>
1.148 asau 8967: <div class="sect2">
1.75 rillig 8968: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8969: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8970: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8971: the fonts database in the directory where they get installed at
8972: installation and deinstallation time. This can be automatically
8973: done by using the pkginstall framework.</p>
1.75 rillig 8974: <p>You can list the directories where fonts are installed in the
1.87 wiz 8975: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8976: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 8977: <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 8978: Also make sure that the database file
8979: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8980: <p>Note that you should not create new directories for fonts;
1.87 wiz 8981: instead use the standard ones to avoid that the user needs to
8982: manually configure his X server to find them.</p>
1.75 rillig 8983: </div>
1.148 asau 8984: <div class="sect2">
1.75 rillig 8985: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8986: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8987: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8988: take some extra steps to get them registered in the GTK2 database
8989: properly:</p>
1.128 wiz 8990: <div class="orderedlist"><ol class="orderedlist" type="1">
8991: <li class="listitem"><p>Include
1.87 wiz 8992: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8993: <code class="filename">buildlink3.mk</code> file. This takes care of
8994: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 8995: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 8996: your package installs GTK2 immodules.</p></li>
1.128 wiz 8997: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 8998: GTK2 loaders.</p></li>
1.128 wiz 8999: <li class="listitem">
1.87 wiz 9000: <p>Patch the package to not touch any of the GTK2
9001: databases directly. These are:</p>
1.148 asau 9002: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9003: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9004: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9005: </ul></div>
9006: </li>
1.128 wiz 9007: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 9008: any entries under the <code class="filename">libdata/gtk-2.0</code>
9009: directory, as they will be handled automatically.</p></li>
1.75 rillig 9010: </ol></div>
9011: </div>
1.148 asau 9012: <div class="sect2">
1.75 rillig 9013: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9014: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9015: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9016: registered in system-wide catalogs (like DTDs, sub-catalogs,
9017: etc.), you need to take some extra steps:</p>
1.128 wiz 9018: <div class="orderedlist"><ol class="orderedlist" type="1">
9019: <li class="listitem"><p>Include
1.87 wiz 9020: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9021: your <code class="filename">Makefile</code>, which takes care of
9022: registering those files in system-wide catalogs at
9023: installation and deinstallation time.</p></li>
1.128 wiz 9024: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9025: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9026: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9027: any XML catalogs installed by the package.</p></li>
1.128 wiz 9028: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9029: to be added to the SGML catalog. These come in groups of
9030: three strings; see xmlcatmgr(1) for more information
9031: (specifically, arguments recognized by the 'add' action).
9032: Note that you will normally not use this variable.</p></li>
1.128 wiz 9033: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9034: to be added to the XML catalog. These come in groups of three
9035: strings; see xmlcatmgr(1) for more information (specifically,
9036: arguments recognized by the 'add' action). Note that you will
9037: normally not use this variable.</p></li>
1.75 rillig 9038: </ol></div>
9039: </div>
1.148 asau 9040: <div class="sect2">
1.75 rillig 9041: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9042: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9043: <p>If a package provides extensions to the MIME database by
1.87 wiz 9044: installing <code class="filename">.xml</code> files inside
9045: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9046: need to take some extra steps to ensure that the database is kept
9047: consistent with respect to these new files:</p>
1.128 wiz 9048: <div class="orderedlist"><ol class="orderedlist" type="1">
9049: <li class="listitem"><p>Include
1.87 wiz 9050: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9051: (avoid using the <code class="filename">buildlink3.mk</code> file from
9052: this same directory, which is reserved for inclusion from
9053: other <code class="filename">buildlink3.mk</code> files). It takes
9054: care of rebuilding the MIME database at installation and
9055: deinstallation time, and disallows any access to it directly
9056: from the package.</p></li>
1.128 wiz 9057: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9058: <code class="filename">share/mime</code> directory,
9059: <span class="emphasis"><em>except</em></span> for files saved under
9060: <code class="filename">share/mime/packages</code>. The former are
9061: handled automatically by
9062: the update-mime-database program, but the latter are
9063: package-dependent and must be removed by the package that
9064: installed them in the first place.</p></li>
1.128 wiz 9065: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9066: from the PLIST. They will be handled by the shared-mime-info
9067: package.</p></li>
1.75 rillig 9068: </ol></div>
9069: </div>
1.148 asau 9070: <div class="sect2">
1.75 rillig 9071: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9072: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9073: <p>If a package uses intltool during its build, add
9074: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9075: which forces it to use the intltool package provided by pkgsrc,
9076: instead of the one bundled with the distribution file.</p>
1.75 rillig 9077: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9078: latest available version; this way, the package benefits of any
9079: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9080: </div>
1.148 asau 9081: <div class="sect2">
1.75 rillig 9082: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9083: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9084: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9085: the startup directory by default, but you can enable it, by adding
9086: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9088: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9089: it will automatically remove the scripts when the package is
9090: deinstalled.</p>
1.75 rillig 9091: </div>
1.148 asau 9092: <div class="sect2">
1.75 rillig 9093: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9094: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9095: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9096: the <code class="filename">ls-R</code> database of the tree needs to be
9097: updated.</p>
1.148 asau 9098: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9099: <h3 class="title">Note</h3>
1.125 wiz 9100: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9101: packages should install files
1.125 wiz 9102: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9103: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9104: </div>
1.128 wiz 9105: <div class="orderedlist"><ol class="orderedlist" type="1">
9106: <li class="listitem"><p>Include
1.125 wiz 9107: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9108: takes care of rebuilding the <code class="filename">ls-R</code>
9109: database at installation and deinstallation time.</p></li>
1.128 wiz 9110: <li class="listitem">
1.75 rillig 9111: <p>If your package installs files into a texmf
1.87 wiz 9112: tree other than the one
1.125 wiz 9113: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9114: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9115: trees that need database update.</p>
1.75 rillig 9116: <p>If your package also installs font map files that need
1.110 hubertf 9117: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9118: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9119: set <code class="varname">TEX_MAP_FILES</code> and/or
9120: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9121: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9122: be run automatically at installation/deinstallation to
9123: enable/disable font map files for TeX output
9124: drivers.</p>
1.75 rillig 9125: </li>
1.128 wiz 9126: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9127: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9128: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9129: </ol></div>
9130: </div>
1.148 asau 9131: <div class="sect2">
1.85 jmmv 9132: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9133: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9134: emulation</h3></div></div></div>
9135: <p>There are some packages that provide libraries and
9136: executables for running binaries from a one operating system
9137: on a different one (if the latter supports it). One example
9138: is running Linux binaries on NetBSD.</p>
1.91 rillig 9139: <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 9140: helps in extracting and packaging Linux rpm packages.</p>
9141: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9142: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9143: if all libraries for each installed executable can be found by
9144: the dynamic linker. Since the standard dynamic linker is run,
9145: this fails for emulation packages, because the libraries used
9146: by the emulation are not in the standard directories.</p>
9147: </div>
1.148 asau 9148: <div class="sect2">
1.87 wiz 9149: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9150: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9151: <p>If a package installs images under the
1.87 wiz 9152: <code class="filename">share/icons/hicolor</code> and/or updates the
9153: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9154: database, you need to take some extra steps to make sure that the
9155: shared theme directory is handled appropriately and that the cache
9156: database is rebuilt:</p>
1.128 wiz 9157: <div class="orderedlist"><ol class="orderedlist" type="1">
9158: <li class="listitem"><p>Include
1.87 wiz 9159: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9160: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9161: entry that refers to the theme cache.</p></li>
1.128 wiz 9162: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9163: directories from the <code class="filename">share/icons/hicolor</code>
9164: hierarchy because they will be handled automatically.</p></li>
9165: </ol></div>
9166: <p>The best way to verify that the PLIST is correct with
9167: respect to the last two points is to regenerate it using
1.110 hubertf 9168: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9169: </div>
1.148 asau 9170: <div class="sect2">
1.85 jmmv 9171: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9172: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9173: <p>If a package installs <code class="filename">.desktop</code> files
9174: under <code class="filename">share/applications</code> and these include
1.159 rodent 9175: MIME information (MimeType key), you need to take extra steps to
9176: ensure that they are registered into the MIME database:</p>
1.128 wiz 9177: <div class="orderedlist"><ol class="orderedlist" type="1">
9178: <li class="listitem"><p>Include
1.85 jmmv 9179: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9180: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9181: <code class="filename">share/applications/mimeinfo.cache</code> file.
9182: It will be handled automatically.</p></li>
9183: </ol></div>
9184: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9185: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9186: print-PLIST</strong></span>.</p>
1.75 rillig 9187: </div>
9188: </div>
1.148 asau 9189: <div class="sect1">
1.87 wiz 9190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9191: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9192: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9193: immediately. In this case, one can plainly mark a package as broken. For
9194: this, one just sets the variable <code class="varname">BROKEN</code> to the
9195: reason why the package is broken (similar to the
9196: <code class="varname">RESTRICTED</code> variable). A user trying to build
9197: the package will immediately be shown this message, and the build
9198: will not be even tried.</p>
9199: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9200: intervals.</p>
9201: </div>
1.75 rillig 9202: </div>
1.148 asau 9203: <div class="chapter">
1.75 rillig 9204: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9205: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9206: <p>To check out all the gotchas when building a package, here are
9207: the steps that I do in order to get a package working. Please note
9208: this is basically the same as what was explained in the previous
9209: sections, only with some debugging aids.</p>
1.148 asau 9210: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9211: <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>
9212: <li class="listitem">
1.91 rillig 9213: <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 9214: create a directory for a new package, change into it, then run
1.110 hubertf 9215: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9216: <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>
9217: <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>
9218: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9219: </li>
1.128 wiz 9220: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9221: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9222: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9223: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9224: configure step to the package's
9225: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9226: <li class="listitem">
1.75 rillig 9227: <p>Make the package compile, doing multiple rounds of</p>
9228: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9229: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9230: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9231: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9232: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9233: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9234: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9235: <p>Doing this step as non-root user will ensure that no files
9236: are modified that shouldn't be, especially during the build
1.110 hubertf 9237: phase. <span class="command"><strong>mkpatches</strong></span>,
9238: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9239: 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 9240: package.</p>
1.75 rillig 9241: </li>
1.128 wiz 9242: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9243: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9244: <li class="listitem">
1.76 rillig 9245: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9246: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9247: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9248: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9249: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9250: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9251: <p>You usually need to be <code class="username">root</code> to do
9252: this. Look if there are any files left:</p>
1.75 rillig 9253: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9254: <p>If this reveals any files that are missing in
1.88 wiz 9255: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9256: </li>
1.128 wiz 9257: <li class="listitem">
1.88 wiz 9258: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9259: package again and make a binary package:</p>
1.75 rillig 9260: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9261: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9262: </li>
1.128 wiz 9263: <li class="listitem">
1.75 rillig 9264: <p>Delete the installed package:</p>
1.88 wiz 9265: <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 9266: </li>
1.128 wiz 9267: <li class="listitem">
1.110 hubertf 9268: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9269: command, which shouldn't find anything now:</p>
1.75 rillig 9270: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9271: </li>
1.128 wiz 9272: <li class="listitem">
1.75 rillig 9273: <p>Reinstall the binary package:</p>
1.93 rillig 9274: <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 9275: </li>
1.128 wiz 9276: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9277: <li class="listitem">
1.110 hubertf 9278: <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 9279: reports:</p>
1.75 rillig 9280: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9281: </li>
1.128 wiz 9282: <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 9283: </ul></div>
9284: </div>
1.148 asau 9285: <div class="chapter">
1.75 rillig 9286: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9287: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9288: <div class="toc">
9289: <p><b>Table of Contents</b></p>
9290: <dl>
1.106 rillig 9291: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9292: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9293: <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 9294: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9295: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9296: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9297: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9298: </dl>
9299: </div>
1.148 asau 9300: <div class="sect1">
1.75 rillig 9301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9302: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9303: <p>Our policy is that we accept binaries only from pkgsrc
9304: developers to guarantee that the packages don't contain any
9305: trojan horses etc. This is not to annoy anyone but rather to
9306: protect our users! You're still free to put up your home-made
9307: binary packages and tell the world where to get them. NetBSD
9308: developers doing bulk builds and wanting to upload them please
1.174 asau 9309: 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
9310: builds)</i></a>.</p>
1.75 rillig 9311: </div>
1.148 asau 9312: <div class="sect1">
1.75 rillig 9313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9314: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9315: <p>First, check that your package is complete, compiles and
1.110 hubertf 9316: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.136 dholland 9317: 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 9318: archive that contains all files that make up the package.
1.87 wiz 9319: Finally, send this package to the pkgsrc bug tracking system,
1.136 dholland 9320: 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 9321: that, go to the web page
1.110 hubertf 9322: <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 9323: which contains some instructions and a link to a form where you
9324: can submit packages. The
9325: <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
9326: also available as a substitute for either of the above two tools.
9327: </p>
1.87 wiz 9328: <p>In the form of the problem report, the category should be
1.128 wiz 9329: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9330: and version number, and the description field should contain a
9331: short description of your package (contents of the COMMENT
9332: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9333: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9334: <p>If you want to submit several packages, please send a
9335: separate PR for each one, it's easier for us to track things
9336: that way.</p>
9337: <p>Alternatively, you can also import new packages into
1.128 wiz 9338: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9339: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9340: for details.</p>
9341: </div>
1.148 asau 9342: <div class="sect1">
1.75 rillig 9343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9344: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9345: <p>Please note all package additions, updates, moves, and
1.93 rillig 9346: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9347: important to keep this file up to date and conforming to the
9348: existing format, because it will be used by scripts to
1.110 hubertf 9349: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9350: sites. Additionally, check the
1.76 rillig 9351: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9352: for the package you updated or removed, in case it was mentioned
9353: there.</p>
9354: <p>When the <code class="varname">PKGREVISION</code> of a package is
9355: bumped, the change should appear in
1.93 rillig 9356: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9357: related or otherwise relevant. Mass bumps that result from a
9358: dependency being updated should not be mentioned. In all other
9359: cases it's the developer's decision.</p>
9360: <p>There is a make target that helps in creating proper
1.110 hubertf 9361: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9362: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9363: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9364: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9365: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9366: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9367: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9368: For new packages, or package moves or removals, set the
9369: <code class="varname">CTYPE</code> variable on the command line to "Added",
9370: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9371: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9372: not the same as your NetBSD login name. The target also automatically
9373: removes possibly existing entries for the package in the
9374: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9375: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9376: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9377: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9378: makes the cvs commands use the main repository.
9379: </p>
1.75 rillig 9380: </div>
1.148 asau 9381: <div class="sect1">
1.75 rillig 9382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9383: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9384: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9385: access to the pkgsrc repository.</p>
9386: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9387: Start by adding the directory and then files in the directory. Don't
9388: forget to add the new package to the category's
9389: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9390: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9391: <pre class="programlisting">
9392: <code class="prompt">$</code> cd .../pkgsrc/category
9393: <code class="prompt">$</code> cvs add pkgname
9394: <code class="prompt">$</code> cd pkgname
9395: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9396: <code class="prompt">$</code> cvs add patches/p*
9397: <code class="prompt">$</code> cvs status | less
1.141 wiz 9398: <code class="prompt">$</code> cvs commit
1.140 wiz 9399: <code class="prompt">$</code> cd ..
9400: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9401: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9402: <code class="prompt">$</code> cd pkgname
9403: <code class="prompt">$</code> make CTYPE=Added changes-entry
9404: <code class="prompt">$</code> make commit-changes-entry
1.140 wiz 9405: </pre>
1.87 wiz 9406: <p>The commit message of the initial import should include part of the
1.76 rillig 9407: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9408: what the package is/does.</p>
1.140 wiz 9409: <p>Also mention the new package in
9410: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9411: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9412: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9413: </div>
1.148 asau 9414: <div class="sect1">
1.75 rillig 9415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9416: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9417: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9418: changes between old and new versions into the commit log when updating
1.87 wiz 9419: a package. There are various reasons for this:</p>
1.148 asau 9420: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9421: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9422: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9423: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9424: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9425: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9426: repository is very useful for people who read the pkgsrc-changes mailing
9427: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9428: the package.</p></li>
1.75 rillig 9429: </ul></div>
1.87 wiz 9430: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9431: has been released, it should not automatically be upgraded in the CVS
9432: repository. We prefer to be conservative in the packages that are
9433: included in pkgsrc - development or beta packages are not really the
9434: best thing for most places in which pkgsrc is used. Please use your
9435: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9436: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9437: </div>
1.148 asau 9438: <div class="sect1">
1.75 rillig 9439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9440: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9441: <p>Renaming packages is not recommended.</p>
9442: <p>When renaming packages, be sure to fix any references to old name
9443: in other Makefiles, options, buildlink files, etc.</p>
9444: <p>Also When renaming a package, please define
9445: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9446: pattern(s) of the previous package name.
9447: This may be repeated for multiple renames.
9448: The new package would be an exact replacement.
9449: </p>
1.128 wiz 9450: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9451: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9452: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9453: not be an exact replacement but is a suggestion for the replaced
9454: functionality.</p>
9455: </div>
1.148 asau 9456: <div class="sect1">
1.122 reed 9457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9458: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9459: <p>It is preferred that packages are not renamed or moved, but if needed
9460: please follow these steps.
9461: </p>
1.128 wiz 9462: <div class="orderedlist"><ol class="orderedlist" type="1">
9463: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9464: <li class="listitem">
1.75 rillig 9465: <p>Remove all CVS dirs.</p>
1.87 wiz 9466: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9467: <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 9468: <p>and use that for further work.</p>
1.75 rillig 9469: </li>
1.128 wiz 9470: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9471: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9472: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9473: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9474: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9475: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9476: for doing an update using pkgsrc building; for example, it can
1.136 dholland 9477: 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 9478: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9479: new <code class="varname">PKGPATH</code> for that moved package. Note that
9480: it may have multiple matches, so the tool should also check on the
9481: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9482: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9483: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9484: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9485: place.</p></li>
1.128 wiz 9486: <li class="listitem">
1.75 rillig 9487: <p>Check if any package depends on it:
9488: </p>
9489: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9490: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9491: </li>
1.128 wiz 9492: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9493: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9494: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9495: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9496: <li class="listitem">
1.75 rillig 9497: <p>Commit the changed and removed files:</p>
9498: <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 9499: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9500: </li>
9501: </ol></div>
9502: </div>
9503: </div>
1.148 asau 9504: <div class="chapter">
1.75 rillig 9505: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9506: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9507: <p>This section contains the answers to questions that may
9508: arise when you are writing a package. If you don't find your
9509: question answered here, first have a look in the other chapters,
9510: and if you still don't have the answer, ask on the
9511: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9512: <div class="qandaset">
1.178 ! asau 9513: <a name="idm30928452"></a><dl>
1.106 rillig 9514: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9515: MAKEFLAGS, .MAKEFLAGS and
9516: MAKE_FLAGS?</a>
9517: </dt>
1.106 rillig 9518: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9519: MAKE, GMAKE and
9520: MAKE_PROGRAM?</a>
9521: </dt>
1.106 rillig 9522: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9523: CC, PKG_CC and
9524: PKGSRC_COMPILER?</a>
9525: </dt>
1.106 rillig 9526: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9527: BUILDLINK_LDFLAGS,
9528: BUILDLINK_LDADD and
9529: BUILDLINK_LIBS?</a>
9530: </dt>
1.106 rillig 9531: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9532: VARNAME=BUILDLINK_PREFIX.foo
9533: say it's empty?</a>
9534: </dt>
1.106 rillig 9535: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9536: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9537: don't understand the := inside
9538: it.</a>
9539: </dt>
1.106 rillig 9540: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9541: developers?</a>
9542: </dt>
1.106 rillig 9543: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9544: documentation?</a>
9545: </dt>
1.106 rillig 9546: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9547: do?</a>
9548: </dt>
1.75 rillig 9549: </dl>
1.148 asau 9550: <table border="0" style="width: 100%;">
9551: <colgroup>
1.75 rillig 9552: <col align="left" width="1%">
1.128 wiz 9553: <col>
1.148 asau 9554: </colgroup>
1.75 rillig 9555: <tbody>
1.148 asau 9556: <tr class="question">
1.75 rillig 9557: <td align="left" valign="top">
1.178 ! asau 9558: <a name="devfaq.makeflags"></a><a name="idm30928260"></a><p><b>22.1.</b></p>
1.75 rillig 9559: </td>
9560: <td align="left" valign="top"><p>What is the difference between
9561: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9562: <code class="varname">MAKE_FLAGS</code>?</p></td>
9563: </tr>
9564: <tr class="answer">
1.91 rillig 9565: <td align="left" valign="top"></td>
1.75 rillig 9566: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.136 dholland 9567: 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 9568: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9569: the <code class="varname">MAKE_PROGRAM</code> when building the
9570: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9571: </tr>
1.148 asau 9572: <tr class="question">
1.75 rillig 9573: <td align="left" valign="top">
1.178 ! asau 9574: <a name="devfaq.make"></a><a name="idm30926084"></a><p><b>22.2.</b></p>
1.75 rillig 9575: </td>
9576: <td align="left" valign="top"><p>What is the difference between
9577: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9578: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9579: </tr>
9580: <tr class="answer">
1.91 rillig 9581: <td align="left" valign="top"></td>
1.75 rillig 9582: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.136 dholland 9583: <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 9584: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9585: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9586: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9587: Make program that is used for building the
9588: package.</p></td>
9589: </tr>
1.148 asau 9590: <tr class="question">
1.75 rillig 9591: <td align="left" valign="top">
1.178 ! asau 9592: <a name="devfaq.cc"></a><a name="idm30923780"></a><p><b>22.3.</b></p>
1.75 rillig 9593: </td>
9594: <td align="left" valign="top"><p>What is the difference between
9595: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9596: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9597: </tr>
9598: <tr class="answer">
1.91 rillig 9599: <td align="left" valign="top"></td>
1.75 rillig 9600: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9601: compiler, which can be configured by the pkgsrc user.
9602: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9603: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9604: path to a compiler, but the type of compiler that should be
1.76 rillig 9605: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9606: information about the latter variable.</p></td>
9607: </tr>
1.148 asau 9608: <tr class="question">
1.75 rillig 9609: <td align="left" valign="top">
1.178 ! asau 9610: <a name="devfaq.bl3flags"></a><a name="idm30921668"></a><p><b>22.4.</b></p>
1.75 rillig 9611: </td>
9612: <td align="left" valign="top"><p>What is the difference between
9613: <code class="varname">BUILDLINK_LDFLAGS</code>,
9614: <code class="varname">BUILDLINK_LDADD</code> and
9615: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9616: </tr>
9617: <tr class="answer">
1.91 rillig 9618: <td align="left" valign="top"></td>
1.75 rillig 9619: <td align="left" valign="top"><p>[FIXME]</p></td>
9620: </tr>
1.148 asau 9621: <tr class="question">
1.75 rillig 9622: <td align="left" valign="top">
1.178 ! asau 9623: <a name="devfaq.bl3prefix"></a><a name="idm30920580"></a><p><b>22.5.</b></p>
1.75 rillig 9624: </td>
1.110 hubertf 9625: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9626: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9627: say it's empty?</p></td>
9628: </tr>
9629: <tr class="answer">
1.91 rillig 9630: <td align="left" valign="top"></td>
1.75 rillig 9631: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9632: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9633: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9634: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9635: command.</p></td>
9636: </tr>
1.148 asau 9637: <tr class="question">
1.78 rillig 9638: <td align="left" valign="top">
1.178 ! asau 9639: <a name="devfaq.master_sites"></a><a name="idm30918980"></a><p><b>22.6.</b></p>
1.78 rillig 9640: </td>
9641: <td align="left" valign="top"><p>What does
9642: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9643: don't understand the <code class="literal">:=</code> inside
9644: it.</p></td>
9645: </tr>
9646: <tr class="answer">
1.91 rillig 9647: <td align="left" valign="top"></td>
1.78 rillig 9648: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9649: assignment operator, like you might expect at first sight.
9650: Instead, it is a degenerate form of
9651: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.136 dholland 9652: 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 9653: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9654: case of <code class="varname">MASTER_SITE_*</code>,
9655: <em class="replaceable"><code>old_string</code></em> is the empty string and
9656: <em class="replaceable"><code>new_string</code></em> is
9657: <code class="literal">package/</code>. That's where the
9658: <code class="literal">:</code> and the <code class="literal">=</code> fall
9659: together.</p></td>
9660: </tr>
1.148 asau 9661: <tr class="question">
1.78 rillig 9662: <td align="left" valign="top">
1.178 ! asau 9663: <a name="devfaq.mailinglists"></a><a name="idm30915012"></a><p><b>22.7.</b></p>
1.78 rillig 9664: </td>
9665: <td align="left" valign="top"><p>Which mailing lists are there for package
9666: developers?</p></td>
9667: </tr>
9668: <tr class="answer">
1.91 rillig 9669: <td align="left" valign="top"></td>
1.148 asau 9670: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9671: <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 9672: <dd><p>This is a list for technical discussions related
9673: to pkgsrc development, e.g. soliciting feedback for changes to
9674: pkgsrc infrastructure, proposed new features, questions related
9675: to porting pkgsrc to a new platform, advice for maintaining a
9676: package, patches that affect many packages, help requests moved
9677: from pkgsrc-users when an infrastructure bug is found,
9678: etc.</p></dd>
1.110 hubertf 9679: <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 9680: <dd><p>All bug reports in category "pkg" sent with
1.136 dholland 9681: <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 9682: directly; use one of the other mailing
9683: lists.</p></dd>
9684: </dl></div></td>
9685: </tr>
1.148 asau 9686: <tr class="question">
1.80 rillig 9687: <td align="left" valign="top">
1.178 ! asau 9688: <a name="devfaq.documentation"></a><a name="idm30912964"></a><p><b>22.8.</b></p>
1.80 rillig 9689: </td>
9690: <td align="left" valign="top"><p>Where is the pkgsrc
9691: documentation?</p></td>
9692: </tr>
9693: <tr class="answer">
1.91 rillig 9694: <td align="left" valign="top"></td>
1.80 rillig 9695: <td align="left" valign="top">
9696: <p>There are many places where you can find
9697: documentation about pkgsrc:</p>
1.148 asau 9698: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9699: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9700: of chapters that explain large parts of pkgsrc, but some
9701: chapters tend to be outdated. Which ones they are is hard to
9702: say.</p></li>
1.128 wiz 9703: <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 9704: about certain features, announcements of new parts of the pkgsrc
9705: infrastructure and sometimes even announcements that a certain
9706: feature has been marked as obsolete. The benefit here is that
9707: each message has a date appended to it.</p></li>
1.128 wiz 9708: <li class="listitem"><p>Many of the files in the
1.80 rillig 9709: <code class="filename">mk/</code> directory start with a comment that
9710: describes the purpose of the file and how it can be used by the
1.92 rillig 9711: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9712: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9713: help</strong></span>.</p></li>
1.128 wiz 9714: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9715: information, but they tend to be highly abbreviated, especially
9716: for actions that occur often. Some contain a detailed
9717: description of what has changed, but they are geared towards the
9718: other pkgsrc developers, not towards an average pkgsrc user.
9719: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9720: don't know what has been before, these messages may not be worth
9721: too much to you.</p></li>
1.128 wiz 9722: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9723: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9724: mind of the developer who wrote the code. To get this
1.110 hubertf 9725: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9726: to see who has written it and ask on the
9727: <code class="literal">tech-pkg</code> mailing list, so that others can
9728: find your questions later (see above). To be sure that the
9729: developer in charge reads the mail, you may CC him or
9730: her.</p></li>
9731: </ul></div>
9732: </td>
9733: </tr>
1.148 asau 9734: <tr class="question">
1.92 rillig 9735: <td align="left" valign="top">
1.178 ! asau 9736: <a name="devfaq.too-much-time"></a><a name="idm30909700"></a><p><b>22.9.</b></p>
1.92 rillig 9737: </td>
9738: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9739: do?</p></td>
9740: </tr>
9741: <tr class="answer">
9742: <td align="left" valign="top"></td>
9743: <td align="left" valign="top">
1.93 rillig 9744: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9745: anyway.</p>
1.148 asau 9746: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9747: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9748: <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
9749: will tell you about newer versions of installed packages that are
9750: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9751: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9752: — it contains a list of suggested new packages and a list of
1.92 rillig 9753: cleanups and enhancements for pkgsrc that would be nice to
9754: have.</p></li>
1.128 wiz 9755: <li class="listitem"><p>Review packages for which review was requested on
1.110 hubertf 9756: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 9757: mailing list.</p></li>
9758: </ul></div>
9759: </td>
9760: </tr>
1.75 rillig 9761: </tbody>
9762: </table>
9763: </div>
9764: </div>
1.148 asau 9765: <div class="chapter">
1.85 jmmv 9766: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9767: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9768: <div class="toc">
9769: <p><b>Table of Contents</b></p>
9770: <dl>
1.106 rillig 9771: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9772: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9773: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9774: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9775: </dl>
9776: </div>
1.110 hubertf 9777: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9778: site</a>:</p>
9779: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9780: environment, an intuitive and attractive desktop for users, and the
9781: GNOME development platform, an extensive framework for building
9782: applications that integrate into the rest of the desktop.</p></blockquote></div>
9783: <p>pkgsrc provides a seamless way to automatically build and install
9784: a complete GNOME environment <span class="emphasis"><em>under many different
9785: platforms</em></span>. We can say with confidence that pkgsrc is one of
9786: the most advanced build and packaging systems for GNOME due to its
9787: included technologies buildlink3, the wrappers and tools framework and
9788: automatic configuration file management. Lots of efforts are put into
9789: achieving a completely clean deinstallation of installed software
9790: components.</p>
1.110 hubertf 9791: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9792: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9793: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9794: pkgsrc as its preferred packaging system, contributing lots of
9795: portability fixes to make GNOME build and install under it.</p>
9796: <p>This chapter is aimed at pkgsrc developers and other people
9797: interested in helping our GNOME porting and packaging efforts. It
9798: provides instructions on how to manage the existing packages and some
9799: important information regarding their internals.</p>
1.148 asau 9800: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9801: <h3 class="title">We need your help!</h3>
9802: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9803: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9804: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9805: work</a> list! There is still a long way to go to get a
9806: fully-functional GNOME desktop under NetBSD and we need your help to
9807: achieve it!</p>
9808: </div>
1.148 asau 9809: <div class="sect1">
1.85 jmmv 9810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9811: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9812: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9813: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9814: <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 9815: the core GNOME desktop environment. It only includes the necessary
9816: bits to get it to boot correctly, although it may lack important
9817: functionality for daily operation. The idea behind this package is
9818: to let end users build their own configurations on top of this one,
9819: first installing this meta package to achieve a functional setup and
9820: then adding individual applications.</p></li>
1.128 wiz 9821: <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 9822: complete installation of the GNOME platform and desktop as defined
9823: by the GNOME project; this is based on the components distributed in
9824: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9825: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9826: official FTP server. Developer-only tools found in those
9827: directories are not installed unless required by some other
9828: component to work properly. Similarly, packages from the bindings
9829: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9830: in unless required as a dependency for an end-user component. This
1.91 rillig 9831: package "extends" <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
1.128 wiz 9832: <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 9833: Installs all the tools required to build a GNOME component when
9834: fetched from the CVS repository. These are required to let the
1.110 hubertf 9835: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9836: </ul></div>
9837: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9838: sorted in a way that eases updates: a package may depend on other
9839: packages listed before it but not on any listed after it. It is very
9840: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9841: change it to alphabetical sorting!</em></span></p>
9842: </div>
1.148 asau 9843: <div class="sect1">
1.85 jmmv 9844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9845: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9846: <p>Almost all GNOME applications are written in C and use a common
9847: set of tools as their build system. Things get different with the new
9848: bindings to other languages (such as Python), but the following will
9849: give you a general idea on the minimum required tools:</p>
1.148 asau 9850: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9851: <li class="listitem">
1.85 jmmv 9852: <p>Almost all GNOME applications use the GNU Autotools as their
9853: build system. As a general rule you will need to tell this to your
9854: package:</p>
1.100 rillig 9855: <pre class="programlisting">
9856: GNU_CONFIGURE=yes
1.85 jmmv 9857: USE_LIBTOOL=yes
1.100 rillig 9858: USE_TOOLS+=gmake
9859: </pre>
1.85 jmmv 9860: </li>
1.128 wiz 9861: <li class="listitem">
1.85 jmmv 9862: <p>If the package uses pkg-config to detect dependencies, add this
9863: tool to the list of required utilities:</p>
9864: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9865: <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 9866: the end of the build process to ensure that you did not miss to
9867: specify any dependency in your package and that the version
9868: requirements are all correct.</p>
9869: </li>
1.128 wiz 9870: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9871: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9872: to handle dependencies and to force the package to use the latest
9873: available version.</p></li>
1.128 wiz 9874: <li class="listitem">
1.85 jmmv 9875: <p>If the package uses gtk-doc (a documentation generation
9876: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9877: tool is rather big and the distfile should come with pregenerated
9878: documentation anyway; if it does not, it is a bug that you ought to
9879: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9880: the default):</p>
9881: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9882: <p>The default location of installed HTML files
9883: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9884: and should not be changed unless the package insists on installing
9885: them somewhere else. Otherwise programs as
1.110 hubertf 9886: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9887: do that with an entry similar to:</p>
9888: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9889: </li>
9890: </ul></div>
9891: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9892: files under the installation prefix to maintain databases. In this
9893: context, shared means that those exact same directories and files are
9894: used among several different packages, leading to conflicts in the
9895: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9896: handle the most common cases, so you have to forget about using
9897: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9898: omitting shared files from them. If you find yourself doing those,
9899: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9900: <p>The following table lists the common situations that result in
9901: using shared directories or files. For each of them, the appropriate
9902: solution is given. After applying the solution be sure to
9903: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9904: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9905: <div class="table">
1.106 rillig 9906: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9907: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9908: <colgroup>
9909: <col>
9910: <col>
9911: </colgroup>
9912: <thead><tr>
9913: <th>If the package...</th>
9914: <th>Then...</th>
9915: </tr></thead>
9916: <tbody>
9917: <tr>
9918: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9919: <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 9920: </tr>
9921: <tr>
9922: <td>Installs icons under the
9923: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9924: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9925: <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 9926: </tr>
9927: <tr>
9928: <td>Installs files under
9929: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9930: <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 9931: </tr>
9932: <tr>
9933: <td>Installs <code class="filename">.desktop</code> files under
9934: <code class="filename">share/applications</code> and these include MIME
9935: information.</td>
1.110 hubertf 9936: <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 9937: </tr>
9938: </tbody>
1.91 rillig 9939: </table></div>
1.85 jmmv 9940: </div>
1.91 rillig 9941: <br class="table-break">
1.85 jmmv 9942: </div>
1.148 asau 9943: <div class="sect1">
1.85 jmmv 9944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9945: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9946: <p>When seeing GNOME as a whole, there are two kinds of
9947: updates:</p>
1.148 asau 9948: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9949: <dt><span class="term">Major update</span></dt>
9950: <dd>
9951: <p>Given that there is still a very long way for GNOME 3 (if it
9952: ever appears), we consider a major update one that goes from a
9953: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9954: where <code class="literal">Y</code> is even and greater than
9955: <code class="literal">X</code>. These are hard to achieve because they
9956: introduce lots of changes in the components' code and almost all
9957: GNOME distfiles are updated to newer versions. Some of them can
9958: even break API and ABI compatibility with the previous major
9959: version series. As a result, the update needs to be done all at
9960: once to minimize breakage.</p>
9961: <p>A major update typically consists of around 80 package
9962: updates and the addition of some new ones.</p>
9963: </dd>
9964: <dt><span class="term">Minor update</span></dt>
9965: <dd>
9966: <p>We consider a minor update one that goes from a
9967: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9968: one where <code class="literal">Y</code> is greater than
9969: <code class="literal">X</code>. These are easy to achieve because they do
9970: not update all GNOME components, can be done in an incremental way
9971: and do not break API nor ABI compatibility.</p>
9972: <p>A minor update typically consists of around 50 package
9973: updates, although the numbers here may vary a lot.</p>
9974: </dd>
9975: </dl></div>
9976: <p>In order to update the GNOME components in pkgsrc to a new stable
9977: release (either major or minor), the following steps should be
9978: followed:</p>
1.128 wiz 9979: <div class="orderedlist"><ol class="orderedlist" type="1">
9980: <li class="listitem">
1.85 jmmv 9981: <p>Get a list of all the tarballs that form the new release by
9982: using the following commands. These will leave the full list of the
1.120 snj 9983: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 9984: file:</p>
1.88 wiz 9985: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9986: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9987: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9988: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9989: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9990: awk '{ print $9 }' >>list.txt</code></strong></pre>
9991: </li>
1.128 wiz 9992: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 9993: bump their version to the release you are updating them to. The
9994: three meta packages should be always consistent with versioning.
9995: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9996: in them.</p></li>
1.128 wiz 9997: <li class="listitem">
1.85 jmmv 9998: <p>For each meta package, update all its
9999: <code class="varname">DEPENDS</code> lines to match the latest versions as
10000: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10001: newer version (even if found in the FTP) because the meta packages
10002: are supposed to list the exact versions that form a specific GNOME
10003: release. Exceptions are permitted here if a newer version solves a
10004: serious issue in the overall desktop experience; these typically
10005: come in the form of a revision bump in pkgsrc, not in newer versions
10006: from the developers.</p>
10007: <p>Packages not listed in the <code class="filename">list.txt</code> file
10008: should be updated to the latest version available (if found in
10009: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10010: 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 10011: </li>
1.128 wiz 10012: <li class="listitem">
1.85 jmmv 10013: <p>Generate a patch from the modified meta packages and extract the
10014: list of "new" lines. This will provide you an outline on what
10015: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10016: <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 10017: </li>
1.128 wiz 10018: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 10019: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 10020: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 10021: of <code class="filename">todo.txt</code> and update the packages listed in
10022: it in order. For major desktop updates none of these should be
1.93 rillig 10023: committed until the entire set is completed because there are chances
1.85 jmmv 10024: of breaking not-yet-updated packages.</p></li>
1.128 wiz 10025: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 10026: the tree one by one with appropriate log messages. At the end,
10027: commit the three meta package updates and all the corresponding
10028: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10029: <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>
10030: </ol></div>
10031: </div>
1.148 asau 10032: <div class="sect1">
1.85 jmmv 10033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10034: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10035: <p>GNOME is a very big component in pkgsrc which approaches 100
10036: packages. Please, it is very important that you always, always,
10037: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10038: 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 10039: their attention on portability issues and to ensure that future versions
10040: can be built out-of-the box on NetBSD. The less custom patches in
10041: pkgsrc, the easier further updates are. Those developers in charge of
10042: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10043: <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 10044: Bugzilla</a>. Not all components use these to track bugs, but most
10045: of them do. Do not be short on your reports: always provide detailed
10046: explanations of the current failure, how it can be improved to achieve
10047: maximum portability and, if at all possible, provide a patch against CVS
10048: head. The more verbose you are, the higher chances of your patch being
10049: accepted.</p>
10050: <p>Also, please avoid using preprocessor magic to fix portability
10051: issues. While the FreeBSD GNOME people are doing a great job in porting
10052: GNOME to their operating system, the official GNOME sources are now
10053: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10054: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10055: 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 10056: details.</p>
10057: </div>
10058: </div>
1.75 rillig 10059: </div>
1.148 asau 10060: <div class="part">
1.75 rillig 10061: <div class="titlepage"><div><div><h1 class="title">
10062: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10063: <div class="partintro">
1.75 rillig 10064: <div></div>
10065: <p>This part of the guide deals with everything
10066: from the infrastructure that is behind the interfaces described
10067: in the developer's guide. A casual package maintainer should not
10068: need anything from this part.</p>
10069: <div class="toc">
10070: <p><b>Table of Contents</b></p>
10071: <dl>
1.106 rillig 10072: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10073: <dd><dl>
1.106 rillig 10074: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10075: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10076: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10077: <dd><dl>
1.106 rillig 10078: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10079: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10080: </dl></dd>
1.106 rillig 10081: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10082: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10083: <dd><dl>
1.106 rillig 10084: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10085: <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 10086: </dl></dd>
1.106 rillig 10087: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10088: <dd><dl>
1.128 wiz 10089: <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>
10090: <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 10091: </dl></dd>
10092: </dl></dd>
1.106 rillig 10093: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10094: <dd><dl>
1.106 rillig 10095: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10096: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10097: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10098: <dd><dl>
1.106 rillig 10099: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10100: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10101: </dl></dd>
10102: </dl></dd>
1.106 rillig 10103: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10104: <dd><dl>
1.106 rillig 10105: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10106: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10107: </dl></dd>
10108: </dl>
10109: </div>
10110: </div>
1.148 asau 10111: <div class="chapter">
1.75 rillig 10112: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10113: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10114: <div class="toc">
10115: <p><b>Table of Contents</b></p>
10116: <dl>
1.106 rillig 10117: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10118: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10119: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10120: <dd><dl>
1.106 rillig 10121: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10122: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10123: </dl></dd>
1.106 rillig 10124: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10125: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10126: <dd><dl>
1.106 rillig 10127: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10128: <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 10129: </dl></dd>
1.106 rillig 10130: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10131: <dd><dl>
1.128 wiz 10132: <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>
10133: <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 10134: </dl></dd>
10135: </dl>
10136: </div>
10137: <p>The pkgsrc infrastructure consists of many small Makefile
10138: fragments. Each such fragment needs a properly specified
10139: interface. This chapter explains how such an interface looks
10140: like.</p>
1.148 asau 10141: <div class="sect1">
1.75 rillig 10142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10143: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10144: <p>Whenever a variable is defined in the pkgsrc
10145: infrastructure, the location and the way of definition provide
10146: much information about the intended use of that variable.
10147: Additionally, more documentation may be found in a header
10148: comment or in this pkgsrc guide.</p>
10149: <p>A special file is
10150: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10151: variables that are intended to be user-defined. They are either
10152: defined using the <code class="literal">?=</code> operator or they are
10153: left undefined because defining them to anything would
1.128 wiz 10154: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10155: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10156: file.</p>
10157: <p>Outside this file, the following conventions apply:
10158: Variables that are defined using the <code class="literal">?=</code>
10159: operator may be overridden by a package.</p>
10160: <p>Variables that are defined using the <code class="literal">=</code>
10161: operator may be used read-only at run-time.</p>
10162: <p>Variables whose name starts with an underscore must not be
10163: accessed outside the pkgsrc infrastructure at all. They may
10164: change without further notice.</p>
1.148 asau 10165: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10166: <h3 class="title">Note</h3>
10167: <p>These conventions are currently not applied
10168: consistently to the complete pkgsrc
10169: infrastructure.</p>
10170: </div>
10171: </div>
1.148 asau 10172: <div class="sect1">
1.81 rillig 10173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10174: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10175: <p>All variables that contain lists of things should default
10176: to being empty. Two examples that do not follow this rule are
10177: <code class="varname">USE_LANGUAGES</code> and
10178: <code class="varname">DISTFILES</code>. These variables cannot simply be
10179: modified using the <code class="literal">+=</code> operator in package
10180: <code class="filename">Makefile</code>s (or other files included by
10181: them), since there is no guarantee whether the variable is
10182: already set or not, and what its value is. In the case of
1.128 wiz 10183: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10184: the default value and just define it as in the following
10185: example.</p>
10186: <pre class="programlisting">
1.100 rillig 10187: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10188: </pre>
10189: <p>Because of the selection of this default value, the same
10190: value appears in many package Makefiles. Similarly for
10191: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10192: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10193: doesn't stand out. Nevertheless it is mentioned in many
10194: files.</p>
10195: </div>
1.148 asau 10196: <div class="sect1">
1.81 rillig 10197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10198: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 10199: <div class="sect2">
1.75 rillig 10200: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10201: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10202: <p>Variable evaluation takes place either at load time or at
10203: runtime, depending on the context in which they occur. The
10204: contexts where variables are evaluated at load time are:</p>
1.148 asau 10205: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10206: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10207: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10208: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10209: <code class="literal">.for</code>,</p></li>
1.128 wiz 10210: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10211: </ul></div>
10212: <p>A special exception are references to the iteration
10213: variables of <code class="literal">.for</code> loops, which are expanded
10214: inline, no matter in which context they appear.</p>
10215: <p>As the values of variables may change during load time,
10216: care must be taken not to evaluate them by accident. Typical
10217: examples for variables that should not be evaluated at load time
10218: are <code class="varname">DEPENDS</code> and
10219: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10220: clear, here is an example:</p>
10221: <pre class="programlisting">
1.100 rillig 10222: CONFIGURE_ARGS= # none
10223: CFLAGS= -O
10224: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10225:
1.100 rillig 10226: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10227:
1.100 rillig 10228: CFLAGS+= -Wall
1.75 rillig 10229: </pre>
10230: <p>This code shows how the use of the <code class="literal">:=</code>
10231: operator can quickly lead to unexpected results. The first
10232: paragraph is fairly common code. The second paragraph evaluates
10233: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10234: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10235: <code class="literal">-Wall</code> is appended to the
10236: <code class="varname">CFLAGS</code>, but this addition will not appear in
10237: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10238: paragraphs from above typically occur in completely unrelated
10239: files.</p>
10240: </div>
1.148 asau 10241: <div class="sect2">
1.75 rillig 10242: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10243: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10244: <p>After all the files have been loaded, the values of the
10245: variables cannot be changed anymore. Variables that are used in
10246: the shell commands are expanded at this point.</p>
10247: </div>
10248: </div>
1.148 asau 10249: <div class="sect1">
1.75 rillig 10250: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10251: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10252: <p>There are many ways in which the definition and use of a
10253: variable can be restricted in order to detect bugs and
10254: violations of the (mostly unwritten) policies. See the
10255: <code class="literal">pkglint</code> developer's documentation for further
10256: details.</p>
10257: </div>
1.148 asau 10258: <div class="sect1">
1.78 rillig 10259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10260: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10261: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10262: of the following classes. Cases where a file falls into more
10263: than one class should be avoided as it often leads to subtle
10264: bugs.</p>
1.148 asau 10265: <div class="sect2">
1.75 rillig 10266: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10267: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10268: <p>In a traditional imperative programming language some of
1.76 rillig 10269: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10270: procedures. They take some input parameters and—after
10271: inclusion—provide a result in output parameters. Since all
1.76 rillig 10272: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10273: care must be taken not to use parameter names that have already
10274: another meaning. For example, <code class="varname">PKGNAME</code> is a
10275: bad choice for a parameter name.</p>
10276: <p>Procedures are completely evaluated at preprocessing time.
10277: That is, when calling a procedure all input parameters must be
10278: completely resolvable. For example,
10279: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10280: parameter since it is very likely that further text will be
10281: added after calling the procedure, which would effectively apply
10282: the procedure to only a part of the variable. Also, references
10283: to other variables wit will be modified after calling the
10284: procedure.</p>
10285: <p>A procedure can declare its output parameters either as
10286: suitable for use in preprocessing directives or as only
10287: available at runtime. The latter alternative is for variables
10288: that contain references to other runtime variables.</p>
10289: <p>Procedures shall be written such that it is possible to
10290: call the procedure more than once. That is, the file must not
10291: contain multiple-inclusion guards.</p>
10292: <p>Examples for procedures are
1.76 rillig 10293: <code class="filename">mk/bsd.options.mk</code> and
10294: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10295: that the parameters are evaluated at load time, they should be
10296: assigned using the <code class="literal">:=</code> operator, which should
10297: be used only for this purpose.</p>
10298: </div>
1.148 asau 10299: <div class="sect2">
1.75 rillig 10300: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10301: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10302: <p>Action files take some input parameters and may define
10303: runtime variables. They shall not define loadtime variables.
10304: There are action files that are included implicitly by the
10305: pkgsrc infrastructure, while other must be included
10306: explicitly.</p>
10307: <p>An example for action files is
1.76 rillig 10308: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10309: </div>
10310: </div>
1.148 asau 10311: <div class="sect1">
1.81 rillig 10312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10313: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10314: <p>Package <code class="filename">Makefile</code>s usually consist of
10315: a set of variable definitions, and include the file
10316: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10317: Before that, they may also include various other
10318: <code class="filename">*.mk</code> files if they need to query the
10319: availability of certain features like the type of compiler or
10320: the X11 implementation. Due to the heavy use of preprocessor
10321: directives like <code class="literal">.if</code> and
10322: <code class="literal">.for</code>, the order in which the files are loaded
10323: matters.</p>
10324: <p>This section describes at which point the various files
10325: are loaded and gives reasons for that order.</p>
1.148 asau 10326: <div class="sect2">
1.81 rillig 10327: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10328: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10329: </h3></div></div></div>
10330: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10331: is to define some essential variables like
10332: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10333: <code class="varname">MACHINE_ARCH</code>.</p>
10334: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10335: 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 10336: After that, those variables
1.81 rillig 10337: that have not been overridden by the user are loaded from
10338: <code class="filename">mk/defaults/mk.conf</code>.</p>
10339: <p>After the user settings, the system settings and platform
10340: settings are loaded, which may override the user
10341: settings.</p>
10342: <p>Then, the tool definitions are loaded. The tool wrappers
10343: are not yet in effect. This only happens when building a
10344: package, so the proper variables must be used instead of the
10345: direct tool names.</p>
10346: <p>As the last steps, some essential variables from the
10347: wrapper and the package system flavor are loaded, as well as the
10348: variables that have been cached in earlier phases of a package
10349: build.</p>
10350: </div>
1.148 asau 10351: <div class="sect2">
1.81 rillig 10352: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10353: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10354: </h3></div></div></div>
1.81 rillig 10355: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10356: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10357: loaded, which fill default values for those variables that have
1.93 rillig 10358: not been defined by the package. These variables may later
1.81 rillig 10359: be used even in unrelated files.</p>
10360: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10361: provides the target <code class="literal">error-check</code> that is added
10362: as a special dependency to all other targets that use
10363: <code class="varname">DELAYED_ERROR_MSG</code> or
10364: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10365: <p>Then, the package-specific hacks from
10366: <code class="filename">hacks.mk</code> are included.</p>
10367: <p>Then, various other files follow. Most of them don't have
10368: any dependencies on what they need to have included before or
10369: after them, though some do.</p>
10370: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10371: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10372: restricts the use of these variables to all the files that have
10373: been included before. Appearances in later files will be
10374: silently ignored.</p>
10375: <p>Then, the files for the main targets are included, in the
10376: order of later execution, though the actual order should not
10377: matter.</p>
10378: <p>At last, some more files are included that don't set any
10379: interesting variables but rather just define make targets to be
10380: executed.</p>
10381: </div>
10382: </div>
1.75 rillig 10383: </div>
1.148 asau 10384: <div class="chapter">
1.75 rillig 10385: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10386: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10387: <div class="toc">
10388: <p><b>Table of Contents</b></p>
10389: <dl>
1.106 rillig 10390: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10391: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10392: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10393: <dd><dl>
1.106 rillig 10394: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10395: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10396: </dl></dd>
10397: </dl>
10398: </div>
10399: <p>The pkgsrc infrastructure consists of a large codebase,
10400: and there are many corners where every little bit of a file is
10401: well thought out, making pkgsrc likely to fail as soon as
10402: anything is changed near those parts. To prevent most changes
10403: from breaking anything, a suite of regression tests should go
10404: along with every important part of the pkgsrc infrastructure.
10405: This chapter describes how regression tests work in pkgsrc and
10406: how you can add new tests.</p>
1.148 asau 10407: <div class="sect1">
1.75 rillig 10408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10409: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10410: <p></p>
10411: </div>
1.148 asau 10412: <div class="sect1">
1.75 rillig 10413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10414: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10415: <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 10416: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10417: can simply run that command, which will run all tests in the
1.76 rillig 10418: <code class="filename">regress</code> category.</p>
1.75 rillig 10419: </div>
1.148 asau 10420: <div class="sect1">
1.75 rillig 10421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10422: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10423: <p>Every directory in the <code class="filename">regress</code>
10424: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10425: is considered a regression test. This file is a shell program
1.110 hubertf 10426: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10427: The following functions can be overridden to suit your
10428: needs.</p>
1.148 asau 10429: <div class="sect2">
1.75 rillig 10430: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10431: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10432: <p>These functions do not take any parameters. They are all
1.128 wiz 10433: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10434: to check the exitcodes of any commands you run in the
10435: test.</p>
1.148 asau 10436: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10437: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10438: <dd><p>This function prepares the environment for the
10439: test. By default it does nothing.</p></dd>
10440: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10441: <dd><p>This function runs the actual test. By default,
10442: it calls <code class="varname">TEST_MAKE</code> with the arguments
10443: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10444: error messages into the file
10445: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10446: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10447: <dd><p>This function is run after the test and is
10448: typically used to compare the actual output from the one that is
10449: expected. It can make use of the various helper functions from
10450: the next section.</p></dd>
10451: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10452: <dd><p>This function cleans everything up after the
10453: test has been run. By default it does nothing.</p></dd>
10454: </dl></div>
10455: </div>
1.148 asau 10456: <div class="sect2">
1.75 rillig 10457: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10458: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 asau 10459: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10460: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10461: <dd><p>This function compares the exitcode of the
1.110 hubertf 10462: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10463: If they differ, the test will fail.</p></dd>
10464: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10465: <dd><p>This function checks for each of its parameters
1.110 hubertf 10466: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10467: extended regular expression. If it does not, the test will
10468: fail.</p></dd>
10469: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10470: <dd><p>This function checks for each of its parameters
1.110 hubertf 10471: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10472: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10473: If any of the regular expressions matches, the test will
10474: fail.</p></dd>
10475: </dl></div>
10476: </div>
10477: </div>
10478: </div>
1.148 asau 10479: <div class="chapter">
1.75 rillig 10480: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10481: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10482: <div class="toc">
10483: <p><b>Table of Contents</b></p>
10484: <dl>
1.106 rillig 10485: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10486: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10487: </dl>
10488: </div>
10489: <p>The pkgsrc system has already been ported to many
10490: operating systems, hardware architectures and compilers. This
10491: chapter explains the necessary steps to make pkgsrc even more
10492: portable.</p>
1.148 asau 10493: <div class="sect1">
1.75 rillig 10494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10495: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10496: <p>To port pkgsrc to a new operating system (called
10497: <code class="literal">MyOS</code> in this example), you need to touch the
10498: following files:</p>
1.148 asau 10499: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10500: <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 10501: <dd><p>This file contains some basic definitions, for
10502: example the name of the C
10503: compiler.</p></dd>
1.76 rillig 10504: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10505: <dd><p>Insert code that defines the variables
10506: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10507: <code class="varname">LOWER_OS_VERSION</code>,
10508: <code class="varname">LOWER_VENDOR</code>,
10509: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10510: <code class="varname">APPEND_ELF</code>, and the other variables that
10511: appear in this file.</p></dd>
1.93 rillig 10512: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10513: <dd><p>This file contains the platform-specific
10514: definitions that are used by pkgsrc. Start by copying one of the
10515: other files and edit it to your
10516: needs.</p></dd>
1.93 rillig 10517: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10518: <dd><p>This file defines the paths to all the tools
10519: that are needed by one or the other package in pkgsrc, as well
10520: as by pkgsrc itself. Find out where these tools are on your
10521: platform and add them.</p></dd>
10522: </dl></div>
10523: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10524: <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 10525: </div>
1.148 asau 10526: <div class="sect1">
1.75 rillig 10527: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10528: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10529: <p>TODO</p>
10530: </div>
10531: </div>
10532: </div>
1.148 asau 10533: <div class="appendix">
10534: <div class="titlepage"><div><div><h1 class="title">
10535: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10536: <div class="toc">
10537: <p><b>Table of Contents</b></p>
10538: <dl>
10539: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10540: <dd><dl>
10541: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10542: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10543: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10544: <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 10545: </dl></dd>
10546: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10547: </dl>
10548: </div>
10549: <p>We checked to find a piece of software that wasn't in the packages
10550: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10551: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10552: present in the tree is beyond us, but it's useful for the purposes of
10553: this exercise.</p>
1.148 asau 10554: <div class="sect1">
1.75 rillig 10555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10556: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10557: <div class="sect2">
1.75 rillig 10558: <div class="titlepage"><div><div><h3 class="title">
10559: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10560: <pre class="programlisting">
1.100 rillig 10561: # $NetBSD$
10562: #
1.1 grant 10563:
1.100 rillig 10564: DISTNAME= bison-1.25
10565: CATEGORIES= devel
10566: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10567:
1.136 dholland 10568: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10569: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10570: COMMENT= GNU yacc clone
1.1 grant 10571:
1.100 rillig 10572: GNU_CONFIGURE= yes
1.152 wiz 10573: INFO_FILES= yes
1.1 grant 10574:
1.100 rillig 10575: .include "../../mk/bsd.pkg.mk"
1.1 grant 10576: </pre>
1.75 rillig 10577: </div>
1.148 asau 10578: <div class="sect2">
1.75 rillig 10579: <div class="titlepage"><div><div><h3 class="title">
10580: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10581: <pre class="programlisting">
1.100 rillig 10582: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.136 dholland 10583: 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 10584: of the NetBSD source tree is beyond me.
1.1 grant 10585: </pre>
1.75 rillig 10586: </div>
1.148 asau 10587: <div class="sect2">
1.75 rillig 10588: <div class="titlepage"><div><div><h3 class="title">
10589: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10590: <pre class="programlisting">
1.100 rillig 10591: @comment $NetBSD$
10592: bin/bison
10593: man/man1/bison.1.gz
10594: share/bison.simple
10595: share/bison.hairy
1.1 grant 10596: </pre>
1.75 rillig 10597: </div>
1.148 asau 10598: <div class="sect2">
1.75 rillig 10599: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10600: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10601: </h3></div></div></div>
1.75 rillig 10602: <p>The NetBSD package system comes with
1.91 rillig 10603: <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 10604: which helps to check the contents of these
10605: files. After installation it is quite easy to use, just change to the
10606: directory of the package you wish to examine and execute
1.110 hubertf 10607: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10608: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10609: looks fine.</pre>
10610: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10611: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10612: -Wall</strong></span> for a very thorough check.</p>
10613: </div>
10614: </div>
1.148 asau 10615: <div class="sect1">
1.75 rillig 10616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10617: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10618: <p>Create the directory where the package lives,
10619: plus any auxiliary directories:</p>
10620: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10621: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10622: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10623: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10624: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10625: <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 10626: then continue with fetching the distfile:</p>
10627: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10628: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10629: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10630: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10631: ftp: Error retrieving file: 500 Internal error
10632:
10633: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10634: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10635: ftp: Error retrieving file: 500 Internal error
10636:
10637: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10638: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10639: Successfully retrieved file.</pre>
10640: <p>Generate the checksum of the distfile into
1.76 rillig 10641: <code class="filename">distinfo</code>:</p>
1.88 wiz 10642: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10643: <p>Now compile:</p>
10644: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10645: >> Checksum OK for bison-1.25.tar.gz.
10646: ===> Extracting for bison-1.25
10647: ===> Patching for bison-1.25
10648: ===> Ignoring empty patch directory
10649: ===> Configuring for bison-1.25
10650: creating cache ./config.cache
10651: checking for gcc... cc
10652: checking whether we are using GNU C... yes
10653: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10654: checking how to run the C preprocessor... cc -E
10655: checking for minix/config.h... no
10656: checking for POSIXized ISC... no
10657: checking whether cross-compiling... no
10658: checking for ANSI C header files... yes
10659: checking for string.h... yes
10660: checking for stdlib.h... yes
10661: checking for memory.h... yes
10662: checking for working const... yes
10663: checking for working alloca.h... no
10664: checking for alloca... yes
10665: checking for strerror... yes
10666: updating cache ./config.cache
10667: creating ./config.status
10668: creating Makefile
10669: ===> Building for bison-1.25
10670: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10671: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10672: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10673: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10674: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10675: 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 10676: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10677: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10678: 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
10679: 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
10680: 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
10681: 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
10682: 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
10683: 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
10684: 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
10685: 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
10686: 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
10687: 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
10688: 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
10689: 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
10690: 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
10691: 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
10692: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10693: rm -f bison.s1
1.75 rillig 10694: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10695: <p>Everything seems OK, so install the files:</p>
10696: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10697: >> Checksum OK for bison-1.25.tar.gz.
10698: ===> Installing for bison-1.25
10699: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10700: rm -f /usr/pkg/bin/bison
10701: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10702: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10703: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10704: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10705: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10706: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10707: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10708: ===> Registering installation for bison-1.25</pre>
10709: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10710: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10711: binary package, do this now:</p>
10712: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10713: >> Checksum OK for bison-1.25.tar.gz.
10714: ===> Building package for bison-1.25
10715: Creating package bison-1.25.tgz
10716: Registering depends:.
1.75 rillig 10717: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10718: <p>Now that you don't need the source and object files
10719: any more, clean up:</p>
10720: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10721: ===> Cleaning for bison-1.25</pre>
10722: </div>
10723: </div>
1.148 asau 10724: <div class="appendix">
10725: <div class="titlepage"><div><div><h1 class="title">
10726: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10727: <div class="toc">
10728: <p><b>Table of Contents</b></p>
10729: <dl>
10730: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10731: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10732: </dl>
10733: </div>
1.148 asau 10734: <div class="sect1">
1.75 rillig 10735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10736: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10737: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10738: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10739: => figlet221.tar.gz doesn't seem to exist on this system.
10740: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10741: => [172219 bytes]
10742: Connected to ftp.plig.net.
10743: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10744: 331 Guest login ok, send your complete e-mail address as password.
10745: 230-You are user #5 of 500 simultaneous users allowed.
10746: 230-
1.68 rillig 10747: 230- ___ _ _ _
10748: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10749: 230- | _| _| . |_| . | | | . |_| . | _| . |
10750: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10751: 230- |_| |_| |___| |___|
10752: 230-
10753: 230-** Welcome to ftp.plig.org **
10754: 230-
10755: 230-Please note that all transfers from this FTP site are logged. If you
10756: 230-do not like this, please disconnect now.
10757: 230-
1.120 snj 10758: 230-This archive is available via
1.1 grant 10759: 230-
10760: 230-HTTP: http://ftp.plig.org/
10761: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10762: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10763: 230-
10764: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10765: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10766: 230-
10767: 230-
10768: 230 Logged in anonymously.
10769: Remote system type is UNIX.
10770: Using binary mode to transfer files.
10771: 200 Type okay.
10772: 250 "/pub" is new cwd.
10773: 250-"/pub/figlet" is new cwd.
10774: 250-
10775: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10776: 250-
1.75 rillig 10777: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10778: 250-
10779: 250-The official FIGlet web page is:
1.75 rillig 10780: 250- http://www.figlet.org/
1.1 grant 10781: 250-
10782: 250-If you have questions, please mailto:info@figlet.org. If you want to
10783: 250-contribute a font or something else, you can email us.
1.68 rillig 10784: 250
1.1 grant 10785: 250 "/pub/figlet/program" is new cwd.
10786: 250 "/pub/figlet/program/unix" is new cwd.
10787: local: figlet221.tar.gz remote: figlet221.tar.gz
10788: 502 Unimplemented command.
10789: 227 Entering Passive Mode (195,40,6,41,246,104)
10790: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10791: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10792: 226 Transfer completed.
10793: 172219 bytes received in 00:02 (75.99 KB/s)
10794: 221 Goodbye.
10795: => Checksum OK for figlet221.tar.gz.
10796: ===> Extracting for figlet-2.2.1nb2
10797: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10798: ===> Patching for figlet-2.2.1nb2
10799: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10800: ===> Overriding tools for figlet-2.2.1nb2
10801: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10802: ===> Configuring for figlet-2.2.1nb2
10803: ===> Building for figlet-2.2.1nb2
10804: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10805: chmod a+x figlet
10806: gcc -O2 -o chkfont chkfont.c
10807: => Unwrapping files-to-be-installed.
1.14 xtraeme 10808: <code class="prompt">#</code>
1.75 rillig 10809: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10810: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10811: ===> Installing for figlet-2.2.1nb2
10812: install -d -o root -g wheel -m 755 /usr/pkg/bin
10813: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10814: mkdir -p /usr/pkg/share/figlet
10815: cp figlet /usr/pkg/bin
10816: cp chkfont /usr/pkg/bin
10817: chmod 555 figlist showfigfonts
10818: cp figlist /usr/pkg/bin
10819: cp showfigfonts /usr/pkg/bin
10820: cp fonts/*.flf /usr/pkg/share/figlet
10821: cp fonts/*.flc /usr/pkg/share/figlet
10822: cp figlet.6 /usr/pkg/man/man6
10823: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10824: <code class="prompt">#</code></pre>
10825: </div>
1.148 asau 10826: <div class="sect1">
1.75 rillig 10827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10828: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10829: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10830: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10831: ===> Packaging figlet-2.2.1nb2
10832: ===> Building binary package for figlet-2.2.1nb2
10833: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10834: Using SrcDir value of /usr/pkg
1.68 rillig 10835: Registering depends:.
1.75 rillig 10836: <code class="prompt">#</code></pre>
10837: </div>
10838: </div>
1.148 asau 10839: <div class="appendix">
10840: <div class="titlepage"><div><div><h1 class="title">
10841: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10842: <div class="toc">
10843: <p><b>Table of Contents</b></p>
10844: <dl>
1.128 wiz 10845: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10846: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10847: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10848: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10849: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10850: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10851: source packages</a></span></dt>
10852: </dl>
10853: </div>
10854: <p>As in other big projects, the directory layout of pkgsrc
10855: is quite complex for newbies. This chapter explains where you
10856: find things on the FTP server. The base directory on
1.110 hubertf 10857: <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 10858: On other servers it may be different, but inside this directory,
10859: everything should look the same, no matter on which server you
10860: are. This directory contains some subdirectories, which are
10861: explained below.</p>
1.148 asau 10862: <div class="sect1">
1.76 rillig 10863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10864: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10865: <p>The directory <code class="filename">distfiles</code> contains lots
10866: of archive files from all pkgsrc packages, which are mirrored
10867: here. The subdirectories are called after their package names
10868: and are used when the distributed files have names that don't
10869: explicitly contain a version number or are otherwise too generic
10870: (for example <code class="filename">release.tar.gz</code>).</p>
10871: </div>
1.148 asau 10872: <div class="sect1">
1.76 rillig 10873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10874: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10875: <p>This directory contains things that individual pkgsrc
10876: developers find worth publishing.</p>
10877: </div>
1.148 asau 10878: <div class="sect1">
1.76 rillig 10879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10880: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10881: <p>This directory contains binary packages for the various
10882: platforms that are supported by pkgsrc.
10883: 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 10884: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10885: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10886: operating system for which the packages have been built. The
1.110 hubertf 10887: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10888: command, so it may differ from the one you are used to
10889: hear.</p></li>
1.128 wiz 10890: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10891: architecture of the platform for which the packages have been
1.110 hubertf 10892: built. It also includes the <code class="varname">ABI</code> (Application
10893: Binary Interface) for platforms that have several of
10894: them.</p></li>
1.128 wiz 10895: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10896: the operating system. For version numbers that change often (for
10897: example NetBSD-current), the often-changing part should be
10898: replaced with an <code class="literal">x</code>, for example
10899: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10900: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10901: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10902: for a stable branch, or <code class="literal">head</code> for packages
10903: built from the HEAD branch. The latter should only be used when
10904: the packages are updated on a regular basis. Otherwise the date
10905: from checking out pkgsrc should be appended, for example
10906: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10907: </ul></div>
10908: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10909: can quickly click through the directories on the
10910: server and find the best binary packages for their machines. Since they
10911: usually know the operating system and the hardware architecture, OPSYS
10912: and ARCH are placed first. After these choices, they can select the
10913: best combination of OSVERSION and TAG together, since it is usually the
10914: case that packages stay compatible between different version of the
10915: operating system.</p>
10916: <p>In each of these directories, there is a
10917: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10918: <code class="filename">All</code> which contains all binary packages.
10919: Besides that, there are various category directories that
10920: contain symbolic links to the real binary packages.</p>
10921: </div>
1.148 asau 10922: <div class="sect1">
1.76 rillig 10923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10924: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10925: <p>Here are the reports from bulk builds, for those who want
10926: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10927: 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 10928: </div>
1.148 asau 10929: <div class="sect1">
1.108 rillig 10930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10931: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10932: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10933: source packages</h2></div></div></div>
1.128 wiz 10934: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10935: that is the files that define how to create binary packages from
10936: source archives.</p>
10937: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10938: snapshot of the CVS repository, which is updated regularly. The
10939: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10940: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10941: <p>In the directories for the quarterly branches, there is an
10942: additional file called
1.126 jakllsch 10943: <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 10944: which contains the state of pkgsrc when it was branched.</p>
10945: </div>
1.75 rillig 10946: </div>
1.148 asau 10947: <div class="appendix">
10948: <div class="titlepage"><div><div><h1 class="title">
10949: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 10950: <div class="toc">
10951: <p><b>Table of Contents</b></p>
10952: <dl>
1.79 rillig 10953: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10954: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10955: </dl>
10956: </div>
1.79 rillig 10957: <p>This section contains information on editing the pkgsrc
10958: guide itself.</p>
1.148 asau 10959: <div class="sect1">
1.75 rillig 10960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10961: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10962: <p>The pkgsrc guide's source code is stored in
10963: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10964: are created from it:</p>
1.148 asau 10965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10966: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10967: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10968: <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>
10969: <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 10970: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 10971: <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 10972: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10973: </ul></div>
10974: </div>
1.148 asau 10975: <div class="sect1">
1.75 rillig 10976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10977: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10978: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 10979: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 10980: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 10981: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 10982: documentation) installed. These are automatically installed when
10983: 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 10984: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 10985: right directory. All further steps will take place
10986: here.</p></li>
1.148 asau 10987: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 10988: <code class="filename">files/</code>.</p></li>
1.148 asau 10989: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 10990: guide for valid XML and to build the final output files. If you
10991: get any errors at this stage, you can just edit the files, as
10992: there are only symbolic links in the working directory, pointing
10993: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 10994: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 10995: commit)</strong></span></p></li>
1.148 asau 10996: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 10997: regenerate the output files with the proper RCS
10998: Ids.</p></li>
1.148 asau 10999: <li class="step">
1.110 hubertf 11000: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11001: commit the files in both <code class="filename">pkgsrc/doc</code> and
11002: <code class="filename">htdocs</code>.</p>
1.148 asau 11003: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 11004: <h3 class="title">Note</h3>
11005: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11006: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11007: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11008: directory.</p>
11009: </div>
11010: </li>
1.79 rillig 11011: </ol></div>
1.75 rillig 11012: </div>
11013: </div>
11014: </div></body>
1.1 grant 11015: </html>
CVSweb <webmaster@jp.NetBSD.org>