Annotation of pkgsrc/doc/pkgsrc.html, revision 1.200
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.194 bsiegert 33: <div><p class="copyright">Copyright © 1994-2015 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.28 2015/01/01 05:19:02 jnemeth Exp $</p></div>
1.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.195 wiz 48: <dl class="toc">
1.75 rillig 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
1.157 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
1.82 rillig 78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
81: <dd><dl>
1.151 obache 82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 92: </dl></dd>
93: </dl></dd>
94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
97: <dd><dl>
98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
103: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
105: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 106: </dl></dd>
107: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
108: <dd><dl>
109: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
110: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
111: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
112: </dl></dd>
113: </dl></dd>
114: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
115: <dd><dl>
116: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
117: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 118: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 119: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 120: <dd><dl>
1.103 wiz 121: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 122: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
123: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 124: </dl></dd>
1.103 wiz 125: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
126: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 127: </dl></dd>
128: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
129: <dd><dl>
130: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
131: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 132: </dl></dd>
133: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
134: builds)</a></span></dt>
1.75 rillig 135: <dd><dl>
1.180 wiz 136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
138: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
139: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 140: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 142: </dl></dd>
143: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
144: <dd><dl>
1.128 wiz 145: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
146: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194 bsiegert 151: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
152: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
153: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
154: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
155: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
156: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
157: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
158: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
159: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 160: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 161: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
162: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
163: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
164: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
165: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
167: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 168: </dl></dd>
169: </dl></dd>
170: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
171: <dd><dl>
1.106 rillig 172: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 173: <dd><dl>
1.106 rillig 174: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 175: <dd><dl>
1.106 rillig 176: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 177: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 178: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 179: </dl></dd>
1.106 rillig 180: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
181: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
182: </dl></dd>
183: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
184: <dd><dl>
1.128 wiz 185: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
186: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 187: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
188: <dd><dl>
189: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
190: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
193: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
194: </dl></dd>
195: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
196: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
197: <dd><dl>
198: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
199: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
201: </dl></dd>
1.128 wiz 202: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
203: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 204: </dl></dd>
1.128 wiz 205: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 206: <dd><dl>
207: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 208: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
210: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
211: <dd><dl>
212: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
213: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
214: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
215: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
217: </dl></dd>
218: </dl></dd>
219: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
220: <dd><dl>
221: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 222: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
223: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 224: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
225: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 226: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106 rillig 227: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 228: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
229: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106 rillig 230: </dl></dd>
231: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
232: <dd><dl>
233: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 234: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 235: <dd><dl>
236: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 237: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
238: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
239: and
240: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
241: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 242: </dl></dd>
1.128 wiz 243: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 244: <dd><dl>
1.128 wiz 245: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 246: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
247: </dl></dd>
248: </dl></dd>
249: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
250: <dd><dl>
251: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
254: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
255: </dl></dd>
256: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
257: <dd><dl>
1.128 wiz 258: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 259: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
260: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
261: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
262: </dl></dd>
263: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
264: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
265: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
266: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
267: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
268: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
269: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
270: </dl></dd>
271: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
272: <dd><dl>
273: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 274: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 275: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 276: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 277: </dl></dd>
278: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
281: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
282: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
283: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 284: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 285: <dd><dl>
286: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
287: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
288: </dl></dd>
1.128 wiz 289: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 299: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
300: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
301: </dl></dd>
302: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
303: <dd><dl>
304: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
305: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
306: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
307: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 315: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
1.128 wiz 326: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.199 tnn 330: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106 rillig 331: </dl></dd>
1.128 wiz 332: <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 333: <dd><dl>
334: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
336: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
337: </dl></dd>
338: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
339: <dd><dl>
340: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
341: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
342: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 343: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
344: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 345: </dl></dd>
1.128 wiz 346: <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 347: <dd><dl>
348: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
349: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 350: <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 351: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
352: </dl></dd>
1.128 wiz 353: <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 354: <dd><dl>
355: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
356: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
357: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
358: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
359: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
360: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
361: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
362: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 363: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 364: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 365: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
366: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
367: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
368: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
369: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
370: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
371: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
372: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 373: emulation</a></span></dt>
1.106 rillig 374: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
375: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 376: </dl></dd>
1.106 rillig 377: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 378: </dl></dd>
1.106 rillig 379: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
380: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 381: <dd><dl>
1.106 rillig 382: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
383: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
384: <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 385: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 386: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 387: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
388: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 389: </dl></dd>
390: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
391: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
392: <dd><dl>
393: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
394: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
395: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
396: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 397: </dl></dd>
1.75 rillig 398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.106 rillig 401: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 402: <dd><dl>
1.106 rillig 403: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 406: <dd><dl>
1.106 rillig 407: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
408: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 409: </dl></dd>
1.106 rillig 410: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
411: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 412: <dd><dl>
1.106 rillig 413: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
414: <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 415: </dl></dd>
1.106 rillig 416: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 417: <dd><dl>
1.128 wiz 418: <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>
419: <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 420: </dl></dd>
421: </dl></dd>
1.106 rillig 422: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 423: <dd><dl>
1.106 rillig 424: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
426: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 427: <dd><dl>
1.106 rillig 428: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
429: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 430: </dl></dd>
431: </dl></dd>
1.106 rillig 432: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 433: <dd><dl>
1.106 rillig 434: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
435: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 436: </dl></dd>
437: </dl></dd>
438: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
439: <dd><dl>
440: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
441: <dd><dl>
442: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
443: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
444: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 445: <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 446: </dl></dd>
447: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
448: </dl></dd>
449: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
450: <dd><dl>
451: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
452: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
453: </dl></dd>
1.76 rillig 454: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
455: <dd><dl>
1.128 wiz 456: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
457: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
458: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
459: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
460: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
461: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 462: source packages</a></span></dt>
463: </dl></dd>
1.75 rillig 464: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
465: <dd><dl>
1.79 rillig 466: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 467: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
468: </dl></dd>
469: </dl>
470: </div>
1.82 rillig 471: <div class="list-of-tables">
472: <p><b>List of Tables</b></p>
473: <dl>
474: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
475: </dt>
1.106 rillig 476: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 477: </dt>
1.106 rillig 478: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 479: </dt>
1.82 rillig 480: </dl>
481: </div>
1.148 asau 482: <div class="chapter">
483: <div class="titlepage"><div><div><h1 class="title">
484: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 485: <div class="toc">
486: <p><b>Table of Contents</b></p>
1.195 wiz 487: <dl class="toc">
1.75 rillig 488: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 489: <dd><dl>
490: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
491: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
492: </dl></dd>
1.75 rillig 493: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
494: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 495: <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 496: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
497: </dl>
498: </div>
1.148 asau 499: <div class="sect1">
1.75 rillig 500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
501: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 502: <p>There is a lot of software freely available for Unix-based
503: systems, which is usually available in form of the source code. Before
504: such software can be used, it needs to be configured to the local
505: system, compiled and installed, and this is exactly what The NetBSD
506: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
507: to handle binary packages, so that not every user has to build the
508: packages for himself, which is a time-costly task.</p>
1.75 rillig 509: <p>pkgsrc currently contains several thousand packages,
510: including:</p>
1.148 asau 511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 512: <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 513: web server</p></li>
1.189 snj 514: <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 515: web browser</p></li>
1.189 snj 516: <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 517: Desktop Environment</p></li>
1.189 snj 518: <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 519: Desktop Environment</p></li>
520: </ul></div>
521: <p>...just to name a few.</p>
522: <p>pkgsrc has built-in support for handling varying dependencies,
523: such as pthreads and X11, and extended features such as IPv6 support on
524: a range of platforms.</p>
1.148 asau 525: <div class="sect2">
1.82 rillig 526: <div class="titlepage"><div><div><h3 class="title">
527: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
528: <p>
529: pkgsrc provides the following key features:
530: </p>
1.148 asau 531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 532: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 533: and installation of binary packages. The source and latest
534: patches are retrieved from a master or mirror download site, checksum
535: verified, then built on your system. Support for binary-only
536: distributions is available for both native platforms and NetBSD
537: emulated platforms.</p></li>
1.128 wiz 538: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 539: including binaries, libraries, man pages and other
540: documentation.</p></li>
1.128 wiz 541: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 542: are handled automatically. The configuration files of various
543: packages are handled automatically during updates, so local changes
544: are preserved.</p></li>
1.128 wiz 545: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 546: consists of highly portable code. This allows the greatest speed of
1.132 spz 547: development when porting to a new platform. This portability also
1.82 rillig 548: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
549: platforms</em></span>.</p></li>
1.128 wiz 550: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 551: international encryption requirements and build-time options for a
552: large number of packages are all set in a simple, central
553: configuration file.</p></li>
1.128 wiz 554: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 555: freely available under a BSD license, so you may extend and adapt
556: pkgsrc to your needs. Support for local packages and patches is
557: available right out of the box, so you can configure it specifically
558: for your environment.</p></li>
559: </ul></div>
1.91 rillig 560: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 561: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 562: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 563: — That means, if a package contains bugs, it's better to find
1.91 rillig 564: them and to complain about them rather than to just install the package
565: and hope that it works. There are numerous checks in pkgsrc that try to
1.189 snj 566: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91 rillig 567: of shell scripts), and post-installation checks (installed files,
568: references to shared libraries, script interpreters).</p></li>
1.128 wiz 569: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 570: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 571: pkgsrc has been ported to many operating systems. Care is taken that
572: packages behave the same on all platforms.</p></li>
573: </ul></div>
1.82 rillig 574: </div>
1.148 asau 575: <div class="sect2">
1.82 rillig 576: <div class="titlepage"><div><div><h3 class="title">
577: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
578: <p>pkgsrc consists of both a source distribution and a binary
579: distribution for these operating systems. After retrieving the required
580: source or binaries, you can be up and running with pkgsrc in just
581: minutes!</p>
1.75 rillig 582: <p>pkgsrc was derived from FreeBSD's ports system, and
583: initially developed for NetBSD only. Since then, pkgsrc has
584: grown a lot, and now supports the following platforms:</p>
1.82 rillig 585: <div class="table">
586: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 587: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 588: <colgroup>
589: <col>
590: <col>
591: </colgroup>
592: <thead><tr>
593: <th>Platform</th>
594: <th>Date Support Added</th>
595: </tr></thead>
596: <tbody>
597: <tr>
1.110 hubertf 598: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 599: <td align="center">Aug 1997</td>
600: </tr>
601: <tr>
1.110 hubertf 602: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 603: <td align="center">Mar 1999</td>
604: </tr>
605: <tr>
1.110 hubertf 606: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 607: <td align="center">Jun 1999</td>
608: </tr>
609: <tr>
610: <td>
1.110 hubertf 611: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
612: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 613: </td>
614: <td align="center">Oct 2001</td>
615: </tr>
616: <tr>
1.110 hubertf 617: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 618: <td align="center">Nov 2002</td>
619: </tr>
620: <tr>
1.110 hubertf 621: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 622: <td align="center">Nov 2002</td>
623: </tr>
624: <tr>
1.110 hubertf 625: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 626: <td align="center">Dec 2002</td>
627: </tr>
628: <tr>
629: <td>BSD/OS</td>
630: <td align="center">Dec 2003</td>
631: </tr>
632: <tr>
1.110 hubertf 633: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 634: <td align="center">Dec 2003</td>
635: </tr>
636: <tr>
637: <td>
1.110 hubertf 638: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 639: (Microsoft Windows Services for Unix)
640: </td>
641: <td align="center">Mar 2004</td>
642: </tr>
643: <tr>
1.110 hubertf 644: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 645: <td align="center">Oct 2004</td>
646: </tr>
647: <tr>
1.110 hubertf 648: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 649: <td align="center">Nov 2004</td>
650: </tr>
1.98 wiz 651: <tr>
1.110 hubertf 652: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 653: <td align="center">Apr 2007</td>
654: </tr>
1.128 wiz 655: <tr>
656: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
657: <td align="center">Sep 2010</td>
658: </tr>
1.151 obache 659: <tr>
660: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 661: <td align="center">Jan 2011</td>
1.151 obache 662: </tr>
663: <tr>
664: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
665: <td align="center">Nov 2011</td>
666: </tr>
667: <tr>
668: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
669: <td align="center">Mar 2013</td>
670: </tr>
1.166 jnemeth 671: <tr>
672: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
673: <td align="center">Jul 2013</td>
674: </tr>
1.82 rillig 675: </tbody>
1.91 rillig 676: </table></div>
1.82 rillig 677: </div>
1.91 rillig 678: <br class="table-break">
1.82 rillig 679: </div>
1.75 rillig 680: </div>
1.148 asau 681: <div class="sect1">
1.75 rillig 682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
683: <a name="overview"></a>1.2. Overview</h2></div></div></div>
684: <p>This document is divided into three parts. The first,
1.110 hubertf 685: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 686: describes how one can use one of the packages in the Package
687: Collection, either by installing a precompiled binary package,
1.93 rillig 688: or by building one's own copy using the NetBSD package system.
1.110 hubertf 689: 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 690: package so it can be easily built by other NetBSD users without
691: knowing about the package's building details. The third part,
1.110 hubertf 692: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 693: is intended for those who want to understand how pkgsrc is
694: implemented.</p>
695: <p>This document is available in various formats:
1.110 hubertf 696: <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 697: </div>
1.148 asau 698: <div class="sect1">
1.75 rillig 699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
700: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 701: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
702: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 703: terminology used within this document.</p>
1.148 asau 704: <div class="variablelist"><dl class="variablelist">
1.75 rillig 705: <dt><span class="term">Package</span></dt>
706: <dd><p>A set of files and building instructions
707: that describe what's necessary
708: to build a certain piece of software using
709: pkgsrc. Packages are traditionally stored under
1.76 rillig 710: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 711: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 712: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 713: is part of the NetBSD operating system and can be bootstrapped
714: to run on non-NetBSD operating systems as well. It handles
715: building (compiling), installing, and removing of
716: packages.</p></dd>
1.75 rillig 717: <dt><span class="term">Distfile</span></dt>
718: <dd><p>This term describes the file or files that are
719: provided by the author of the piece of software to
720: distribute his work. All the changes necessary to build on
721: NetBSD are reflected in the corresponding package. Usually
722: the distfile is in the form of a compressed tar-archive,
723: but other types are possible, too. Distfiles are usually
724: stored below
1.76 rillig 725: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 726: <dt><span class="term">Port</span></dt>
727: <dd><p>This is the term used by FreeBSD and OpenBSD people
728: for what we call a package.
1.128 wiz 729: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 730: architecture.</p></dd>
731: <dt><span class="term">Precompiled/binary package</span></dt>
732: <dd>
733: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 734: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 735: file so it can be installed on machines of the same
736: machine architecture without the need to
737: recompile. Packages are usually generated in
1.76 rillig 738: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 739: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 740: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 741: especially in the context of precompiled packages.</p>
742: </dd>
743: <dt><span class="term">Program</span></dt>
1.88 wiz 744: <dd><p>The piece of software to be installed which will be
745: constructed from all the files in the distfile by the
746: actions defined in the corresponding package.</p></dd>
1.75 rillig 747: </dl></div>
1.148 asau 748: <div class="sect2">
1.75 rillig 749: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 750: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 751: <div class="variablelist"><dl class="variablelist">
1.75 rillig 752: <dt><span class="term">pkgsrc users</span></dt>
753: <dd>
754: <p>The
755: pkgsrc users are people who use the packages provided by pkgsrc.
756: Typically they are system administrators. The people using the
1.128 wiz 757: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
758: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 759: <p>There are two kinds of pkgsrc users: Some only want to
760: install pre-built binary packages. Others build the pkgsrc
761: packages from source, either for installing them directly or for
1.110 hubertf 762: 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 763: documentation.</p>
764: </dd>
765: <dt><span class="term">package maintainers</span></dt>
766: <dd><p>A
1.110 hubertf 767: 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 768: <dt><span class="term">infrastructure developers</span></dt>
769: <dd><p>These people are involved in all those files
1.76 rillig 770: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 771: 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 772: too.</p></dd>
773: </dl></div>
774: </div>
775: </div>
1.148 asau 776: <div class="sect1">
1.75 rillig 777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
778: <a name="typography"></a>1.4. Typography</h2></div></div></div>
779: <p>When giving examples for commands, shell prompts are used to
780: show if the command should/can be issued as root, or if
1.128 wiz 781: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 782: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
783: shell prompt, assuming they use the C-shell or tcsh.</p>
784: </div>
785: </div>
1.148 asau 786: <div class="part">
1.75 rillig 787: <div class="titlepage"><div><div><h1 class="title">
788: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
789: <div class="toc">
790: <p><b>Table of Contents</b></p>
1.195 wiz 791: <dl class="toc">
1.75 rillig 792: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
793: <dd><dl>
794: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
795: <dd><dl>
1.157 asau 796: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 797: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 798: </dl></dd>
799: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
800: <dd><dl>
801: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
802: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
803: </dl></dd>
804: </dl></dd>
805: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
806: <dd><dl>
1.82 rillig 807: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
808: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
809: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
810: <dd><dl>
1.151 obache 811: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
812: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
813: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 814: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
815: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
816: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
817: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
818: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
819: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
820: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 821: </dl></dd>
822: </dl></dd>
823: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
824: <dd><dl>
825: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
826: <dd><dl>
827: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
828: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 829: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
830: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
831: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
832: <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>
833: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
834: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 835: </dl></dd>
836: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
837: <dd><dl>
838: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
839: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
840: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
841: </dl></dd>
842: </dl></dd>
843: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
844: <dd><dl>
845: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
846: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 847: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 848: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 849: <dd><dl>
1.103 wiz 850: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 851: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
852: <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 853: </dl></dd>
1.103 wiz 854: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
855: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 856: </dl></dd>
857: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
858: <dd><dl>
859: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
860: <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 861: </dl></dd>
862: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
863: builds)</a></span></dt>
1.75 rillig 864: <dd><dl>
1.180 wiz 865: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
866: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
867: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
868: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 869: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
870: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 871: </dl></dd>
872: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
873: <dd><dl>
1.128 wiz 874: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
875: <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 876: </dl></dd>
877: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
878: <dd><dl>
879: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194 bsiegert 880: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
881: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
882: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
883: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
884: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
885: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
886: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
887: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
888: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 889: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 890: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
891: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
892: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
893: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
894: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
895: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
896: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 897: </dl></dd>
898: </dl>
899: </div>
1.148 asau 900: <div class="chapter">
1.75 rillig 901: <div class="titlepage"><div><div><h2 class="title">
902: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
903: <div class="toc">
904: <p><b>Table of Contents</b></p>
1.195 wiz 905: <dl class="toc">
1.75 rillig 906: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
907: <dd><dl>
1.157 asau 908: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 909: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 910: </dl></dd>
911: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
912: <dd><dl>
913: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
914: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
915: </dl></dd>
916: </dl>
917: </div>
1.91 rillig 918: <p>Before you download and extract the files, you need to decide
919: where you want to extract them. When using pkgsrc as root user, pkgsrc
920: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
921: free to install the sources and binary packages wherever you want in
922: your filesystem, provided that the pathname does not contain white-space
923: or other characters that are interpreted specially by the shell and some
924: other programs. A safe bet is to use only letters, digits, underscores
925: and dashes.</p>
1.148 asau 926: <div class="sect1">
1.75 rillig 927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
928: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
929: <p>Before you download any pkgsrc files, you should decide
930: whether you want the <span class="emphasis"><em>current</em></span> branch or the
931: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
932: quarterly basis from the current branch and only gets modified
933: for security updates. The names of the stable branches are built
934: from the year and the quarter, for example
1.188 snj 935: <code class="literal">2014Q3</code>.</p>
1.75 rillig 936: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 937: want to download pkgsrc. You can get it as a tar file or via CVS.
938: Both ways are described here.</p>
1.157 asau 939: <p>Note that tar archive contains CVS working copy.
940: Thus you can switch to using CVS at any later time.</p>
1.148 asau 941: <div class="sect2">
1.75 rillig 942: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 943: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 944: <p>The primary download location for all pkgsrc files is
1.157 asau 945: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
946: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
947: (it points to the same location).
948: There are a number of subdirectories for different purposes,
949: 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>
950: <p>The tar archive for the current branch is in the directory
951: <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 952: It is autogenerated daily.</p>
1.157 asau 953: <p>To save download time we provide bzip2- and
954: xz-compressed archives which are published at
955: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
956: and
957: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
958: respectively.
959: </p>
960: <p>You can fetch the same files using FTP.</p>
1.188 snj 961: <p>The tar file for the stable branch 2014Q3 is in the
962: directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112 weinem 963: <p>To download a pkgsrc stable tarball, run:</p>
964: <pre class="screen">
1.166 jnemeth 965: <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 966: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 967: stable branch to be downloaded, for example,
1.188 snj 968: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
969: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 970: or your web browser.</p>
1.112 weinem 971: <p>Then, extract it with:</p>
1.188 snj 972: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 973: <p>This will create the directory <code class="filename">pkgsrc/</code>
974: in <code class="filename">/usr/</code> and all the package source will be
975: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
976: <p>To download pkgsrc-current, run:</p>
977: <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 978: </div>
1.148 asau 979: <div class="sect2">
1.75 rillig 980: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 981: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
982: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146 wiz 983: <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 984: </pre>
985: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.188 snj 986: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.128 wiz 987: <p>This will create the directory <code class="filename">pkgsrc/</code>
988: in your <code class="filename">/usr/</code> directory and all the package source
989: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
990: <p>To fetch the pkgsrc current 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 -P pkgsrc</code></strong>
1.1 grant 992: </pre>
1.188 snj 993: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128 wiz 994: <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 995: <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 996: </pre>
997: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
998: For Bourne shells, you can set it in your <code class="filename">.profile</code>
999: or better globally in <code class="filename">/etc/profile</code>:</p>
1000: <pre class="programlisting">
1001: # set CVS remote shell command
1002: CVS_RSH=ssh
1003: export CVS_RSH
1004: </pre>
1005: <p>By default, CVS doesn't do things like most people would expect it to do.
1006: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1007: in your home directory and saving the following lines to it.
1008: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1009: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1010: <pre class="programlisting">
1011: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1012: cvs -q -z2
1.101 rillig 1013: checkout -P
1.103 wiz 1014: update -dP
1015: diff -upN
1.101 rillig 1016: rdiff -u
1.128 wiz 1017: release -d
1.101 rillig 1018: </pre>
1.75 rillig 1019: </div>
1020: </div>
1.148 asau 1021: <div class="sect1">
1.75 rillig 1022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1023: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1024: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1025: (which also works if you have first installed it via a tar
1026: file). It saves bandwidth and hard disk activity, compared to
1027: downloading the tar file again.</p>
1.148 asau 1028: <div class="sect2">
1.75 rillig 1029: <div class="titlepage"><div><div><h3 class="title">
1030: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148 asau 1031: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1032: <h3 class="title">Warning</h3>
1.77 rillig 1033: <p>When updating from a tar file, you first need to
1034: completely remove the old pkgsrc directory. Otherwise those
1035: files that have been removed from pkgsrc in the mean time will
1036: not be removed on your local disk, resulting in inconsistencies.
1037: When removing the old files, any changes that you have done to
1038: the pkgsrc files will be lost after updating. Therefore updating
1039: via CVS is strongly recommended.</p>
1.75 rillig 1040: </div>
1.82 rillig 1041: <p>Note that by default the distfiles and the binary packages
1042: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1043: before updating. You can also configure pkgsrc to store distfiles
1044: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1045: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1046: 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 1047: <p>To update pkgsrc from a tar file, download the tar file as
1048: explained above. Then, make sure that you have not made any
1049: changes to the files in the pkgsrc directory. Remove the pkgsrc
1050: directory and extract the new tar file. Done.</p>
1051: </div>
1.148 asau 1052: <div class="sect2">
1.75 rillig 1053: <div class="titlepage"><div><div><h3 class="title">
1054: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132 spz 1055: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1056: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1057: </pre>
1058: <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>
1059: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1060: </pre>
1.148 asau 1061: <div class="sect3">
1.75 rillig 1062: <div class="titlepage"><div><div><h4 class="title">
1063: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1064: <p>When updating pkgsrc, the CVS program keeps track of the
1065: branch you selected. But if you, for whatever reason, want to
1066: switch from the stable branch to the current one, you can do it
1.128 wiz 1067: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1068: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1069: back to the stable branch, add the
1.188 snj 1070: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.75 rillig 1071: </div>
1.148 asau 1072: <div class="sect3">
1.75 rillig 1073: <div class="titlepage"><div><div><h4 class="title">
1074: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1075: <p>When you update pkgsrc, the CVS program will only touch
1076: those files that are registered in the CVS repository. That
1077: means that any packages that you created on your own will stay
1078: unmodified. If you change files that are managed by CVS, later
1079: updates will try to merge your changes with those that have been
1080: done by others. See the CVS manual, chapter
1.128 wiz 1081: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1082: </div>
1083: </div>
1084: </div>
1085: </div>
1.148 asau 1086: <div class="chapter">
1.75 rillig 1087: <div class="titlepage"><div><div><h2 class="title">
1088: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1089: <div class="toc">
1090: <p><b>Table of Contents</b></p>
1.195 wiz 1091: <dl class="toc">
1.82 rillig 1092: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1093: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1094: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1095: <dd><dl>
1.151 obache 1096: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1097: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1098: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 1099: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1100: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1101: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1102: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1103: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1104: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1105: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 1106: </dl></dd>
1107: </dl>
1108: </div>
1.148 asau 1109: <div class="sect1">
1.75 rillig 1110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1111: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1112: <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 1113: </div>
1.148 asau 1114: <div class="sect1">
1.82 rillig 1115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1116: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1117: <p>pkgsrc can be bootstrapped for use in two different modes:
1118: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1119: to privileged one all programs are installed under one particular user
1.149 asau 1120: and cannot utilise privileged operations (packages don't create
1121: special users and all special file permissions like setuid are ignored).
1122: </p>
1.82 rillig 1123: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1124: <pre class="screen">
1.167 asau 1125: <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 1126: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1127: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1128: </pre>
1.149 asau 1129: <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>
1130: <p>By default, in privileged mode pkgsrc uses
1131: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1132: where programs will be installed in,
1.87 wiz 1133: and <code class="filename">/var/db/pkg</code> for the package database
1.149 asau 1134: directory where pkgsrc will do its internal bookkeeping,
1135: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1136: where packages install their persistent data.
1137: In unprivileged mode pkgsrc uses
1138: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1139: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1140: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1141: </p>
1142: <p>You can change default layout using command-line arguments.
1143: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1144: </p>
1.148 asau 1145: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1146: <h3 class="title">Note</h3>
1.110 hubertf 1147: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1148: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1149: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1150: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1151: </div>
1.149 asau 1152: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1153: <h3 class="title">Note</h3>
1154: <p>It is possible to bootstrap multiple instances of pkgsrc
1155: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1156: corresponding to the installation you're working with to build
1157: and install packages.
1158: </p>
1159: </div>
1.75 rillig 1160: </div>
1.148 asau 1161: <div class="sect1">
1.75 rillig 1162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1163: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1164: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 asau 1165: <div class="sect2">
1.75 rillig 1166: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1167: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1168: <p>Cygwin 1.7.x and later are supported.</p>
1169: <p>You need to install minimal base packages in `Base' category
1170: plus any of compiler, gcc, gcc4, and/or clang.
1171: For gcc and gcc4, C and C++ compiler will be installed by default,
1172: but you can install Fortran compiler additionally
1173: because it will be required to use libtool.
1174: If it is not installed (or too old), Fortran compiler will be
1175: installed with pkgsrc automatically.</p>
1176: <p>As noted in
1177: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1178: su(1) command has been in Cygwin distribution, but it has never worked.
1179: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1180: </p>
1181: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1182: then pick "Run as administrator".</p></li></ul></div>
1183: </div>
1184: <div class="sect2">
1185: <div class="titlepage"><div><div><h3 class="title">
1186: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.148 asau 1187: <p>Darwin 5.x and up are supported.</p>
1188: <p>Before you start, you need to download and install
1189: the Mac OS X Developer Tools from Apple's Developer Connection.
1190: This requires (free) membership. See
1.126 jakllsch 1191: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 asau 1192: for details. Also, make sure you install X11 (an optional
1193: package included with the Developer Tools) if you intend
1194: to build packages that use the X11 Window System.
1195: (If you don't want or need the full Xcode GUI,
1196: download and install Command Line Tools for Xcode.)</p>
1.75 rillig 1197: </div>
1.148 asau 1198: <div class="sect2">
1.75 rillig 1199: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1200: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136 dholland 1201: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1202: other versions may work.</p>
1.75 rillig 1203: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1204: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1205: <div class="orderedlist"><ol class="orderedlist" type="1">
1206: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 1207: <code class="filename">/var/db/pkg</code>. It is therefore
1208: recommended that you choose a different location (e.g.
1209: <code class="filename">/usr/pkgdb</code>) by
1210: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1211: <li class="listitem">
1.75 rillig 1212: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1213: good idea to move them out of the way to avoid confusion, e.g.</p>
1214: <pre class="screen">
1215: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1216: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1217: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1218: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1219: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1220: </pre>
1.75 rillig 1221: </li>
1.128 wiz 1222: <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 1223: <code class="filename">/etc/mk.conf.example</code> file
1224: when you use the bootstrap script.</p></li>
1.75 rillig 1225: </ol></div>
1226: </div>
1.148 asau 1227: <div class="sect2">
1.75 rillig 1228: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1229: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1230: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1231: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1232: <p> You should install ncurses (libncurses and libncurses-dev)
1233: packages.</p>
1234: </div>
1235: <div class="sect2">
1236: <div class="titlepage"><div><div><h3 class="title">
1237: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75 rillig 1238: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1239: providing a Unix-like environment with a tighter kernel integration than
1240: available with Cygwin. It is part of the Windows Services for Unix
1241: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1242: (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 1243: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1244: are not officially supported. (The main difference in 3.0/3.1 is lack
1245: of pthreads, but other parts of libc may also be lacking.)</p>
1.129 wiz 1246: <p>Services for Unix Applications (aka SUA) is an integrated
1247: component of Windows Server 2003 R2 (5.2), Windows Vista and
1248: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1249: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1250: 6.1 (64bit) subsystems have been tested. Other versions may
1251: work as well. The Interix 5.x subsystem has not yet been tested
1252: with pkgsrc.</p>
1.148 asau 1253: <div class="sect3">
1.75 rillig 1254: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1255: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1256: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1257: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 asau 1258: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1259: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1260: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1261: <li class="listitem"><p>Remote Connectivity</p></li>
1262: <li class="listitem"><p>Interix SDK</p></li>
1.75 rillig 1263: </ul></div>
1264: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1265: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1266: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1267: pkgsrc (or from a binary package).</p>
1.75 rillig 1268: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1269: not need to be installed, but Remote Connectivity itself should be
1270: installed in order to have a working inetd.</p>
1.75 rillig 1271: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1272: behavior for Interix programs, and whether to make pathnames default to
1273: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1274: enabled. (Without case-sensitivity, a large number of packages including
1275: perl will not build.)</p>
1.75 rillig 1276: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1277: works (via the Data Execution Prevention feature). In order to use
1278: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1279: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1280: must be installed. Hotfixes are available from Microsoft through a
1.114 jmcneill 1281: support contract; however, Debian Interix Port has made most Interix
1282: 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 1283: <p>In addition to the hotfix noted above, it may be necessary to
1284: disable Data Execution Prevention entirely to make Interix functional.
1285: This may happen only with certain types of CPUs; the cause is not fully
1286: understood at this time. If gcc or other applications still segfault
1287: repeatedly after installing one of the hotfixes note above, the
1288: following option can be added to the appropriate "boot.ini" line on the
1289: Windows boot drive: /NoExecute=AlwaysOff
1290: (WARNING, this will disable DEP completely, which may be a security
1291: risk if applications are often run as a user in the Administrators
1292: group!)</p>
1.75 rillig 1293: </div>
1.148 asau 1294: <div class="sect3">
1.75 rillig 1295: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1296: <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 1297: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1298: with pkgsrc, note the following things.</p>
1.148 asau 1299: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1300: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1301: Windows Services for UNIX, then click Change. In the installer, choose
1302: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1303: <li class="listitem">
1.75 rillig 1304: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1305: change the following registry key:</p>
1.75 rillig 1306: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1307: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1308: </li>
1.128 wiz 1309: <li class="listitem">
1.75 rillig 1310: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1311: following registry key:</p>
1.75 rillig 1312: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1313: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1314: </li>
1315: </ul></div>
1316: </div>
1.148 asau 1317: <div class="sect3">
1.75 rillig 1318: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1319: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1320: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1321: running "pkg_add") must be a member of the local Administrators
1322: group. Such a user must also be used to run the bootstrap. This is
1323: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1324: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1325: automatically complain if this is not the case. This ensures that
1326: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1327: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1328: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1329: NOT be used in conjunction with pkgsrc. If you choose to use them at
1330: the same time as the pkgsrc packages, ensure that you use the proper
1331: pkg_* tools for each type of binary package.</p>
1.75 rillig 1332: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1333: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1334: don't have a termcap/terminfo entry for it, but the following .termcap
1335: entry provides adequate emulation in most cases:</p>
1.75 rillig 1336: <pre class="programlisting">
1.100 rillig 1337: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1338: </pre>
1.75 rillig 1339: </div>
1.148 asau 1340: <div class="sect3">
1.75 rillig 1341: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1342: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1343: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1344: for a full Unix-like platform, it has some drawbacks that should
1345: be noted for those desiring to make the most of Interix.</p>
1.148 asau 1346: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1347: <li class="listitem">
1.75 rillig 1348: <p><span class="strong"><strong>X11:</strong></span></p>
1349: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1350: and can run X11 based applications, but it does
1351: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1352: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1353: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1354: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1355: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1356: and the free X11 server included with
1.110 hubertf 1357: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1358: </li>
1.128 wiz 1359: <li class="listitem">
1.75 rillig 1360: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1361: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1362: Win32 applications, it does not currently support various X11
1363: protocol extensions for acceleration (such as MIT-SHM or DGA).
1364: Most interactive applications to a local X server will run
1365: reasonably fast, but full motion video and other graphics
1366: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1367: </li>
1.128 wiz 1368: <li class="listitem">
1.75 rillig 1369: <p><span class="strong"><strong>Audio:</strong></span></p>
1370: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1371: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1372: audio system on Interix. Unlike on most platforms, the
1.189 snj 1373: <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 1374: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1375: server component. To output audio via an Interix host, the
1.189 snj 1376: <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 1377: must also be installed.</p>
1.75 rillig 1378: </li>
1.128 wiz 1379: <li class="listitem">
1.75 rillig 1380: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1381: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1382: is not currently possible to access CD/DVD drives, USB devices,
1383: or SCSI devices through non-filesystem means. Among other things,
1384: this makes it impossible to use Interix directly for CD/DVD
1385: burning.</p>
1.75 rillig 1386: </li>
1.128 wiz 1387: <li class="listitem">
1.75 rillig 1388: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1389: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1390: drives are also not directly accessible in Interix. However,
1391: support is in work to make tape drive access possible by using
1392: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1393: esound server).</p>
1.75 rillig 1394: </li>
1395: </ul></div>
1396: </div>
1.148 asau 1397: <div class="sect3">
1.75 rillig 1398: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1399: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1400: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1401: Windows system; any member of the local Administrators group will
1402: suffice. However, some packages currently assume that the user
1403: named "root" is the privileged user. To accommodate these, you
1404: may create such a user; make sure it is in the local group
1405: Administrators (or your language equivalent).</p>
1.110 hubertf 1406: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1407: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1408: time being, install packages as the local Administrator (or
1409: your language equivalent), or run the following command after
1410: installing a package to work around the issue:</p>
1.75 rillig 1411: <pre class="screen">
1.87 wiz 1412: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1413: </pre>
1.75 rillig 1414: </div>
1415: </div>
1.148 asau 1416: <div class="sect2">
1.75 rillig 1417: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1418: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75 rillig 1419: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1420: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1421: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1422: 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 1423: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.189 snj 1424: 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 1425: etc.</p>
1.86 schwarz 1426: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1427: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1428: you start out using "abi=n32", that's what all your packages will be built
1429: with.</p>
1430: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1431: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1432: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1433: try to link n32 object files with lib64 or vice versa. Check your
1434: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1435: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1436: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1437: as it appears that IRIX linker occasionally runs into issues when trying to
1438: link over a network-mounted file system.</p>
1.75 rillig 1439: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1440: as imake(1), but you may want to set some options depending on your local
1441: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1442: course, your compiler's man pages for details.</p>
1.75 rillig 1443: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1444:
1.87 wiz 1445: </p>
1.75 rillig 1446: <pre class="programlisting">
1.100 rillig 1447: PKGSRC_COMPILER= mipspro
1.87 wiz 1448: </pre>
1.75 rillig 1449: <p>
1.1 grant 1450:
1.110 hubertf 1451: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1452: are using gcc and may end up passing invalid flags to the compiler. Note that
1453: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1454: default.</p>
1.75 rillig 1455: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1456: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1457: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1458: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1459: '--preserve-path' flag.</p>
1.75 rillig 1460: </div>
1.148 asau 1461: <div class="sect2">
1.75 rillig 1462: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1463: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87 wiz 1464: <p>Some versions of Linux (for example Debian GNU/Linux) need
1465: either libtermcap or libcurses (libncurses). Installing the
1466: distributions libncurses-dev package (or equivalent) should fix
1467: the problem.</p>
1468: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1469: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1470: i386 have been tested.</p>
1.75 rillig 1471: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1472: directory:</p>
1.75 rillig 1473: <pre class="programlisting">
1.138 wiz 1474: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1475: </pre>
1.148 asau 1476: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1477: <h3 class="title">Note</h3>
1.138 wiz 1478: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1479: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1480: <p>For icc 10.1 neither of these appears to be necessary.</p>
1481: </div>
1482: <p>Use a value for ICCBASE that corresponds to the directory
1483: where icc is installed. After bootstrapping, set
1484: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137 wiz 1485: <pre class="programlisting">
1.138 wiz 1486: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1487: </pre>
1.138 wiz 1488: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1489: <code class="filename">/opt/intel_cc_80</code>. This is the default
1490: install directory for icc 8.0. If you are using a more recent
1491: version, be sure to set the correct path explicitly.
1492: </p>
1.75 rillig 1493: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1494: provided by icc, so binaries can be run on other systems which do not
1495: have the shared libraries installed.</p>
1496: <p>Libtool, however, extracts a list of libraries from the
1.189 snj 1497: <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 1498: records it, throwing away the -Bstatic and -Bdynamic options
1499: interspersed between the libraries. This means that
1500: libtool-linked C++ shared libraries will have a runtime
1501: dependency on the icc libraries until this is fixed in
1502: libtool.</p>
1.75 rillig 1503: </div>
1.148 asau 1504: <div class="sect2">
1.75 rillig 1505: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1506: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163 bsiegert 1507: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1508: Older versions might also work. Releases before #10 are not
1509: supported.</p>
1510: <p>The package tools of the (older) native ports tree,
1511: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1512: have the same names as the ones used by pkgsrc. Care should be taken
1513: that the right tools are used. When installing packages from source,
1514: use the <code class="filename">bmake</code> command for pkgsrc and
1515: <code class="filename">mmake</code> for MirPorts.</p>
1516: <p>pkgsrc and MirPorts use the same location for the package
1517: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1518: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1519: tree is self-contained. This is also the default setting used in the
1520: binary package builds.</p>
1521: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1522: server. The bootstrap kit there already contains the
1523: <span class="command"><strong>pkgin</strong></span> package manager. See the
1524: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1525: page for more details.</p>
1526: </div>
1527: <div class="sect2">
1528: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1529: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136 dholland 1530: <p>OpenBSD 5.1 has been tested and supported,
1531: other versions may work.</p>
1.75 rillig 1532: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1533: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1534: <div class="orderedlist"><ol class="orderedlist" type="1">
1535: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 1536: <code class="filename">/var/db/pkg</code>. It is therefore
1537: recommended that you choose a different location (e.g.
1538: <code class="filename">/usr/pkgdb</code>) by
1539: using the --pkgdbdir option to the bootstrap script.</p></li>
1.128 wiz 1540: <li class="listitem">
1.75 rillig 1541: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1542: good idea to move them out of the way to avoid confusion, e.g.</p>
1543: <pre class="screen">
1544: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1545: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1546: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1547: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1548: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1549: </pre>
1.75 rillig 1550: </li>
1.128 wiz 1551: <li class="listitem">
1.110 hubertf 1552: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1553: <code class="filename">/etc/mk.conf.example</code> file
1554: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1555: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1556: as well. You can work around this by enclosing all the pkgsrc-specific parts
1557: of the file with:</p>
1558: <pre class="programlisting">
1.100 rillig 1559: .ifdef BSD_PKG_MK
1560: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1561: .else
1562: # OpenBSD stuff
1563: .endif
1.87 wiz 1564: </pre>
1.75 rillig 1565: </li>
1566: </ol></div>
1567: </div>
1.148 asau 1568: <div class="sect2">
1.75 rillig 1569: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1570: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142 wiz 1571: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1572: You will need a working C compiler. Both gcc 4.5.3 and
1.87 wiz 1573: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1574: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1575: process and to build packages.</p>
1.148 asau 1576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1577: <li class="listitem"><p>SUNWsprot</p></li>
1578: <li class="listitem"><p>SUNWarc</p></li>
1579: <li class="listitem"><p>SUNWbtool</p></li>
1580: <li class="listitem"><p>SUNWtoo</p></li>
1581: <li class="listitem"><p>SUNWlibm</p></li>
1.75 rillig 1582: </ul></div>
1.78 rillig 1583: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1584: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1585: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1586: your $prefix are in your <code class="varname">PATH</code>. This includes
1587: <code class="filename">/usr/ccs/{bin,lib}</code>
1588: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148 asau 1589: <div class="sect3">
1.75 rillig 1590: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1591: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1592: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1593: for building all packages.</p>
1.75 rillig 1594: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1595: then either build gcc from
1.189 snj 1596: <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 1597: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1598: <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 1599: </div>
1.148 asau 1600: <div class="sect3">
1.75 rillig 1601: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1602: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1603: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1604: 5.0)</p>
1.148 asau 1605: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1606: <li class="listitem"><p>SPROcc
1.87 wiz 1607: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1608: <li class="listitem"><p>SPROcpl
1.87 wiz 1609: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1610: <li class="listitem"><p>SPROild
1.87 wiz 1611: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1612: <li class="listitem"><p>SPROlang
1.87 wiz 1613: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1614: </ul></div>
1.96 rillig 1615: <p>You should set the following variables in your
1.110 hubertf 1616: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1617: <pre class="programlisting">
1.100 rillig 1618: CC= cc
1619: CXX= CC
1620: CPP= cc -E
1621: CXXCPP= CC -E
1.96 rillig 1622: </pre>
1.148 asau 1623: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1624: <h3 class="title">Note</h3>
1625: <p>The <code class="varname">CPP</code> setting might break some
1626: packages that use the C preprocessor for processing things other
1627: than C source code.</p>
1628: </div>
1.75 rillig 1629: </div>
1.148 asau 1630: <div class="sect3">
1.75 rillig 1631: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1632: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1633: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1634: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1635: <pre class="programlisting">
1.100 rillig 1636: PKGSRC_COMPILER= sunpro
1637: ABI= 64
1.96 rillig 1638: </pre>
1.148 asau 1639: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 1640: <h3 class="title">Note</h3>
1641: <p>This setting has been tested for the SPARC
1642: architecture. Intel and AMD machines need some more
1643: work.</p>
1644: </div>
1.75 rillig 1645: </div>
1.148 asau 1646: <div class="sect3">
1.75 rillig 1647: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1648: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110 hubertf 1649: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1650: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1651: The workaround is to use another shell for the configure
1.189 snj 1652: 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 1653: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1654: <pre class="programlisting">
1.100 rillig 1655: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1656: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1657: </pre>
1.189 snj 1658: <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 1659: </div>
1660: </div>
1661: </div>
1662: </div>
1.148 asau 1663: <div class="chapter">
1.75 rillig 1664: <div class="titlepage"><div><div><h2 class="title">
1665: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1666: <div class="toc">
1667: <p><b>Table of Contents</b></p>
1.195 wiz 1668: <dl class="toc">
1.75 rillig 1669: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1670: <dd><dl>
1671: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1672: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1673: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1674: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1675: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1676: <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>
1677: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1678: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1679: </dl></dd>
1680: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1681: <dd><dl>
1682: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1683: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1684: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1685: </dl></dd>
1686: </dl>
1687: </div>
1688: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1689: is to only install the package tools and to use binary packages
1.128 wiz 1690: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1691: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1692: of pkgsrc, too. Then you are able to build your own packages,
1693: and you can still use binary packages from someone else.</p>
1.148 asau 1694: <div class="sect1">
1.75 rillig 1695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1696: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1697: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1698: server and its mirrors, there are collections of binary packages,
1699: ready to be installed. These binary packages have been built using the
1700: default settings for the directories, that is:</p>
1.148 asau 1701: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1702: <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>
1703: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1704: <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 1705: </ul></div>
1706: <p>If you cannot use these directories for whatever reasons (maybe
1707: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1708: 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 1709: <div class="sect2">
1.75 rillig 1710: <div class="titlepage"><div><div><h3 class="title">
1711: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1712: <p>To install binary packages, you first need to know from where
1713: to get them. The first place where you should look is on the main
1.110 hubertf 1714: 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 1715: <p>This directory contains binary packages for multiple
1716: platforms. First, select your operating system. (Ignore the
1717: directories with version numbers attached to it, they just exist for
1718: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1719: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1720: <p>In this directory, you often find a file called
1721: <code class="filename">bootstrap.tar.gz</code> which contains the package
1722: management tools. If the file is missing, it is likely that your
1723: operating system already provides those tools. Download the file and
1724: extract it in the <code class="filename">/</code> directory. It will create
1725: the directories <code class="filename">/usr/pkg</code> (containing the tools
1726: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1727: (the database of installed packages).</p>
1.75 rillig 1728: </div>
1.148 asau 1729: <div class="sect2">
1.75 rillig 1730: <div class="titlepage"><div><div><h3 class="title">
1731: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1732: <p>In the directory from the last section, there is a
1.196 wiz 1733: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1734: binary packages that are available for the platform, excluding those
1735: that may not be distributed via FTP or CDROM (depending on which
1.128 wiz 1736: medium you are using).</p>
1.109 rillig 1737: <p>To install packages directly from an FTP or HTTP server, run
1738: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1739: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1740: <pre class="screen">
1741: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196 wiz 1742: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109 rillig 1743: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1744: </pre>
1745: <p>Instead of URLs, you can also use local paths, for example if
1746: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1747: repository. If you want to install packages from multiple sources,
1748: you can separate them by a semicolon in
1749: <code class="varname">PKG_PATH</code>.</p>
1750: <p>After these preparations, installing a package is very
1751: easy:</p>
1752: <pre class="screen">
1753: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1754: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1755: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1756: </pre>
1.75 rillig 1757: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1758: package in question will be installed, too, assuming they are
1759: present where you install from.</p>
1.128 wiz 1760: <p>Adding packages might install vulnerable packages.
1761: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1762: regularly, especially after installing new packages, and verify
1763: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1764: <p>After you've installed packages, be sure to have
1.88 wiz 1765: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1766: <code class="varname">PATH</code> so you can actually start the just
1767: installed program.</p>
1.75 rillig 1768: </div>
1.148 asau 1769: <div class="sect2">
1.75 rillig 1770: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1771: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1772: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1773: installed from source code or from a binary package. The
1.110 hubertf 1774: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1775: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1776: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1777: name can be given with or without version number. Wildcards can
1778: also be used to deinstall a set of packages, for example
1779: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1780: so that the shell does not expand them before
1781: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1782: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1783: removes all the packages that require the package in question
1784: and then removes the package itself. For example:
1.82 rillig 1785:
1.88 wiz 1786: </p>
1.82 rillig 1787: <pre class="screen">
1.88 wiz 1788: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1789: </pre>
1.82 rillig 1790: <p>
1791:
1.88 wiz 1792: will remove jpeg and all the packages that used it; this allows
1793: upgrading the jpeg package.</p>
1.82 rillig 1794: </div>
1.148 asau 1795: <div class="sect2">
1.82 rillig 1796: <div class="titlepage"><div><div><h3 class="title">
1797: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1798: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1799: installed packages or binary package files.</p>
1.82 rillig 1800: </div>
1.148 asau 1801: <div class="sect2">
1.82 rillig 1802: <div class="titlepage"><div><div><h3 class="title">
1803: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1804: <p>
1.88 wiz 1805: The NetBSD Security-Officer and Packages Groups maintain a list of
1806: known security vulnerabilities to packages which are (or have been)
1807: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1808: 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 1809: </p>
1.82 rillig 1810: <p>
1.125 wiz 1811: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1812: this list can be downloaded
1813: automatically, and a security audit of all packages installed on a system
1814: can take place.
1815: </p>
1.82 rillig 1816: <p>
1.125 wiz 1817: There are two components to auditing. The first
1818: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1819: is for downloading
1.88 wiz 1820: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1821: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1822: installed packages are vulnerable. If a package is vulnerable, you
1823: will see output similar to the following:
1824: </p>
1.82 rillig 1825: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1826: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1827: <p>
1.125 wiz 1828: You may wish to have the
1.110 hubertf 1829: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1830: file downloaded daily so that
1831: it remains current. This may be done by adding an appropriate entry
1.189 snj 1832: 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 1833: </p>
1834: <pre class="screen">
1835: # download vulnerabilities file
1836: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1837: </pre>
1838: <p>
1839: will update the vulnerability list every day at 3AM. You may wish to do
1840: this more often than once a day.
1841:
1842: In addition, you may wish to run the package audit from the daily
1843: security script. This may be accomplished by adding the following
1844: line to <code class="filename">/etc/security.local</code>:
1845: </p>
1846: <pre class="screen">
1847: /usr/sbin/pkg_admin audit
1848: </pre>
1849: <p>
1.88 wiz 1850: </p>
1.82 rillig 1851: </div>
1.148 asau 1852: <div class="sect2">
1.82 rillig 1853: <div class="titlepage"><div><div><h3 class="title">
1854: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1855: <p>
1.189 snj 1856: 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 1857: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 1858: argument to check if your packages are up-to-date, e.g.
1859: </p>
1860: <pre class="screen">
1861: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1862: ...
1.88 wiz 1863: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1864: </pre>
1.110 hubertf 1865: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1866: package on your system and rebuild any dependencies.
1867: </p>
1.82 rillig 1868: </div>
1.148 asau 1869: <div class="sect2">
1.82 rillig 1870: <div class="titlepage"><div><div><h3 class="title">
1871: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1872: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1873: administrative functions on the package system.</p>
1.82 rillig 1874: </div>
1.148 asau 1875: <div class="sect2">
1.82 rillig 1876: <div class="titlepage"><div><div><h3 class="title">
1877: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1878: <p>Please pay very careful attention to the warnings
1.189 snj 1879: 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 1880: inherent dangers of installing binary packages which you did
1881: not create yourself, and the security holes that can be
1882: introduced onto your system by indiscriminate adding of such
1883: files.</p>
1.75 rillig 1884: <p>The same warning of course applies to every package you
1.88 wiz 1885: install from source when you haven't completely read and
1886: understood the source code of the package, the compiler that
1887: is used to build the package and all the other tools that are
1888: involved.</p>
1.75 rillig 1889: </div>
1890: </div>
1.148 asau 1891: <div class="sect1">
1.75 rillig 1892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1893: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1894: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1895: directory now contains a set of packages, organized into
1896: categories. You can browse the online index of packages, or run
1.110 hubertf 1897: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1898: directory to build local <code class="filename">README.html</code> files for
1.189 snj 1899: 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 1900: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1901: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1902: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1903: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1904: different <code class="varname">LOCALBASE</code> definitions on the same
1905: system (inside a chroot is an exception). </p>
1906: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1907: 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 1908: instructions how to create your own packages.</p>
1.148 asau 1909: <div class="sect2">
1.75 rillig 1910: <div class="titlepage"><div><div><h3 class="title">
1911: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1912: <p>To build packages from source, you need a working C
1.88 wiz 1913: compiler. On NetBSD, you need to install the
1.128 wiz 1914: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1915: sets. If you want to build X11-related packages, the
1.128 wiz 1916: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1917: sets are required, too.</p>
1.75 rillig 1918: </div>
1.148 asau 1919: <div class="sect2">
1.75 rillig 1920: <div class="titlepage"><div><div><h3 class="title">
1921: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1922: <p>The first step for building a package is downloading the
1.88 wiz 1923: distfiles (i.e. the unmodified source). If they have not yet been
1924: downloaded, pkgsrc will fetch them automatically.</p>
1925: <p>If you have all files that you need in the
1926: <code class="filename">distfiles</code> directory,
1927: you don't need to connect. If the distfiles are on CD-ROM, you can
1928: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1929: </p>
1.82 rillig 1930: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1931: <p>
1.110 hubertf 1932: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1933: <p>By default a list of distribution sites will be randomly
1934: intermixed to prevent huge load on servers which holding popular
1935: packages (for example, SourceForge.net mirrors). Thus, every
1936: time when you need to fetch yet another distfile all the mirrors
1937: will be tried in new (random) order. You can turn this feature
1938: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1939: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1940: <p>You can overwrite some of the major distribution sites to
1941: fit to sites that are close to your own. By setting one or two
1942: variables you can modify the order in which the master sites are
1943: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1944: delimited list of domain suffixes.
1945: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1946: contains a whitespace delimited list of regular expressions. It
1947: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1948: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1949: some examples. This may save some of your bandwidth and
1950: time.</p>
1.75 rillig 1951: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1952: if you want to keep the settings, by editing the
1.110 hubertf 1953: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1954: and adding the definitions there.</p>
1.82 rillig 1955: <p>
1.88 wiz 1956: If a package depends on many other packages (such as
1.189 snj 1957: <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 1958: alternate between periods of
1959: downloading source, and compiling. To ensure you have all the source
1960: downloaded initially you can run the command:
1961: </p>
1.82 rillig 1962: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1963: <p>
1.88 wiz 1964: which will output and run a set of shell commands to fetch the
1965: necessary files into the <code class="filename">distfiles</code> directory. You can
1966: also choose to download the files manually.
1967: </p>
1.75 rillig 1968: </div>
1.148 asau 1969: <div class="sect2">
1.75 rillig 1970: <div class="titlepage"><div><div><h3 class="title">
1971: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1972: <p>
1.88 wiz 1973: Once the software has downloaded, any patches will be applied, then it
1974: will be compiled for you. This may take some time depending on your
1975: computer, and how many other packages the software depends on and their
1976: compile time.
1977: </p>
1.148 asau 1978: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1979: <h3 class="title">Note</h3>
1980: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1981: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1982: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1983: </div>
1.87 wiz 1984: <p>For example, type</p>
1.88 wiz 1985: <pre class="screen">
1986: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1987: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1988: </pre>
1.75 rillig 1989: <p>at the shell prompt to build the various components of the
1.88 wiz 1990: package.</p>
1.82 rillig 1991: <p>The next stage is to actually install the newly compiled
1.88 wiz 1992: program onto your system. Do this by entering:
1.82 rillig 1993:
1.88 wiz 1994: </p>
1.82 rillig 1995: <pre class="screen">
1.88 wiz 1996: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1997: </pre>
1.82 rillig 1998: <p>
1999:
1.88 wiz 2000: while you are still in the directory for whatever package you
2001: are installing.</p>
1.82 rillig 2002: <p>Installing the package on your system may require you to
1.88 wiz 2003: be root. However, pkgsrc has a
2004: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2005: to only become root for the actual installation step.</p>
1.82 rillig 2006: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2007: You can now enter:
1.82 rillig 2008:
1.88 wiz 2009: </p>
1.82 rillig 2010: <pre class="screen">
1.88 wiz 2011: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2012: </pre>
1.82 rillig 2013: <p>
2014:
1.88 wiz 2015: to remove the compiled files in the work directory, as you shouldn't need
2016: them any more. If other packages were also added to your system
2017: (dependencies) to allow your program to compile, you can tidy these up
2018: also with the command:</p>
1.82 rillig 2019: <pre class="screen">
1.88 wiz 2020: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2021: </pre>
1.75 rillig 2022: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2023: 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 2024: <p>The program is installed under the default root of the
2025: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2026: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2027: variable in your environment, and it will use that value as the
2028: root of your packages tree. So, to use
2029: <code class="filename">/usr/local</code>, set
2030: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2031: Please note that you should use a directory which is dedicated to
2032: packages and not shared with other programs (i.e., do not try and
2033: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2034: to add any of your own files or directories (such as
2035: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2036: <code class="filename">pkgsrc/</code>) below the
2037: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2038: conflicts between programs and other files installed by the
2039: package system and whatever else may have been installed
2040: there.</p>
1.110 hubertf 2041: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2042: alter some configuration options at build time. Have a look at
2043: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2044: of what will be set there by default. Environment variables such
2045: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2046: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2047: set them each time you want to use pkgsrc.</p>
1.128 wiz 2048: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2049: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 2050: or being installed. This may be for debugging purposes, or out of
2051: simple curiosity. A number of utility values have been added to
2052: help with this.</p>
1.128 wiz 2053: <div class="orderedlist"><ol class="orderedlist" type="1">
2054: <li class="listitem">
1.189 snj 2055: <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 2056: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2057: information will be displayed. For example,</p>
1.75 rillig 2058: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2059: <p>will show all the commands that are invoked, up to and
1.128 wiz 2060: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 2061: </li>
1.128 wiz 2062: <li class="listitem">
1.189 snj 2063: <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 2064: definition, then the <code class="varname">VARNAME</code> definition
2065: should be used, in conjunction with the show-var
1.189 snj 2066: 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 2067: variable <code class="varname">LOCALBASE</code>:</p>
2068: <pre class="screen">
2069: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2070: /usr/pkg
2071: <code class="prompt">%</code>
1.88 wiz 2072: </pre>
1.75 rillig 2073: </li>
2074: </ol></div>
2075: <p>If you want to install a binary package that you've either
1.88 wiz 2076: created yourself (see next section), that you put into
2077: pkgsrc/packages manually or that is located on a remote FTP
2078: server, you can use the "bin-install" target. This target will
1.189 snj 2079: 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 2080: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2081: sites searched is kept in the variable
2082: <code class="varname">BINPKG_SITES</code>, which defaults to
1.189 snj 2083: 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 2084: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2085: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2086: details.</p>
2087: <p>A final word of warning: If you set up a system that has a
2088: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2089: set that before any packages are installed, as you cannot use
2090: several directories for the same purpose. Doing so will result in
2091: pkgsrc not being able to properly detect your installed packages,
2092: and fail miserably. Note also that precompiled binary packages are
2093: usually built with the default <code class="varname">LOCALBASE</code> of
2094: <code class="filename">/usr/pkg</code>, and that you should
2095: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2096: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2097: </div>
2098: </div>
2099: </div>
1.148 asau 2100: <div class="chapter">
1.75 rillig 2101: <div class="titlepage"><div><div><h2 class="title">
2102: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2103: <div class="toc">
2104: <p><b>Table of Contents</b></p>
1.195 wiz 2105: <dl class="toc">
1.75 rillig 2106: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2107: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2108: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2109: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2110: <dd><dl>
1.103 wiz 2111: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 2112: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2113: <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 2114: </dl></dd>
1.103 wiz 2115: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2116: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2117: </dl>
2118: </div>
1.104 rillig 2119: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2120: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2121: that file depends on the installation. On NetBSD, when you use
1.189 snj 2122: <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 2123: <code class="filename">/etc/</code>. In all other cases the default location is
2124: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2125: bootstrap program to install the binary packages.</p>
2126: <p>During the bootstrap, an example configuration file is created. To
2127: use that, you have to create the directory
2128: <code class="filename">${PREFIX}/etc</code> and copy the example file
2129: there.</p>
2130: <p>The format of the configuration file is that of the usual
2131: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2132: is done by setting variables in this file. Note that you can define all
2133: kinds of variables, and no special error checking (for example for
2134: spelling mistakes) takes place, so you have to try it out to see if it
2135: works.</p>
1.148 asau 2136: <div class="sect1">
1.75 rillig 2137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2138: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2139: <p>In this section, you can find some variables that apply to all
1.89 rillig 2140: pkgsrc packages. A complete list of the variables that can be
2141: configured by the user is available in
2142: <code class="filename">mk/defaults/mk.conf</code>, together with some
2143: comments that describe each variable's intent.</p>
1.148 asau 2144: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2145: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2146: packages will be installed. The default is
1.76 rillig 2147: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2148: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 2149: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2150: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 2151: installed. The default is
1.76 rillig 2152: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2153: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2154: X11 is installed on the system. The default is
1.194 bsiegert 2155: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 2156: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2157: downloaded copies of the original source distributions used
2158: for building pkgsrc packages. The default is
1.76 rillig 2159: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2160: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2161: database about installed packages is stored. The default is
2162: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2163: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2164: If set, override the packages'
2165: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2166: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2167: Backup location(s) for distribution files and patch files
2168: if not found locally or in
1.76 rillig 2169: <code class="filename">${MASTER_SITES}</code> or
2170: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2171: The defaults are
1.132 spz 2172: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2173: and
1.76 rillig 2174: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2175: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2176: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2177: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 2178: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2179: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2180: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 2181: List of acceptable licenses. License names are case-sensitive.
2182: Whenever you try to build a package whose license is not in this
2183: list, you will get an error message. If the license condition is
2184: simple enough, the error message will include specific
2185: instructions on how to change this variable.</p></li>
1.75 rillig 2186: </ul></div>
2187: </div>
1.148 asau 2188: <div class="sect1">
1.75 rillig 2189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2190: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2191: <p>XXX
2192: </p>
1.148 asau 2193: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2194: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2195: directory for the binary packages. The default is
1.76 rillig 2196: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2197: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2198: The top level directory where, if defined, the separate
2199: working directories will get created, and symbolically
1.76 rillig 2200: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2201: This is useful for building packages on several
1.76 rillig 2202: architectures, then <code class="filename">${PKGSRCDIR}</code>
2203: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2204: is local to every architecture. (It should be noted that
2205: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 2206: — it is an internal definition which refers to the
1.75 rillig 2207: root of the pkgsrc tree. It is possible to have many
2208: pkgsrc tree instances.)</p></li>
1.128 wiz 2209: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2210: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2211: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2212: information.</p></li>
1.128 wiz 2213: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2214: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2215: BSD-style Makefile. If this is not set,
2216: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2217: <code class="filename">/dev/null</code> to avoid picking up
2218: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128 wiz 2219: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2220: By default, dependencies are only installed, and no binary
2221: package is created for them. You can set this variable to
1.174 asau 2222: <code class="literal">package-install</code> to automatically create binary
1.190 wiz 2223: packages after installing dependencies. Please note that the
1.194 bsiegert 2224: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.190 wiz 2225: <code class="literal">yes</code> to preserve binary packages when
2226: using the <code class="literal">install</code> as well.</p></li>
1.75 rillig 2227: </ul></div>
2228: </div>
1.148 asau 2229: <div class="sect1">
1.75 rillig 2230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2231: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2232: <p>Most packages support installation into a
1.103 wiz 2233: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2234: to be built, before the actual filesystem is touched. DESTDIR
2235: support exists in two variations:</p>
1.148 asau 2236: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2237: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 2238: installation and packaging is still run as root.</p></li>
2239: <li class="listitem"><p>Full DESTDIR support can run the complete
2240: build, installation and packaging as normal user. Root
2241: privileges are only needed to add packages.</p></li>
2242: </ul></div>
2243: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2244: you can set
2245: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2246: so it's preferable to convert a package to DESTDIR instead.</p>
1.103 wiz 2247: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2248: clean</code></strong> needs to be run as root.</p>
1.118 imil 2249: <p>Considering the <code class="filename">foo/bar</code> package,
2250: DESTDIR full support can be tested using the following commands
2251:
2252: </p>
2253: <pre class="programlisting">
2254: <code class="prompt">$</code> id
2255: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2256: <code class="prompt">$</code> mkdir $HOME/packages
2257: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2258: </pre>
2259: <p>
2260:
2261: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2262: should be needed
2263:
2264: </p>
2265: <pre class="programlisting">
1.174 asau 2266: <code class="prompt">$</code> make stage-install
1.118 imil 2267: </pre>
2268: <p>
2269:
2270: Create a package without root privileges
2271:
2272: </p>
2273: <pre class="programlisting">
1.174 asau 2274: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 2275: </pre>
2276: <p>
2277:
2278: For the following command, you must be able to gain root
1.189 snj 2279: 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 2280:
2281: </p>
2282: <pre class="programlisting">
1.174 asau 2283: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 2284: </pre>
2285: <p>
2286:
2287: Then, as a simple user
2288:
2289: </p>
2290: <pre class="programlisting">
2291: <code class="prompt">$</code> make clean
2292: </pre>
2293: <p>
2294:
2295: </p>
1.103 wiz 2296: </div>
1.148 asau 2297: <div class="sect1">
1.103 wiz 2298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2299: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 2300: <div class="sect2">
1.78 rillig 2301: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2302: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2303: <p>By default, pkgsrc will use GCC to build packages. This may be
2304: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 2305: <div class="variablelist"><dl class="variablelist">
1.89 rillig 2306: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2307: <dd>
2308: <p>This is a list of values specifying the chain of
2309: compilers to invoke when building packages. Valid values
2310: are:</p>
1.148 asau 2311: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 2312: <li class="listitem"><p><code class="varname">ccc</code>:
2313: Compaq C Compilers (Tru64)</p></li>
2314: <li class="listitem"><p><code class="varname">ccache</code>:
2315: compiler cache (chainable)</p></li>
2316: <li class="listitem"><p><code class="varname">clang</code>:
2317: Clang C and Objective-C compiler</p></li>
1.128 wiz 2318: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2319: distributed C/C++ (chainable)</p></li>
1.174 asau 2320: <li class="listitem"><p><code class="varname">f2c</code>:
2321: Fortran 77 to C compiler (chainable)</p></li>
2322: <li class="listitem"><p><code class="varname">icc</code>:
2323: Intel C++ Compiler (Linux)</p></li>
2324: <li class="listitem"><p><code class="varname">ido</code>:
2325: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 2326: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2327: GNU C/C++ Compiler</p></li>
1.174 asau 2328: <li class="listitem"><p><code class="varname">hp</code>:
2329: HP-UX C/aC++ compilers</p></li>
1.128 wiz 2330: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2331: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 2332: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 2333: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2334: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2335: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 2336: <li class="listitem"><p><code class="varname">xlc</code>:
2337: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89 rillig 2338: </ul></div>
2339: <p>The default is
1.128 wiz 2340: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 2341: <code class="varname">ccache</code> and/or
2342: <code class="varname">distcc</code> with an appropriate
2343: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 2344: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2345: variable should always be terminated with a value for
2346: a real compiler. Note that only one real compiler
1.128 wiz 2347: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2348: is not allowed).</p>
1.89 rillig 2349: </dd>
2350: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2351: <dd><p>This specifies the minimum version of GCC to use
2352: when building packages. If the system GCC doesn't
2353: satisfy this requirement, then pkgsrc will build and
2354: install one of the GCC packages to use instead.</p></dd>
2355: </dl></div>
2356: </div>
1.148 asau 2357: <div class="sect2">
1.89 rillig 2358: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2359: <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 2360: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2361: please make sure to use the <code class="literal">+=</code> operator
2362: instead of the <code class="literal">=</code> operator:</p>
2363: <pre class="programlisting">
1.100 rillig 2364: CFLAGS+= -your -flags
1.78 rillig 2365: </pre>
2366: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2367: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 2368: need to add their own flags. You may want to take a look
1.189 snj 2369: 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 2370: package if you're interested in optimization specifically
2371: for the current CPU. </p>
1.78 rillig 2372: </div>
1.148 asau 2373: <div class="sect2">
1.88 wiz 2374: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2375: <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 2376: <p>If you want to pass flags to the linker, both in the configure
2377: step and the build step, you can do this in two ways. Either set
2378: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2379: between the two is that <code class="varname">LIBS</code> will be appended to
2380: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2381: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2382: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2383: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2384: <code class="varname">CFLAGS</code>, if you do not wish to override these
2385: settings, use the <code class="literal">+=</code> operator:</p>
2386: <pre class="programlisting">
1.100 rillig 2387: LDFLAGS+= -your -linkerflags
1.88 wiz 2388: </pre>
2389: </div>
1.78 rillig 2390: </div>
1.148 asau 2391: <div class="sect1">
1.78 rillig 2392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2393: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 2394: <p>
1.75 rillig 2395: </p>
1.148 asau 2396: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2397: <li class="listitem">
1.75 rillig 2398: <p><code class="varname">PKG_DEVELOPER</code>:
2399: Run some sanity checks that package developers want:
2400: </p>
1.148 asau 2401: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2402: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2403: fuzz</p></li>
1.128 wiz 2404: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2405: binaries will find their shared libs.</p></li>
1.75 rillig 2406: </ul></div>
2407: <p>
1.87 wiz 2408: </p>
1.75 rillig 2409: </li>
1.128 wiz 2410: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 2411: of debugging output which is displayed whilst making and
2412: installing the package. The default value for this is 0,
2413: which will not display the commands as they are executed
2414: (normal, default, quiet operation); the value 1 will display
2415: all shell commands before their invocation, and the value 2
2416: will display both the shell commands before their invocation,
1.110 hubertf 2417: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2418: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2419: </ul></div>
2420: <p>
2421: </p>
2422: </div>
1.148 asau 2423: <div class="sect1">
1.75 rillig 2424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2425: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2426: <p>Some packages have build time options, usually to select
2427: between different dependencies, enable optional support for big
2428: dependencies or enable experimental features.</p>
1.75 rillig 2429: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2430: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2431: show-options</strong></span>, for example:</p>
1.75 rillig 2432: <pre class="programlisting">
2433: The following options are supported by this package:
2434: ssl Enable SSL support.
2435: Exactly one of the following gecko options is required:
2436: firefox Use firefox as gecko rendering engine.
2437: mozilla Use mozilla as gecko rendering engine.
2438: At most one of the following database options may be selected:
2439: mysql Enable support for MySQL database.
2440: pgsql Enable support for PostgreSQL database.
1.1 grant 2441:
1.75 rillig 2442: These options are enabled by default: firefox
2443: These options are currently enabled: mozilla ssl
1.1 grant 2444: </pre>
1.75 rillig 2445: <p>The following variables can be defined in
1.110 hubertf 2446: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2447: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2448: which can be used to select or disable options for all packages
2449: that support them, and
2450: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2451: which can be used to select or disable options specifically for
2452: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2453: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2454: are disabled. A few examples:</p>
1.75 rillig 2455: <pre class="screen">
1.110 hubertf 2456: <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 2457: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2458: PKG_OPTIONS.kdebase= debug -sasl
2459: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2460: <p>It is important to note that options that were specifically
1.120 snj 2461: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2462: you do not wish to include the option. If you are unsure you can view
2463: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2464: <p>The following settings are consulted in the order given, and
2465: the last setting that selects or disables an option is
2466: used:</p>
1.128 wiz 2467: <div class="orderedlist"><ol class="orderedlist" type="1">
2468: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2469: maintainer</p></li>
1.128 wiz 2470: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2471: variables (see below)</p></li>
1.128 wiz 2472: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2473: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2474: </ol></div>
2475: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2476: selected is used, all others are automatically disabled. If an
2477: option of the group is explicitly disabled, the previously
2478: selected option, if any, is used. It is an error if no option
2479: from a required group of options is selected, and building the
2480: package will fail.</p>
2481: <p>Before the options framework was introduced, build options
2482: were selected by setting a variable (often named
2483: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2484: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2485: transition to the options framework for the user, these legacy
2486: variables are converted to the appropriate options setting
2487: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2488: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2489: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2490: directly. Support for the legacy variables will be removed
2491: eventually.</p>
1.75 rillig 2492: </div>
2493: </div>
1.148 asau 2494: <div class="chapter">
1.75 rillig 2495: <div class="titlepage"><div><div><h2 class="title">
2496: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2497: <div class="toc">
2498: <p><b>Table of Contents</b></p>
1.195 wiz 2499: <dl class="toc">
1.75 rillig 2500: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2501: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2502: </dl>
2503: </div>
1.148 asau 2504: <div class="sect1">
1.75 rillig 2505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2506: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2507: <p>Once you have built and installed a package, you can create
2508: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.189 snj 2509: 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 2510: the same package on a group of hosts and wasting CPU time. It also
2511: provides a simple means for others to install your package, should
2512: you distribute it.</p>
2513: <p>To create a binary package, change into the appropriate
1.110 hubertf 2514: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2515: package</strong></span>:</p>
2516: <pre class="screen">
2517: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2518: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2519: </pre>
2520: <p>This will build and install your package (if not already done),
2521: and then build a binary package from what was installed. You can
1.110 hubertf 2522: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2523: it. Binary packages are created by default in
2524: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2525: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.189 snj 2526: 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 2527: <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 2528: such a binary package.</p>
1.75 rillig 2529: </div>
1.148 asau 2530: <div class="sect1">
1.75 rillig 2531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2532: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2533: <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 2534: </div>
2535: </div>
1.148 asau 2536: <div class="chapter">
1.106 rillig 2537: <div class="titlepage"><div><div><h2 class="title">
2538: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2539: builds)</h2></div></div></div>
2540: <div class="toc">
2541: <p><b>Table of Contents</b></p>
1.195 wiz 2542: <dl class="toc">
1.180 wiz 2543: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2544: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2545: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2546: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 2547: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2548: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2549: </dl>
2550: </div>
1.180 wiz 2551: <p>For a number of reasons you may want to build binary packages
2552: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2553: For instance, when you have multiple machines that should run the same software,
2554: it is wasted time if they all build their packages themselves from source.
2555: Or you may want to build a list of packages you want and check them before
2556: deploying onto production system.
2557: There is a way of getting a set of binary packages:
1.174 asau 2558: The bulk build system, or pbulk ("p" stands for "parallel).
2559: This chapter describes how to set it up so that the packages
1.106 rillig 2560: are most likely to be usable later.</p>
1.148 asau 2561: <div class="sect1">
1.106 rillig 2562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2563: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2564: <p>First of all, you have to decide whether you build all packages
2565: or a limited set of them. Full bulk builds usually consume a lot more resources,
2566: both space and time, than builds for some practical sets of packages.
2567: There exists a number of particularly heavy packages that are not actually
2568: interesting to a wide audience.
2569:
2570: For a limited bulk builds you need to make a list of packages you want to build.
2571: Note, that all their dependencies will be built, so you don't need to track them manually.
2572: </p>
2573: <p>During bulk builds various packages are installed and deinstalled
2574: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2575: so make sure that you don't need any package during the builds.
2576: Essentially, you should provide fresh system, either a chroot environment
2577: or something even more restrictive, depending on what the operating system provides,
2578: or dedicate the whole physical machine.
2579: As a useful side effect this makes sure that bulk builds cannot
2580: break anything in your system. There have been numerous cases where
1.106 rillig 2581: certain packages tried to install files outside the
2582: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2583: <code class="filename">/etc</code>.
2584: </p>
1.106 rillig 2585: </div>
1.148 asau 2586: <div class="sect1">
1.106 rillig 2587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2588: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2589: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2590: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2591: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2592: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2593: </ul></div>
1.148 asau 2594: <div class="sect2">
1.116 rillig 2595: <div class="titlepage"><div><div><h3 class="title">
1.180 wiz 2596: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.178 asau 2597: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2598: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2599: Configure network access to fetch distribution files.
2600: Create user with name "pbulk".</p>
2601: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2602: <pre class="screen">
1.181 wiz 2603: <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>
2604: <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>
2605: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178 asau 2606: </pre>
2607: <p>Or any other way that fits (e.g., curl, wget).</p>
2608: <p>Deploy and configure pbulk tools, e.g.:</p>
2609: <pre class="screen">
2610: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2611: <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>
2612: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2613: </pre>
2614: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2615: <h3 class="title">Note</h3>
2616: <p><code class="filename">mk.conf.frag</code> is a fragment of
2617: <code class="filename">mk.conf</code> that contains settings you want to
2618: apply to packages you build. For instance,</p>
2619: <pre class="programlisting">
2620: PKG_DEVELOPER= yes # perform more checks
2621: X11_TYPE= modular # use pkgsrc X11
2622: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2623: </pre>
2624: </div>
2625: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2626: with your list of packages one per line without empty lines or comments. E.g.:</p>
2627: <pre class="programlisting">
2628: www/firefox
2629: mail/thunderbird
2630: misc/libreoffice4
2631: </pre>
1.179 asau 2632: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2633: and make final amendments, if wanted.</p>
1.178 asau 2634: <p>Start it:</p>
2635: <pre class="screen">
2636: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2637: </pre>
2638: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2639: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2640: </p>
2641: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2642: <h3 class="title">Note</h3>
2643: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2644: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2645: The script is kept small enough for better understanding.</p>
2646: </div>
2647: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2648: <h3 class="title">Note</h3>
2649: <p>The <code class="filename">pbulk.sh</code> script supports running
2650: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2651: </div>
1.106 rillig 2652: </div>
2653: </div>
1.148 asau 2654: <div class="sect1">
1.106 rillig 2655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2656: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2657: <p>A complete bulk build requires lots of disk space. Some of the
2658: disk space can be read-only, some other must be writable. Some can be on
2659: remote filesystems (such as NFS) and some should be local. Some can be
2660: temporary filesystems, others must survive a sudden reboot.</p>
2661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2662: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2663: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2664: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2665: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2666: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2667: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2668: </ul></div>
2669: </div>
2670: <div class="sect1">
2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174 asau 2672: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2673: <p>After your pkgsrc bulk-build has completed, you may wish to
2674: create a CD-ROM set of the resulting binary packages to assist
2675: in installing packages on other machines. The
1.189 snj 2676: <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 2677: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2678: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2679: way that keeps all the dependencies for a given package on the same
2680: CD as that package.</p>
1.148 asau 2681: <div class="sect2">
1.75 rillig 2682: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2683: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2684: <p>Complete documentation for cdpack is found in the cdpack(1)
2685: man page. The following short example assumes that the binary
2686: packages are left in
2687: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2688: sufficient disk space exists in <code class="filename">/u2</code> to
2689: hold the ISO 9660 images.</p>
2690: <pre class="screen">
2691: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2692: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2693: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2694: </pre>
2695: <p>If you wish to include a common set of files
2696: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2697: etc.) on each CD in the collection, then you need to create a
2698: directory which contains these files. e.g.</p>
2699: <pre class="screen">
2700: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2701: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2702: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2703: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2704: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2705: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2706: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2707: </pre>
1.75 rillig 2708: <p>Now create the images:</p>
2709: <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 2710: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2711: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2712: in their root directories.</p>
1.75 rillig 2713: </div>
2714: </div>
2715: </div>
1.148 asau 2716: <div class="chapter">
1.75 rillig 2717: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2718: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2719: <div class="toc">
2720: <p><b>Table of Contents</b></p>
1.195 wiz 2721: <dl class="toc">
1.128 wiz 2722: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2723: <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 2724: </dl>
2725: </div>
2726: <p>The files that are installed by pkgsrc are organized in a way that
2727: is similar to what you find in the <code class="filename">/usr</code> directory
2728: of the base system. But some details are different. This is because
2729: pkgsrc initially came from FreeBSD and had adopted its file system
2730: hierarchy. Later it was largely influenced by NetBSD. But no matter
2731: which operating system you are using pkgsrc with, you can expect the
2732: same layout for pkgsrc.</p>
1.91 rillig 2733: <p>There are mainly four root directories for pkgsrc, which are all
2734: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2735: When pkgsrc has been installed as root, the default locations
2736: are:</p>
2737: <pre class="programlisting">
1.100 rillig 2738: LOCALBASE= /usr/pkg
2739: PKG_SYSCONFBASE= /usr/pkg/etc
2740: VARBASE= /var
2741: PKG_DBDIR= /var/db/pkg
1.91 rillig 2742: </pre>
2743: <p>In unprivileged mode (when pkgsrc has been installed as any other
2744: user), the default locations are:</p>
2745: <pre class="programlisting">
1.100 rillig 2746: LOCALBASE= ${HOME}/pkg
2747: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2748: VARBASE= ${HOME}/pkg/var
2749: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 2750: </pre>
2751: <p>What these four directories are for, and what they look like is
2752: explained below.</p>
1.148 asau 2753: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2754: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2755: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2756: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2757: the well-known subdirectories like <code class="filename">bin</code>,
2758: <code class="filename">include</code>, <code class="filename">lib</code>,
2759: <code class="filename">share</code> and
2760: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2761: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2762: <code class="filename">/var</code> in the base system. Some programs (especially
2763: games, network daemons) need write access to it during normal
2764: operation.</p></li>
1.128 wiz 2765: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2766: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2767: 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 2768: itself.</p></li>
2769: </ul></div>
1.148 asau 2770: <div class="sect1">
1.90 rillig 2771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2772: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2773: </h2></div></div></div>
1.90 rillig 2774: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2775: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2776: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2777: <dt><span class="term"><code class="filename">bin</code></span></dt>
2778: <dd><p>Contains executable programs that are intended to be
2779: directly used by the end user.</p></dd>
2780: <dt><span class="term"><code class="filename">emul</code></span></dt>
2781: <dd><p>Contains files for the emulation layers of various other
2782: operating systems, especially for
2783: NetBSD.</p></dd>
2784: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2785: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2786: <dd><p>Contains
2787: the configuration files.</p></dd>
2788: <dt><span class="term"><code class="filename">include</code></span></dt>
2789: <dd><p>Contains headers for the C and C++ programming
2790: languages.</p></dd>
2791: <dt><span class="term"><code class="filename">info</code></span></dt>
2792: <dd><p>Contains GNU info files of various
2793: packages.</p></dd>
2794: <dt><span class="term"><code class="filename">lib</code></span></dt>
2795: <dd><p>Contains shared and static
2796: libraries.</p></dd>
2797: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2798: <dd><p>Contains data files that don't change after
2799: installation. Other data files belong into
2800: <code class="filename">${VARBASE}</code>.</p></dd>
2801: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2802: <dd><p>Contains programs that are not intended to be used by
2803: end users, such as helper programs or network
2804: daemons.</p></dd>
2805: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2806: <dd><p>Contains programs that are intended to be executed as
2807: CGI scripts by a web server.</p></dd>
2808: <dt><span class="term"><code class="filename">man</code> (the usual value of
2809: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2810: <dd><p>Contains brief
2811: documentation in form of manual pages.</p></dd>
2812: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2813: <dd><p>Contains programs that are intended to be used only by
2814: the super-user.</p></dd>
2815: <dt><span class="term"><code class="filename">share</code></span></dt>
2816: <dd><p>Contains platform-independent data files that don't
2817: change after installation.</p></dd>
2818: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2819: <dd><p>Contains documentation files provided by the
2820: packages.</p></dd>
2821: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2822: <dd><p>Contains example files provided by the packages. Among
2823: others, the original configuration files are saved here and copied to
2824: <code class="filename">${PKG_SYSCONFDIR}</code> during
2825: installation.</p></dd>
2826: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2827: <dd><p>Contains the original files for rc.d
2828: scripts.</p></dd>
2829: <dt><span class="term"><code class="filename">var</code> (the usual location of
2830: <code class="filename">${VARBASE}</code>)</span></dt>
2831: <dd><p>Contains files
2832: that may be modified after
2833: installation.</p></dd>
2834: </dl></div>
2835: </div>
1.148 asau 2836: <div class="sect1">
1.90 rillig 2837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2838: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2839: </h2></div></div></div>
1.148 asau 2840: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2841: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2842: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2843: <dd><p>Contains
2844: information about the currently installed
2845: packages.</p></dd>
2846: <dt><span class="term"><code class="filename">games</code></span></dt>
2847: <dd><p>Contains highscore
2848: files.</p></dd>
2849: <dt><span class="term"><code class="filename">log</code></span></dt>
2850: <dd><p>Contains log files.</p></dd>
2851: <dt><span class="term"><code class="filename">run</code></span></dt>
2852: <dd><p>Contains informational files about daemons that are
2853: currently running.</p></dd>
2854: </dl></div>
2855: </div>
2856: </div>
1.148 asau 2857: <div class="chapter">
1.90 rillig 2858: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2859: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2860: <div class="toc">
2861: <p><b>Table of Contents</b></p>
1.195 wiz 2862: <dl class="toc">
1.106 rillig 2863: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194 bsiegert 2864: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2865: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2866: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2867: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2868: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2869: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2870: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2871: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2872: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 2873: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.194 bsiegert 2874: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
2875: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2876: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2877: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2878: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2879: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2880: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 2881: </dl>
2882: </div>
2883: <p>This section contains hints, tips & tricks on special things in
2884: pkgsrc that we didn't find a better place for in the previous chapters, and
2885: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2886: <div class="sect1">
1.75 rillig 2887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2888: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2889: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2890: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2891: <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 2892: This is a general purpose list for most issues regarding
2893: pkgsrc, regardless of platform, e.g. soliciting user help
2894: for pkgsrc configuration, unexpected build failures, using
2895: particular packages, upgrading pkgsrc installations,
2896: questions regarding the pkgsrc release branches, etc. General announcements or
2897: proposals for changes that impact the pkgsrc user community,
2898: e.g. major infrastructure changes, new features, package
2899: removals, etc., may also be posted.</p></li>
1.128 wiz 2900: <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 2901: A list where the results of pkgsrc bulk builds are sent and
2902: discussed.</p></li>
1.128 wiz 2903: <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 2904: This list is for those who are interested in getting a
2905: commit message for every change committed to pkgsrc. It is
2906: also available in digest form, meaning one daily message
2907: containing all commit messages for changes to the package
2908: source tree in that 24 hour period.</p></li>
2909: </ul></div>
2910: <p>To subscribe, do:</p>
2911: <pre class="programlisting">
1.100 rillig 2912: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2913: </pre>
2914: <p>Archives for all these mailing lists are available from
1.110 hubertf 2915: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2916: </div>
1.148 asau 2917: <div class="sect1">
1.75 rillig 2918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2919: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2920: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2921: a number of useful utilities for both users and developers of pkgsrc. This
2922: section attempts only to make the reader aware of the utilities and when
2923: they might be useful, and not to duplicate the documentation that comes
2924: with each package.</p>
2925: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.189 snj 2926: <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 2927: Symlinks for use by buildlink.</p></li></ul></div>
2928: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2929: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2930: <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 2931: Calculates various kinds of checksums (including SHA1).</p></li>
1.189 snj 2932: <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 2933: Compatibility library for pkgsrc tools.</p></li>
1.189 snj 2934: <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 2935: non-BSD systems due to lack of native mtree.</p></li>
1.189 snj 2936: <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 2937: Up-to-date replacement for
1.76 rillig 2938: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2939: systems where pkg_install is not present.</p></li>
2940: </ul></div>
2941: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2942: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2943: <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 2944: Create a binary package from an
1.110 hubertf 2945: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2946: save the old package.</p></li>
1.189 snj 2947: <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 2948: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2949: from multiple locations. It currently supports the following
2950: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.189 snj 2951: <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 2952: the best compiler flags to optimise code for your current
1.128 wiz 2953: CPU and compiler. </p></li>
1.75 rillig 2954: </ul></div>
2955: <p>Utilities for keeping track of installed packages, being up to date,
2956: etc:</p>
1.148 asau 2957: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2958: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173 wiz 2959: update tool similar to apt(1). Download, install, and upgrade
2960: binary packages easily.</p></li>
1.189 snj 2961: <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 2962: packages whose installed versions do not match the latest pkgsrc
2963: entries.</p></li>
1.189 snj 2964: <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 2965: dependency graphs of packages, to aid in choosing a strategy for
2966: updating.</p></li>
1.189 snj 2967: <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
2968: 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>
2969: <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 2970: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.189 snj 2971: <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 2972: does various checks on the complete pkgsrc system.</p></li>
1.189 snj 2973: <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 2974: packages you have installed.</p></li>
2975: </ul></div>
2976: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2977: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2978: <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 2979: making and maintaining patches for a package (includes pkgdiff,
2980: pkgvi, mkpatches, etc.).</p></li>
1.189 snj 2981: <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 2982: converting to pkgsrc.</p></li>
2983: </ul></div>
2984: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2985: utilities)</p>
1.148 asau 2986: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 2987: <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 2988: packages in a chrooted area.</p></li>
1.189 snj 2989: <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 2990: kernel version for chrooted cross builds.</p></li>
2991: </ul></div>
2992: </div>
1.148 asau 2993: <div class="sect1">
1.75 rillig 2994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 2995: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 2996: <p>If you want to use pkgsrc as non-root user, you can set some
2997: variables to make pkgsrc work under these conditions. At the very least,
1.128 wiz 2998: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 2999: will turn on unprivileged mode and set multiple related variables to allow
3000: installation of packages as non-root.</p>
3001: <p>In case the defaults are not enough, you may want to tune some other
3002: variables used. For example, if the automatic user/group detection leads
3003: to incorrect values (or not the ones you would like to use), you can change
3004: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3005: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3006: <p>As regards bootstrapping, please note that the
1.110 hubertf 3007: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3008: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3009: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3010: installation targets. These directories can be overridden by the
1.128 wiz 3011: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3012: that allow finer tuning of the tree layout.</p>
3013: </div>
1.148 asau 3014: <div class="sect1">
1.75 rillig 3015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3016: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3017: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3018: enable this feature by adding the option
3019: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3020: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3021: distfile is found, pkgsrc will try to resume it.</p>
3022: <p>You can also
1.168 wiz 3023: use a different program than the platform default program by changing the
1.117 jnemeth 3024: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3025: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3026: by using the value manual. A value of custom disables the system defaults
3027: and dependency tracking for the fetch program. In that case you have to
3028: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3029: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3030: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 3031: <p>For example, if you want to use
1.117 jnemeth 3032: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3033: like:</p>
3034: <pre class="programlisting">
1.117 jnemeth 3035: FETCH_USING= wget
1.1 grant 3036: </pre>
1.75 rillig 3037: </div>
1.148 asau 3038: <div class="sect1">
1.75 rillig 3039: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3040: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 3041: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3042: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3043: you will have to add the following line into
1.110 hubertf 3044: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3045: <pre class="programlisting">
1.103 wiz 3046: X11_TYPE=modular
1.1 grant 3047: </pre>
1.148 asau 3048: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3049: <h3 class="title">Note</h3>
1.103 wiz 3050: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3051: </p>
1.75 rillig 3052: </div>
3053: </div>
1.148 asau 3054: <div class="sect1">
1.75 rillig 3055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3056: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3057: <p>If you are sitting behind a firewall which does not allow direct
3058: connections to Internet hosts (i.e. non-NAT), you may specify the
3059: relevant proxy hosts. This is done using an environment variable in the
3060: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 3061: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3062: port 80 as the proxy port number. So the proxy environment variables
3063: are:</p>
3064: <pre class="programlisting">
1.100 rillig 3065: ftp_proxy=ftp://orpheus.amdahl.com:80/
3066: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3067: </pre>
1.75 rillig 3068: </div>
1.148 asau 3069: <div class="sect1">
1.75 rillig 3070: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3071: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 3072: <p>Some fetch tools are not prepared to support HTTPS by default
3073: (for example, the one in NetBSD 6.0), or the one installed by the
3074: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3075: dependency graph).</p>
3076: <p>Usually you won't notice, because distribution files are
3077: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3078: be often enough if you are following pkgsrc-current. In that case, set
3079: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3080: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3081: with HTTPS support by default. Of course, these tools need to be
3082: installed before you can use them this way.</p>
3083: </div>
3084: <div class="sect1">
3085: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3086: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3087: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3088: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3089: the first available command from the following list:</p>
1.148 asau 3090: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3091: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3092: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3093: </ul></div>
3094: <p>On a default NetBSD installation, this will be
1.76 rillig 3095: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3096: connections first, and falls back to active connections if the server
3097: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3098: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3099: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3100: <p>Having that option present will prevent
1.76 rillig 3101: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3102: transfers.</p>
3103: </div>
1.148 asau 3104: <div class="sect1">
1.75 rillig 3105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3106: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3107: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3108: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 3109: 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 3110: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3111: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3112: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3113: resulting list to your machine at work/school and use it there. If you
1.189 snj 3114: 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 3115: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3116: URL:</p>
3117: <p>At home:</p>
3118: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3119: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3120: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3121: <p>At work:</p>
3122: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3123: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3124: home.</p>
3125: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3126: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3127: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3128: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3129: directly by running:</p>
1.75 rillig 3130: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3131: <p>If you even decide to ignore
3132: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3133: by running:</p>
3134: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3135: </div>
1.148 asau 3136: <div class="sect1">
1.75 rillig 3137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3138: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 3139: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.189 snj 3140: <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 3141: package, you get the error from make that it doesn't know how to make
1.76 rillig 3142: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3143: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3144: the NetBSD base distribution on your machine. It is recommended to do
3145: that to format man pages.</p>
1.189 snj 3146: <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 3147: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3148: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 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.194 bsiegert 3152: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.87 wiz 3153: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3154: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3155: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3156: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3157: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3158: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3159: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3160: -r</strong></span>).</p>
3161: </div>
1.148 asau 3162: <div class="sect1">
1.75 rillig 3163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3164: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3165: <p>When installing packages as non-root user and using the just-in-time
1.189 snj 3166: <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 3167: password for each required package installed. To avoid this, the sudo
3168: package can be used, which does password caching over a limited time. To
3169: use it, install sudo (either as binary package or from
1.189 snj 3170: <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 3171: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3172: <span class="emphasis"><em>after</em></span> the definition of the
3173: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3174: <pre class="programlisting">
1.100 rillig 3175: .if exists(${LOCALBASE}/bin/sudo)
3176: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3177: .endif
1.1 grant 3178: </pre>
1.75 rillig 3179: </div>
1.148 asau 3180: <div class="sect1">
1.75 rillig 3181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3182: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3183: <p>As the system administrator, you can choose where configuration files
3184: are installed. The default settings make all these files go into
1.76 rillig 3185: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3186: be suboptimal depending on your expectations (e.g., a read-only,
3187: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3188: configuration of the provided packages).</p>
3189: <p>In order to change the defaults, you can modify the
3190: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3191: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3192: directory; some common examples include <code class="filename">/etc</code> or
3193: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3194: <p>Furthermore, you can change this value on a per-package basis by
3195: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3196: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3197: package you would like to modify, that is, the contents of
3198: <code class="varname">PKGBASE</code>.</p>
3199: <p>Note that after changing these settings, you must rebuild and
3200: reinstall any affected packages.</p>
3201: </div>
1.148 asau 3202: <div class="sect1">
1.75 rillig 3203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3204: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3205: <p>Please be aware that there can often be bugs in third-party software,
3206: and some of these bugs can leave a machine vulnerable to exploitation by
3207: attackers. In an effort to lessen the exposure, the NetBSD packages team
3208: maintains a database of known-exploits to packages which have at one time
3209: been included in pkgsrc. The database can be downloaded automatically, and
3210: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3211: do this, refer to the following two tools (installed as part of the
1.189 snj 3212: <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 3213: <div class="orderedlist"><ol class="orderedlist" type="1">
3214: <li class="listitem">
1.122 reed 3215: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3216: download a list of the security vulnerabilities information. This list
1.132 spz 3217: is kept up to date by the pkgsrc security team, and is distributed
3218: from the NetBSD ftp server:</p>
3219: <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 3220: </li>
1.128 wiz 3221: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3222: current machine, checking each known vulnerability. If a
1.75 rillig 3223: vulnerable package is installed, it will be shown by output to stdout,
3224: including a description of the type of vulnerability, and a URL
3225: containing more information.</p></li>
3226: </ol></div>
1.114 jmcneill 3227: <p>Use of these tools is strongly recommended! After
1.128 wiz 3228: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3229: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3230: pkg_install</code></strong>.</p>
1.87 wiz 3231: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3232: 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 3233: check.</p>
1.75 rillig 3234: </div>
1.148 asau 3235: <div class="sect1">
1.75 rillig 3236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3237: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3238: <p>When you add your own preferences to the
3239: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3240: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3241: environment variables to the <code class="filename">./configure</code>
1.189 snj 3242: 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 3243: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3244: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3245: package.</p>
3246: <p>Currently there is no solution to this problem. If you
3247: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3248: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3249: directory and then inspect any <code class="filename">Makefile</code> and
3250: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3251: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3252: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3253: programmers write so bad code that it only works for the
3254: specific combination of <code class="varname">CFLAGS</code> they have
3255: chosen.</p>
3256: </div>
1.148 asau 3257: <div class="sect1">
1.80 rillig 3258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3259: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3260: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3261: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3262: case that occurs often is that people only update pkgsrc in
3263: parts, because of performance reasons. Since pkgsrc is one large
3264: system, not a collection of many small systems, there are
3265: sometimes changes that only work when the whole pkgsrc tree is
3266: updated.</p></li>
1.148 asau 3267: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3268: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3269: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3270: files.</p></li>
1.148 asau 3271: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3272: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3273: verify this.</p></li>
1.148 asau 3274: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3275: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3276: </ol></div>
3277: </div>
1.148 asau 3278: <div class="sect1">
1.88 wiz 3279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194 bsiegert 3280: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.89 rillig 3281: <p>You have modified a file from pkgsrc, and someone else has
3282: modified that same file afterwards in the CVS repository. Both changes
3283: are in the same region of the file, so when you updated pkgsrc, the
3284: <code class="literal">cvs</code> command marked the conflicting changes in the
3285: file. Because of these markers, the file is no longer a valid
3286: <code class="filename">Makefile</code>.</p>
3287: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3288: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3289: -dP</strong></span> in that directory to download the current version.</p>
3290: </div>
1.75 rillig 3291: </div>
3292: </div>
1.148 asau 3293: <div class="part">
1.75 rillig 3294: <div class="titlepage"><div><div><h1 class="title">
3295: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3296: <div class="partintro">
1.77 rillig 3297: <div></div>
3298: <p>This part of the book deals with creating and
1.128 wiz 3299: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3300: guide on creating a new package. The remaining chapters are more
3301: like a reference manual for pkgsrc.</p>
1.75 rillig 3302: <div class="toc">
3303: <p><b>Table of Contents</b></p>
1.195 wiz 3304: <dl class="toc">
1.106 rillig 3305: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3306: <dd><dl>
1.106 rillig 3307: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3308: <dd><dl>
1.106 rillig 3309: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3310: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3311: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3312: </dl></dd>
1.106 rillig 3313: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3314: <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>
3315: </dl></dd>
3316: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3317: <dd><dl>
1.128 wiz 3318: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3319: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3320: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3321: <dd><dl>
3322: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3323: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3324: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3325: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3326: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3327: </dl></dd>
3328: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3329: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3330: <dd><dl>
3331: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3332: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3333: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3334: </dl></dd>
1.128 wiz 3335: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3336: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3337: </dl></dd>
1.128 wiz 3338: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3339: <dd><dl>
3340: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3341: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 3342: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3343: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3344: <dd><dl>
3345: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3346: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3347: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3348: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3349: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3350: </dl></dd>
3351: </dl></dd>
3352: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3353: <dd><dl>
3354: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 3355: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3356: <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 3357: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3358: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 3359: <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 3360: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 3361: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
3362: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106 rillig 3363: </dl></dd>
3364: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3365: <dd><dl>
3366: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 3367: <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 3368: <dd><dl>
3369: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 3370: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3371: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3372: and
3373: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3374: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3375: </dl></dd>
1.128 wiz 3376: <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 3377: <dd><dl>
1.128 wiz 3378: <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 3379: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3380: </dl></dd>
3381: </dl></dd>
3382: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3383: <dd><dl>
3384: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3385: <dd><dl>
3386: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3387: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3388: </dl></dd>
3389: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3390: <dd><dl>
1.128 wiz 3391: <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 3392: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3393: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3394: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3395: </dl></dd>
3396: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3397: <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>
3398: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3399: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3400: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3401: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3402: <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>
3403: </dl></dd>
3404: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3405: <dd><dl>
3406: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 3407: <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 3408: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3409: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3410: </dl></dd>
3411: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3412: <dd><dl>
3413: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3414: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3415: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3416: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 3417: <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 3418: <dd><dl>
3419: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3420: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3421: </dl></dd>
1.128 wiz 3422: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3423: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3424: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3425: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3426: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3427: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3428: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3429: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3430: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3431: <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 3432: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3433: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3434: </dl></dd>
3435: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3436: <dd><dl>
3437: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3438: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3439: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3440: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3441: </dl></dd>
3442: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3443: <dd><dl>
3444: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3445: <dd><dl>
3446: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 3447: <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 3448: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3449: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3450: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3451: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3452: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3453: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3454: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3455: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3456: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3457: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3458: </dl></dd>
1.128 wiz 3459: <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 3460: <dd><dl>
3461: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3462: <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>
1.199 tnn 3463: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106 rillig 3464: </dl></dd>
1.128 wiz 3465: <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 3466: <dd><dl>
3467: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3468: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3469: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3470: </dl></dd>
3471: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3472: <dd><dl>
3473: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3474: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3475: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 3476: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3477: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 3478: </dl></dd>
1.128 wiz 3479: <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 3480: <dd><dl>
3481: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3482: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 3483: <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 3484: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3485: </dl></dd>
1.128 wiz 3486: <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 3487: <dd><dl>
3488: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3489: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3490: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3491: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3492: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3493: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3494: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3495: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3496: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3497: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 3498: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3499: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3500: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3501: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3502: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3503: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3504: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3505: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3506: emulation</a></span></dt>
1.106 rillig 3507: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3508: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3509: </dl></dd>
1.106 rillig 3510: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3511: </dl></dd>
1.106 rillig 3512: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3513: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3514: <dd><dl>
1.106 rillig 3515: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3516: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3517: <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 3518: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3519: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 3520: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3521: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106 rillig 3522: </dl></dd>
3523: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3524: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3525: <dd><dl>
3526: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3527: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3528: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3529: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3530: </dl></dd>
1.75 rillig 3531: </dl>
3532: </div>
1.77 rillig 3533: </div>
1.148 asau 3534: <div class="chapter">
1.77 rillig 3535: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3536: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3537: <div class="toc">
3538: <p><b>Table of Contents</b></p>
1.195 wiz 3539: <dl class="toc">
1.106 rillig 3540: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3541: <dd><dl>
1.106 rillig 3542: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3543: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3544: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3545: </dl></dd>
1.106 rillig 3546: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3547: <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 3548: </dl>
3549: </div>
1.77 rillig 3550: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3551: most likely have a URL from where you can download the source
3552: code. Starting with this URL, creating a package involves only a
3553: few steps.</p>
1.128 wiz 3554: <div class="procedure"><ol class="procedure" type="1">
1.189 snj 3555: <li class="step"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148 asau 3556: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 3557: category in which you want to place your package. You can also create a
3558: directory of your own (maybe called <code class="filename">local</code>). In that
3559: category directory, create another directory for your package and change
3560: into it.</p></li>
1.148 asau 3561: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3562: you for a URL. Enter the URL of the distribution file (in most cases a
3563: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3564: of your package are created automatically. The distribution file is
3565: extracted automatically to fill in some details in the
3566: <code class="filename">Makefile</code> that would otherwise have to be done
3567: manually.</p></li>
1.148 asau 3568: <li class="step">
1.91 rillig 3569: <p>Examine the extracted files to determine the dependencies of
3570: your package. Ideally, this is mentioned in some
3571: <code class="filename">README</code> file, but things may differ. For each of
3572: these dependencies, look where it exists in pkgsrc, and if there is a
3573: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3574: line to your package <code class="filename">Makefile</code> which includes that
3575: file just before the last line. If the
1.132 spz 3576: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3577: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3578: <p>If you just need binaries from a package, add a
1.91 rillig 3579: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3580: version of the dependency and where it can be found in pkgsrc. This line
3581: should be placed in the third paragraph. If the dependency is only
3582: needed for building the package, but not when using it, use
3583: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3584: Your package may then look like this:</p>
1.77 rillig 3585: <pre class="programlisting">
1.100 rillig 3586: [...]
1.77 rillig 3587:
1.174 asau 3588: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3589: DEPENDS+= screen-[0-9]*:../../misc/screen
3590: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3591:
1.100 rillig 3592: [...]
1.77 rillig 3593:
1.100 rillig 3594: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3595: .include "../../devel/glib2/buildlink3.mk"
3596: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3597: </pre>
3598: </li>
1.148 asau 3599: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3600: 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 3601: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3602: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3603: -e</strong></span>, which outputs additional
3604: explanations.</p></li>
1.148 asau 3605: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3606: 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 3607: over there, you can hopefully continue here.</p></li>
1.148 asau 3608: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3609: directory from the extracted files. Besides these files, a lot of cache
3610: files and other system information has been saved in the working
3611: directory, which may become wrong after you edited the
3612: <code class="filename">Makefile</code>.</p></li>
1.148 asau 3613: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 hubertf 3614: 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 3615: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3616: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3617: everything works.</p></li>
1.148 asau 3618: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3619: contains a list of the files that are installed by the package, is
1.110 hubertf 3620: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3621: >PLIST</strong></span> to generate a probably correct list. Check
3622: the file using your preferred text editor to see if the list of
3623: files looks plausible.</p></li>
1.148 asau 3624: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3625: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3626: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3627: has been registered in the database of installed files, but with an
1.110 hubertf 3628: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3629: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3630: registered with the list of files from
3631: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3632: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3633: package from the set of installed files.</p></li>
1.77 rillig 3634: </ol></div>
1.148 asau 3635: <div class="sect1">
1.91 rillig 3636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3637: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3638: <div class="sect2">
1.91 rillig 3639: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3640: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3641: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3642: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3643: </div>
1.148 asau 3644: <div class="sect2">
1.91 rillig 3645: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 3646: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3647: <p>KDE3 applications should always include
1.91 rillig 3648: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174 asau 3649: settings that are typical of KDE3 packages.</p>
1.91 rillig 3650: </div>
1.148 asau 3651: <div class="sect2">
1.118 imil 3652: <div class="titlepage"><div><div><h3 class="title">
3653: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3654: <p>Python modules and programs packages are easily created using a
3655: set of predefined variables.</p>
3656: <p>
1.171 wiz 3657: If some Python versions are not supported by the software, set the
3658: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3659: that are not supported, e.g.
1.118 imil 3660: </p>
3661: <pre class="programlisting">
1.172 wiz 3662: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.118 imil 3663: </pre>
3664: <p>
3665: If the packaged software is a Python module, include
1.128 wiz 3666: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3667: In this case, the package directory should be called
1.128 wiz 3668: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3669: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3670: </p>
3671: <pre class="programlisting">
3672: DISTNAME= foopymodule-1.2.10
3673: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3674: </pre>
1.171 wiz 3675: <p>If it is an application, include
3676: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3677: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3678: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3679: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3680: For example:
1.118 imil 3681: </p>
3682: <pre class="programlisting">
1.142 wiz 3683: REPLACE_PYTHON= *.py
1.118 imil 3684: </pre>
1.171 wiz 3685: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3686: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3687: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3688: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3689: so pkgsrc will use this framework.
3690: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3691: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3692: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3693: to the name of the script.</p>
3694: <p>Otherwise, if the packaged software is egg-aware, you only need
3695: to include
3696: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3697: <p>Some Python modules have separate distributions for Python-2.x
3698: and Python-3.x support. In pkgsrc this is handled by the
3699: <code class="filename">versioned_dependencies.mk</code> file. Set
3700: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3701: packages that should be depended upon and include
3702: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3703: then the pkgsrc infrastructure will depend on the appropriate package
3704: version. For example:
3705: </p>
3706: <pre class="programlisting">
3707: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3708: </pre>
3709: <p>
3710: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3711: of supported packages.</p>
1.118 imil 3712: </div>
1.91 rillig 3713: </div>
1.148 asau 3714: <div class="sect1">
1.91 rillig 3715: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3716: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3717: <div class="sect2">
1.91 rillig 3718: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3719: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3720: <div class="sect3">
1.91 rillig 3721: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3722: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3723: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3724: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3725: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3726: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3727: <pre class="programlisting">
1.100 rillig 3728: <code class="prompt">$</code> mkdir www/nvu
3729: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3730: </pre>
3731: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3732: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3733: <pre class="programlisting">
1.100 rillig 3734: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3735: </pre>
3736: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3737: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3738: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3739: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3740: <code class="varname">COMMENT</code> fields. Then the package
3741: <code class="filename">Makefile</code> looked like that:</p>
3742: <pre class="programlisting">
1.100 rillig 3743: # $NetBSD$
3744: #
1.91 rillig 3745:
1.100 rillig 3746: DISTNAME= nvu-1.0-sources
3747: PKGNAME= nvu-1.0
3748: CATEGORIES= www
3749: MASTER_SITES= http://cvs.nvu.com/download/
3750: EXTRACT_SUFX= .tar.bz2
3751:
3752: MAINTAINER= rillig@NetBSD.org
3753: HOMEPAGE= http://cvs.nvu.com/
3754: COMMENT= Web Authoring System
1.91 rillig 3755:
1.100 rillig 3756: # url2pkg-marker (please do not remove this line.)
3757: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3758: </pre>
3759: <p>Then, I quit the editor and watched pkgsrc downloading a large
3760: source archive:</p>
3761: <pre class="programlisting">
1.100 rillig 3762: url2pkg> Running "make makesum" ...
3763: => Required installed package digest>=20010302: digest-20060826 found
3764: => Fetching nvu-1.0-sources.tar.bz2
3765: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3766: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3767: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3768: url2pkg> Running "make extract" ...
3769: => Required installed package digest>=20010302: digest-20060826 found
3770: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3771: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3772: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3773: ===> Installing dependencies for nvu-1.0
3774: ===> Overriding tools for nvu-1.0
3775: ===> Extracting for nvu-1.0
3776: url2pkg> Adjusting the Makefile.
1.91 rillig 3777:
1.100 rillig 3778: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3779:
1.100 rillig 3780: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3781: </pre>
3782: </div>
1.148 asau 3783: <div class="sect3">
1.91 rillig 3784: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3785: <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 3786: <p>Now that the package has been extracted, let's see what's inside
3787: it. The package has a <code class="filename">README.txt</code>, but that only
3788: says something about mozilla, so it's probably useless for seeing what
3789: dependencies this package has. But since there is a GNU configure script
3790: in the package, let's hope that it will complain about everything it
3791: needs.</p>
3792: <pre class="programlisting">
1.100 rillig 3793: <code class="prompt">$</code> bmake
3794: => Required installed package digest>=20010302: digest-20060826 found
3795: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3796: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3797: ===> Patching for nvu-1.0
3798: ===> Creating toolchain wrappers for nvu-1.0
3799: ===> Configuring for nvu-1.0
3800: [...]
3801: configure: error: Perl 5.004 or higher is required.
3802: [...]
3803: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3804: [...]
1.91 rillig 3805: </pre>
3806: <p>That worked quite well. So I opened the package Makefile in my
3807: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3808: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3809: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3810: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3811: from scratch.</p>
3812: <pre class="programlisting">
1.100 rillig 3813: <code class="prompt">$</code> bmake clean
3814: ===> Cleaning for nvu-1.0
3815: <code class="prompt">$</code> bmake
3816: [...]
3817: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3818: GNU Make. You will not be able to build Mozilla without GNU Make.
3819: [...]
1.91 rillig 3820: </pre>
1.128 wiz 3821: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3822: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3823: <pre class="programlisting">
1.100 rillig 3824: [...]
3825: checking for GTK - version >= 1.2.0... no
3826: *** Could not run GTK test program, checking why...
3827: [...]
1.91 rillig 3828: </pre>
3829: <p>Now to the other dependencies. The first question is: Where is the
3830: GTK package hidden in pkgsrc?</p>
3831: <pre class="programlisting">
1.100 rillig 3832: <code class="prompt">$</code> echo ../../*/gtk*
3833: [many packages ...]
3834: <code class="prompt">$</code> echo ../../*/gtk
3835: ../../x11/gtk
3836: <code class="prompt">$</code> echo ../../*/gtk2
3837: ../../x11/gtk2
3838: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3839: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3840: </pre>
3841: <p>The first try was definitely too broad. The second one had exactly
3842: one result, which is very good. But there is one pitfall with GNOME
3843: packages. Before GNOME 2 had been released, there were already many
3844: GNOME 1 packages in pkgsrc. To be able to continue to use these
3845: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3846: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3847: whether this was the case here, and indeed it was.</p>
3848: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3849: file, adding the dependency is very easy. I just inserted an
3850: <code class="literal">.include</code> line before the last line of the package
3851: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3852: <pre class="programlisting">
1.100 rillig 3853: [...]
3854: .include "../../x11/gtk2/buildlink3.mk"
3855: .include "../../mk/bsd.pkg.mk
1.91 rillig 3856: </pre>
1.110 hubertf 3857: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3858: was:</p>
3859: <pre class="programlisting">
1.100 rillig 3860: [...]
3861: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3862: checking for GTK - version >= 1.2.0... no
3863: *** Could not run GTK test program, checking why...
3864: *** The test program failed to compile or link. See the file config.log for the
3865: *** exact error that occured. This usually means GTK was incorrectly installed
3866: *** or that you have moved GTK since it was installed. In the latter case, you
3867: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3868: configure: error: Test for GTK failed.
3869: [...]
1.91 rillig 3870: </pre>
1.128 wiz 3871: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3872: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3873: told me that this package really wanted to have the GNOME 1 version of
3874: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3875: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3876: So I changed the <code class="literal">x11/gtk2</code> to
3877: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3878: and tried again.</p>
3879: <pre class="programlisting">
1.100 rillig 3880: [...]
1.166 jnemeth 3881: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3882: In file included from xpidl.c:42:
3883: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3884: In file included from xpidl.c:42:
3885: xpidl.h:132: error: parse error before "IDL_ns"
3886: [...]
1.91 rillig 3887: </pre>
3888: <p>The package still does not find all of its dependencies. Now the
3889: question is: Which package provides the
3890: <code class="filename">libIDL/IDL.h</code> header file?</p>
3891: <pre class="programlisting">
1.100 rillig 3892: <code class="prompt">$</code> echo ../../*/*idl*
3893: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3894: <code class="prompt">$</code> echo ../../*/*IDL*
3895: ../../net/libIDL
1.91 rillig 3896: </pre>
3897: <p>Let's take the one from the second try. So I included the
3898: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3899: again. But the error didn't change. After digging through some of the
3900: code, I concluded that the build process of the package was broken and
3901: couldn't have ever worked, but since the Mozilla source tree is quite
3902: large, I didn't want to fix it. So I added the following to the package
3903: <code class="filename">Makefile</code> and tried again:</p>
3904: <pre class="programlisting">
1.100 rillig 3905: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3906: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 3907: </pre>
3908: <p>The latter line is needed because the package expects the library
3909: <code class="filename">libIDL.so</code>, but only
3910: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3911: wrapper to rewrite that on the fly.</p>
3912: <p>The next problem was related to a recent change of the FreeType
1.189 snj 3913: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.91 rillig 3914: which patch files were relevant for this issue and copied them to the
3915: <code class="filename">patches</code> directory. Then I retried, fixed the
3916: patches so that they applied cleanly and retried again. This time,
3917: everything worked.</p>
3918: </div>
1.148 asau 3919: <div class="sect3">
1.91 rillig 3920: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3921: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3922: <pre class="programlisting">
1.100 rillig 3923: <code class="prompt">$</code> bmake CHECK_FILES=no install
3924: [...]
3925: <code class="prompt">$</code> bmake print-PLIST >PLIST
3926: <code class="prompt">$</code> bmake deinstall
3927: <code class="prompt">$</code> bmake install
1.91 rillig 3928: </pre>
3929: </div>
3930: </div>
3931: </div>
1.77 rillig 3932: </div>
1.148 asau 3933: <div class="chapter">
1.75 rillig 3934: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3935: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3936: <div class="toc">
3937: <p><b>Table of Contents</b></p>
1.195 wiz 3938: <dl class="toc">
1.128 wiz 3939: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3940: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106 rillig 3941: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3942: <dd><dl>
3943: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3944: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3945: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3946: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3947: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3948: </dl></dd>
3949: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3950: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3951: <dd><dl>
3952: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3953: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3954: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3955: </dl></dd>
1.128 wiz 3956: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3957: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 3958: </dl>
3959: </div>
1.87 wiz 3960: <p>Whenever you're preparing a package, there are a number of
3961: files involved which are described in the following
3962: sections.</p>
1.148 asau 3963: <div class="sect1">
1.75 rillig 3964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3965: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 3966: </h2></div></div></div>
1.75 rillig 3967: <p>Building, installation and creation of a binary package are all
1.87 wiz 3968: controlled by the package's <code class="filename">Makefile</code>.
3969: The <code class="filename">Makefile</code> describes various things about
3970: a package, for example from where to get it, how to configure,
3971: build, and install it.</p>
1.76 rillig 3972: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3973: sections that describe the package.</p>
1.75 rillig 3974: <p>In the first section there are the following variables, which
1.87 wiz 3975: should appear exactly in the order given here. The order and
3976: grouping of the variables is mostly historical and has no further
3977: meaning.</p>
1.148 asau 3978: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3979: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3980: distribution file to be downloaded from the package's
3981: website.</p></li>
1.128 wiz 3982: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3983: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3984: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 3985: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3986: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 3987: directory name together with the version number. It must match the
3988: regular expression
3989: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3990: starts with a letter or digit, and contains only letters, digits,
3991: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 3992: <li class="listitem">
1.75 rillig 3993: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 3994: which the package fits in. You can choose any of the top-level
3995: directories of pkgsrc for it.</p>
1.75 rillig 3996: <p>Currently the following values are available for
1.87 wiz 3997: <code class="varname">CATEGORIES</code>. If more than
3998: one is used, they need to be separated by spaces:</p>
1.75 rillig 3999: <pre class="programlisting">
1.100 rillig 4000: archivers cross geography meta-pkgs security
4001: audio databases graphics misc shells
4002: benchmarks devel ham multimedia sysutils
4003: biology editors inputmethod net textproc
4004: cad emulators lang news time
4005: chat finance mail parallel wm
4006: comms fonts math pkgtools www
4007: converters games mbone print x11
4008: </pre>
1.75 rillig 4009: </li>
1.128 wiz 4010: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4011: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4012: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4013: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4014: <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 4015: </ul></div>
4016: <p>The second section contains information about separately
1.87 wiz 4017: downloaded patches, if any.
4018: </p>
1.148 asau 4019: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190 wiz 4020: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87 wiz 4021: Name(s) of additional files that contain distribution patches.
4022: There is no default. pkgsrc will look for them at
4023: <code class="varname">PATCH_SITES</code>.
4024: They will automatically be uncompressed before patching if
4025: the names end with <code class="filename">.gz</code> or
4026: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4027: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4028: Primary location(s) for distribution patch files (see
1.190 wiz 4029: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
4030: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
4031: an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
4032: help find the correct files to patch. It defaults to
4033: <span class="command"><strong>-p0</strong></span>.</p></li>
1.75 rillig 4034: </ul></div>
4035: <p>The third section contains the following variables.
1.87 wiz 4036: </p>
1.148 asau 4037: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4038: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4039: address of the person who feels responsible for this package,
4040: and who is most likely to look at problems or questions regarding
1.189 snj 4041: 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 4042: Other developers may contact the <code class="varname">MAINTAINER</code>
4043: before making changes to the package, but are not required to
4044: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4045: to yourself. If you really can't maintain the package for future
4046: updates, set it to
1.110 hubertf 4047: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4048: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4049: of <code class="varname">MAINTAINER</code> when you do not want other
4050: developers to update or change the package without contacting
4051: you first. A package Makefile should contain one of
4052: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4053: not both. </p></li>
1.128 wiz 4054: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4055: find more information about the package.</p></li>
1.128 wiz 4056: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4057: description of the package (should not include the package
4058: name).</p></li>
1.75 rillig 4059: </ul></div>
4060: <p>Other variables that affect the build:
1.87 wiz 4061: </p>
1.148 asau 4062: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4063: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4064: interesting distribution files of the package are found. The
4065: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4066: works for most packages.</p>
1.75 rillig 4067: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4068: (most GNU software does, for instance), but extracts itself in
4069: the current directory, you should set
4070: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4071: <p>If a package doesn't create a subdirectory with the
4072: name of <code class="varname">DISTNAME</code> but some different name,
4073: set <code class="varname">WRKSRC</code> to point to the proper name in
4074: <code class="filename">${WRKDIR}</code>, for example
4075: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.189 snj 4076: <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 4077: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4078: taken from the <code class="varname">WRKDIR_BASENAME</code>
4079: variable. By default, its value is
4080: <code class="filename">work</code>. If you want to use the same
4081: pkgsrc tree for building different kinds of binary packages,
4082: you can change the variable according to your needs. Two
4083: other variables handle common cases of setting
4084: <code class="varname">WRKDIR_BASENAME</code> individually. If
4085: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4086: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4087: the host's name is attached to the directory name. If
4088: <code class="varname">OBJMACHINE</code> is defined, the platform name
4089: is attached, which might look like
4090: <code class="filename">work.i386</code> or
4091: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4092: </li></ul></div>
4093: <p>Please pay attention to the following gotchas:</p>
1.148 asau 4094: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4095: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4096: installed in compressed form by the package. For packages using
4097: BSD-style makefiles which honor MANZ, there is
4098: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4099: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4100: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4101: below).</p></li>
1.128 wiz 4102: <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 4103: </ul></div>
4104: </div>
1.148 asau 4105: <div class="sect1">
1.75 rillig 4106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4107: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4108: </h2></div></div></div>
1.76 rillig 4109: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4110: digest, or checksum, of each distfile needed for the package. This
4111: ensures that the distfiles retrieved from the Internet have not been
4112: corrupted during transfer or altered by a malign force to introduce
4113: a security hole. Due to recent rumor about weaknesses of digest
4114: algorithms, all distfiles are protected using both SHA1 and RMD160
4115: message digests, as well as the file size.</p>
1.76 rillig 4116: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4117: checksums for all the patches found in the
1.110 hubertf 4118: <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 4119: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4120: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4121: command.</p>
1.75 rillig 4122: <p>Some packages have different sets of distfiles depending on
1.189 snj 4123: 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 4124: <code class="filename">distinfo</code> file and care should be taken when
4125: upgrading such a package to ensure distfile information is not
4126: lost.</p>
1.75 rillig 4127: </div>
1.148 asau 4128: <div class="sect1">
1.75 rillig 4129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4130: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4131: <p>Many packages still don't work out-of-the box on the various
4132: platforms that are supported by pkgsrc. Therefore, a number of custom
4133: patch files are needed to make the package work. These patch files are
4134: found in the <code class="filename">patches/</code> directory.</p>
4135: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4136: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4137: 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 4138: order</a>.</p>
1.148 asau 4139: <div class="sect2">
1.93 rillig 4140: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4141: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4142: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4143: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4144: problems. (To force patches to apply with fuzz you can set
4145: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4146: should contain only changes for a single file, and no file should be
1.93 rillig 4147: patched by more than one patch file. This helps to keep future
4148: modifications simple.</p>
4149: <p>Each patch file is structured as follows: In the first line,
4150: there is the RCS Id of the patch itself. The second line should be
4151: empty for aesthetic reasons. After that, there should be a comment for
4152: each change that the patch does. There are a number of standard
4153: cases:</p>
1.148 asau 4154: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4155: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4156: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4157: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4158: platform and other environment (for example, the compiler) that the
4159: patch is needed for.</p></li>
4160: </ul></div>
1.130 wiz 4161: <p>In all, the patch should be commented so that any
1.93 rillig 4162: developer who knows the code of the application can make some use of
4163: the patch. Special care should be taken for the upstream developers,
4164: since we generally want that they accept our patches, so we have less
4165: work in the future.</p>
4166: </div>
1.148 asau 4167: <div class="sect2">
1.93 rillig 4168: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4169: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4170: <p>One important thing to mention is to pay attention that no RCS
4171: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4172: later checked into the NetBSD CVS tree. Use the
1.189 snj 4173: <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 4174: problems.</p>
1.87 wiz 4175: <p>For even more automation, we recommend using
1.110 hubertf 4176: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4177: whole set of patches. You just have to backup files before you
4178: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4179: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4180: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4181: you upgrade a package this way, you can easily compare the new
4182: set of patches with the previously existing one with
1.130 wiz 4183: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4184: are replaced by new files, so carefully check if you want to take all
4185: the changes.</p>
1.87 wiz 4186: <p>When you have finished a package, remember to generate
1.110 hubertf 4187: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4188: 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 4189: <p>When adding a patch that corrects a problem in the
4190: distfile (rather than e.g. enforcing pkgsrc's view of where
4191: man pages should go), send the patch as a bug report to the
4192: maintainer. This benefits non-pkgsrc users of the package,
4193: and usually makes it possible to remove the patch in future
4194: version.</p>
1.101 rillig 4195: <p>The file names of the patch files are usually of the form
1.130 wiz 4196: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4197: Many packages still use the previous convention
4198: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4199: but new patches should be of the form containing the filename.
1.189 snj 4200: <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.130 wiz 4201: automatically.</p>
1.93 rillig 4202: </div>
1.148 asau 4203: <div class="sect2">
1.93 rillig 4204: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4205: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4206: <p>If you want to share patches between multiple packages
4207: in pkgsrc, e.g. because they use the same distfiles, set
4208: <code class="varname">PATCHDIR</code> to the path where the patch files
4209: can be found, e.g.:</p>
4210: <pre class="programlisting">
1.100 rillig 4211: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4212: </pre>
1.75 rillig 4213: <p>Patch files that are distributed by the author or other
1.87 wiz 4214: maintainers can be listed in
4215: <code class="varname">PATCHFILES</code>.</p>
4216: <p>If it is desired to store any patches that should not be
4217: committed into pkgsrc, they can be kept outside the pkgsrc
4218: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4219: directory tree there is expected to have the same
1.128 wiz 4220: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4221: patches are expected to be stored inside these dirs (also
4222: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4223: example, if you want to keep a private patch for
4224: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4225: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4226: files in the named directory are expected to be patch files,
4227: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4228: applied</em></span>.</p>
1.93 rillig 4229: </div>
1.148 asau 4230: <div class="sect2">
1.85 jmmv 4231: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4232: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4233: <p>When fixing a portability issue in the code do not use
4234: preprocessor magic to check for the current operating system nor
4235: platform. Doing so hurts portability to other platforms because
4236: the OS-specific details are not abstracted appropriately.</p>
4237: <p>The general rule to follow is: instead of checking for the
4238: operating system the application is being built on, check for the
4239: specific <span class="emphasis"><em>features</em></span> you need. For example,
4240: instead of assuming that kqueue is available under NetBSD and
4241: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4242: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4243: yes, this generally involves patching the
1.110 hubertf 4244: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4245: that prevents some OSes from adopting interfaces from other OSes
4246: (e.g. Linux implementing kqueue), something that the above checks
4247: cannot take into account.</p>
4248: <p>Of course, checking for features generally involves more
4249: work on the developer's side, but the resulting changes are
1.87 wiz 4250: cleaner and there are chances they will work on many other
1.85 jmmv 4251: platforms. Not to mention that there are higher chances of being
4252: later integrated into the mainstream sources. Remember:
4253: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4254: <p>Some typical examples:</p>
4255: <div class="table">
1.106 rillig 4256: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4257: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4258: <colgroup>
4259: <col>
4260: <col>
4261: <col>
4262: </colgroup>
4263: <thead><tr>
4264: <th>Where</th>
4265: <th>Incorrect</th>
4266: <th>Correct</th>
4267: </tr></thead>
4268: <tbody>
4269: <tr>
4270: <td>configure script</td>
4271: <td>
1.100 rillig 4272: <pre class="programlisting">
4273: case ${target_os} in
4274: netbsd*) have_kvm=yes ;;
4275: *) have_kvm=no ;;
4276: esac
4277: </pre>
1.85 jmmv 4278: </td>
4279: <td>
1.100 rillig 4280: <pre class="programlisting">
4281: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4282: </pre>
1.85 jmmv 4283: </td>
4284: </tr>
4285: <tr>
4286: <td>C source file</td>
4287: <td>
1.100 rillig 4288: <pre class="programlisting">
4289: #if defined(__NetBSD__)
4290: # include <sys/event.h>
4291: #endif
4292: </pre>
1.85 jmmv 4293: </td>
4294: <td>
1.100 rillig 4295: <pre class="programlisting">
4296: #if defined(HAVE_SYS_EVENT_H)
4297: # include <sys/event.h>
4298: #endif
4299: </pre>
1.85 jmmv 4300: </td>
4301: </tr>
4302: <tr>
4303: <td>C source file</td>
4304: <td>
1.100 rillig 4305: <pre class="programlisting">
4306: int
4307: monitor_file(...)
4308: {
4309: #if defined(__NetBSD__)
4310: int fd = kqueue();
4311: ...
4312: #else
4313: ...
4314: #endif
4315: }
4316: </pre>
1.85 jmmv 4317: </td>
4318: <td>
1.100 rillig 4319: <pre class="programlisting">
4320: int
4321: monitor_file(...)
4322: {
4323: #if defined(HAVE_KQUEUE)
4324: int fd = kqueue();
4325: ...
4326: #else
4327: ...
4328: #endif
4329: }
4330: </pre>
1.85 jmmv 4331: </td>
4332: </tr>
4333: </tbody>
1.91 rillig 4334: </table></div>
1.85 jmmv 4335: </div>
1.91 rillig 4336: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4337: 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
4338: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4339: 2</a>). It summarizes multiple details on how to make
4340: software easier to package; all the suggestions in it were
4341: collected from our experience in pkgsrc work, so they are possibly
4342: helpful when creating patches too.</p>
4343: </div>
1.148 asau 4344: <div class="sect2">
1.85 jmmv 4345: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4346: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4347: <p>Always, always, <span class="strong"><strong>always</strong></span>
4348: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4349: improvements you do to a package to the mainstream developers.
4350: This is the only way to get their attention on portability issues
4351: and to ensure that future versions can be built out-of-the box on
4352: NetBSD. Furthermore, any user that gets newer distfiles will get
4353: the fixes straight from the packaged code.</p>
1.93 rillig 4354: <p>This generally involves cleaning up the patches
4355: (because sometimes the patches that are
1.147 wiz 4356: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4357: appropriate trackers for the projects and working with the
4358: mainstream authors to accept your changes. It is
4359: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4360: the packages in pkgsrc are kept simple and thus further changes
4361: can be done without much hassle.</p>
1.130 wiz 4362: <p>When you have done this, please add a URL to the upstream
4363: bug report to the patch comment.</p>
1.85 jmmv 4364: <p>Support the idea of free software!</p>
4365: </div>
1.75 rillig 4366: </div>
1.148 asau 4367: <div class="sect1">
1.75 rillig 4368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4369: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 4370: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4371: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4372: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4373: any credits where they are due. Please bear in mind that others do not
4374: share your sense of humour (or spelling idiosyncrasies), and that others
4375: will read everything that you write here.</p></dd>
1.76 rillig 4376: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4377: <dd><p>This file governs the files that are installed on your
4378: system: all the binaries, manual pages, etc. There are other
4379: directives which may be entered in this file, to control the
4380: creation and deletion of directories, and the location of
1.110 hubertf 4381: 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 4382: information.</p></dd>
1.75 rillig 4383: </dl></div>
4384: </div>
1.148 asau 4385: <div class="sect1">
1.75 rillig 4386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4387: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 4388: <div class="sect2">
1.78 rillig 4389: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4390: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 4391: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4392: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4393: <dd>
1.189 snj 4394: <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 4395: First time after package extraction and before files are
4396: moved in place, the second time after the files to install
4397: are moved in place. This can be used to do any custom
4398: procedures not possible with @exec commands in
1.189 snj 4399: <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
4400: <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 4401: Please note that you can modify variables in it easily by using
4402: <code class="varname">FILES_SUBST</code> in the package's
4403: <code class="filename">Makefile</code>:</p>
4404: <pre class="programlisting">
4405: FILES_SUBST+= SOMEVAR="somevalue"
4406: </pre>
4407: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4408: <code class="filename">INSTALL</code>. By default, substitution is
4409: performed for <code class="varname">PREFIX</code>,
4410: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4411: <code class="varname">VARBASE</code>, and a few others, type
4412: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4413: complete list.</p>
4414: </dd>
1.76 rillig 4415: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4416: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4417: this script's responsibility to clean up any additional messy details
4418: around the package's installation, since all pkg_delete knows is how to
4419: delete the files created in the original distribution.
1.189 snj 4420: 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>
4421: 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 4422: The same methods to replace variables can be used as for
4423: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4424: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4425: <dd>
4426: <p>This file is displayed after installation of the package.
1.87 wiz 4427: Useful for things like legal notices on almost-free
4428: software and hints for updating config files after
4429: installing modules for apache, PHP etc.
4430: Please note that you can modify variables in it easily by using
4431: <code class="varname">MESSAGE_SUBST</code> in the package's
4432: <code class="filename">Makefile</code>:</p>
1.75 rillig 4433: <pre class="programlisting">
1.100 rillig 4434: MESSAGE_SUBST+= SOMEVAR="somevalue"
4435: </pre>
1.128 wiz 4436: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4437: <code class="filename">MESSAGE</code>. By default, substitution is
4438: performed for <code class="varname">PKGNAME</code>,
4439: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4440: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4441: <code class="varname">X11BASE</code>,
4442: <code class="varname">PKG_SYSCONFDIR</code>,
4443: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4444: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4445: <p>You can display a different or additional files by
4446: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4447: default is <code class="filename">MESSAGE</code>, if the file
4448: exists.</p>
1.75 rillig 4449: </dd>
1.78 rillig 4450: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 4451: <dd>
4452: <p>This file is used by the alternatives framework.
4453: It creates, configures, and destroys generic wrappers used to
4454: run programs with similar interfaces.
4455: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4456: for more information.</p>
4457: <p>Each line of the file contains two filenames, first
4458: the wrapper and then the alternative provided by the package.
4459: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4460: </dd>
1.78 rillig 4461: </dl></div>
4462: </div>
1.148 asau 4463: <div class="sect2">
1.78 rillig 4464: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4465: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4466: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4467: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4468: <dd><p>This file contains arbitrary things that could
4469: also go into a <code class="filename">Makefile</code>, but its purpose is
4470: to be used by more than one package. This file should only be
4471: used when the packages that will use the file are known in
4472: advance. For other purposes it is often better to write a
4473: <code class="filename">*.mk</code> file and give it a good name that
4474: describes what it does.</p></dd>
4475: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4476: <dd><p>This file contains the dependency information
1.110 hubertf 4477: 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 4478: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4479: <dd><p>This file contains workarounds for compiler bugs
4480: and similar things. It is included automatically by the pkgsrc
4481: infrastructure, so you don't need an extra
4482: <code class="literal">.include</code> line for
4483: it.</p></dd>
4484: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4485: <dd><p>This file contains the code for the
1.110 hubertf 4486: 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 4487: selected by the user. If a package has only one or two options,
4488: it is equally acceptable to put the code directly into the
4489: <code class="filename">Makefile</code>.</p></dd>
4490: </dl></div>
4491: </div>
1.148 asau 4492: <div class="sect2">
1.78 rillig 4493: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4494: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4495: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4496: <dt><span class="term"><code class="filename">README*</code></span></dt>
4497: <dd><p>These files do not take place in the creation of
4498: a package and thus are purely informative to the package
4499: developer.</p></dd>
4500: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4501: <dd><p>This file contains things that need to be done
4502: to make the package even
4503: better.</p></dd>
1.75 rillig 4504: </dl></div>
4505: </div>
1.78 rillig 4506: </div>
1.148 asau 4507: <div class="sect1">
1.75 rillig 4508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4509: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4510: </h2></div></div></div>
1.110 hubertf 4511: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4512: unpacked into the directory denoted by
4513: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4514: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4515: directory is also used to keep various timestamp files.
4516: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4517: The default is <code class="filename">${.CURDIR}/work</code>
4518: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4519: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4520: </div>
1.148 asau 4521: <div class="sect1">
1.75 rillig 4522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4523: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4524: </h2></div></div></div>
1.75 rillig 4525: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4526: to configuration or building, you could place these files here and use
1.110 hubertf 4527: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4528: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4529: this. Alternatively, you could simply diff the file against
4530: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4531: the creation of this file.</p>
4532: <p>If you want to share files in this way with other
4533: packages, set the <code class="varname">FILESDIR</code> variable to point
4534: to the other package's <code class="filename">files</code> directory,
4535: e.g.:</p>
4536: <pre class="programlisting">
1.100 rillig 4537: FILESDIR=${.CURDIR}/../xemacs/files
4538: </pre>
1.75 rillig 4539: </div>
4540: </div>
1.148 asau 4541: <div class="chapter">
1.75 rillig 4542: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4543: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4544: <div class="toc">
4545: <p><b>Table of Contents</b></p>
1.195 wiz 4546: <dl class="toc">
1.106 rillig 4547: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4548: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4549: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4550: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4551: <dd><dl>
4552: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4553: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4554: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4555: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4556: <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 4557: </dl></dd>
4558: </dl>
4559: </div>
1.76 rillig 4560: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4561: each of which forms a well-defined part of the pkgsrc system. Using
1.189 snj 4562: 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 4563: like pkgsrc requires some discipline to keep the code correct and
4564: understandable.</p>
1.76 rillig 4565: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4566: programming are variables (which are actually macros) and shell
4567: commands. Among these shell commands may even be more complex ones
1.189 snj 4568: 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 4569: as intended it is necessary to quote all variables correctly when they
4570: are used.</p>
4571: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4572: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4573: with them.</p>
1.148 asau 4574: <div class="sect1">
1.75 rillig 4575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4576: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4577: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4578: <p>When you are creating a file as a
4579: target of a rule, always write the data to a temporary file first
4580: and finally rename that file. Otherwise there might occur an error
4581: in the middle of generating the file, and when the user runs
1.189 snj 4582: <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 4583: regenerated properly. Example:</p>
4584: <pre class="programlisting">
1.100 rillig 4585: wrong:
4586: @echo "line 1" > ${.TARGET}
4587: @echo "line 2" >> ${.TARGET}
4588: @false
4589:
4590: correct:
4591: @echo "line 1" > ${.TARGET}.tmp
4592: @echo "line 2" >> ${.TARGET}.tmp
4593: @false
4594: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4595: </pre>
1.110 hubertf 4596: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4597: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4598: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4599: correct</strong></span> gives an error message twice, as expected.</p>
1.189 snj 4600: <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 4601: <code class="literal">${.TARGET}</code> in case of error, but this only
4602: happens when it is interrupted, for example by pressing
4603: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.189 snj 4604: 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 4605: </li></ul></div>
4606: </div>
1.148 asau 4607: <div class="sect1">
1.97 rillig 4608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4609: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4610: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4611: can be processed using the five operators ``='', ``+='', ``?='',
1.189 snj 4612: ``:='', 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 4613: page.</p>
4614: <p>When a variable's value is parsed from a
1.76 rillig 4615: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4616: backslash character ``\'' are handled specially. If a backslash is
4617: followed by a newline, any whitespace immediately in front of the
4618: backslash, the backslash, the newline, and any whitespace
4619: immediately behind the newline are replaced with a single space. A
4620: backslash character and an immediately following hash character are
4621: replaced with a single hash character. Otherwise, the backslash is
4622: passed as is. In a variable assignment, any hash character that is
4623: not preceded by a backslash starts a comment that continues upto the
4624: end of the logical line.</p>
4625: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4626: the only way to create a variable consisting of a single backslash
4627: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4628: <p>So far for defining variables. The other thing you can do with
4629: variables is evaluating them. A variable is evaluated when it is
4630: part of the right side of the ``:='' or the ``!='' operator, or
4631: directly before executing a shell command which the variable is part
1.189 snj 4632: 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 4633: is, variables are not evaluated until there's no other way. The
4634: ``modifiers'' mentioned in the man page also evaluate the
4635: variable.</p>
4636: <p>Some of the modifiers split the string into words and then
4637: operate on the words, others operate on the string as a whole. When
4638: a string is split into words, it is split as you would expect
1.189 snj 4639: 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 4640: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4641: loop does not follow the shell quoting rules but splits at sequences
4642: of whitespace.</p>
4643: <p>There are several types of variables that should be handled
4644: differently. Strings and two types of lists.</p>
1.148 asau 4645: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4646: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4647: characters. Nevertheless, you should restrict yourself to only
4648: using printable characters. Examples are
4649: <code class="varname">PREFIX</code> and
4650: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4651: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4652: are never exported to any shell command. Their elements are
4653: separated by whitespace. Therefore, the elements themselves cannot
4654: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4655: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4656: Examples are <code class="varname">DEPENDS</code> and
4657: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4658: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4659: may be exported to a shell command. Their elements can contain any
4660: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4661: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4662: <code class="varname">DISTFILES</code> and
4663: <code class="varname">MASTER_SITES</code>.</p></li>
4664: </ul></div>
1.148 asau 4665: <div class="sect2">
1.75 rillig 4666: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4667: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4668: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4669: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4670: are reserved for use by the pkgsrc infrastructure. They shall
4671: not be used by package
1.76 rillig 4672: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4673: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4674: lowercase variable names for the iteration
4675: variables.</p></li>
1.128 wiz 4676: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4677: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4678: <code class="varname">DISTFILES</code>.</p></li>
4679: </ul></div>
4680: </div>
4681: </div>
1.148 asau 4682: <div class="sect1">
1.75 rillig 4683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4684: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4685: <p>This section presents you with some code snippets you should
4686: use in your own code. If you don't find anything appropriate here,
4687: you should test your code and add it here.</p>
1.148 asau 4688: <div class="sect2">
1.75 rillig 4689: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4690: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4691: <pre class="programlisting">
1.100 rillig 4692: STRING= foo * bar `date`
4693: INT_LIST= # empty
4694: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4695: EXT_LIST= # empty
4696: ANOTHER_EXT_LIST= a=b c=d
4697:
4698: INT_LIST+= ${STRING} # 1
4699: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4700: EXT_LIST+= ${STRING:Q} # 3
4701: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4702: </pre>
1.75 rillig 4703: <p>When you add a string to an external list (example 3), it
4704: must be quoted. In all other cases, you must not add a quoting
4705: level. You must not merge internal and external lists, unless you
4706: are sure that all entries are correctly interpreted in both
4707: lists.</p>
4708: </div>
1.148 asau 4709: <div class="sect2">
1.75 rillig 4710: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4711: <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 4712: <pre class="programlisting">
1.100 rillig 4713: EXT_LIST= # empty
4714: .for i in ${INT_LIST}
4715: EXT_LIST+= ${i:Q}""
4716: .endfor
1.1 grant 4717: </pre>
1.75 rillig 4718: <p>This code converts the internal list
4719: <code class="varname">INT_LIST</code> into the external list
4720: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4721: are unquoted they must be quoted here. The reason for appending
4722: <code class="varname">""</code> is explained below.</p>
4723: </div>
1.148 asau 4724: <div class="sect2">
1.75 rillig 4725: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4726: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4727: <p>Sometimes you may want to print an arbitrary string. There
4728: are many ways to get it wrong and only few that can handle every
4729: nastiness.</p>
1.75 rillig 4730: <pre class="programlisting">
1.100 rillig 4731: STRING= foo bar < > * `date` $$HOME ' "
4732: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4733:
1.100 rillig 4734: all:
4735: echo ${STRING} # 1
4736: echo "${STRING}" # 2
4737: echo "${STRING:Q}" # 3
4738: echo ${STRING:Q} # 4
4739: echo x${STRING:Q} | sed 1s,.,, # 5
4740: printf "%s\\n" ${STRING:Q}"" # 6
4741: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4742: </pre>
1.75 rillig 4743: <p>Example 1 leads to a syntax error in the shell, as the
4744: characters are just copied.</p>
4745: <p>Example 2 leads to a syntax error too, and if you leave out
4746: the last " character from <code class="varname">${STRING}</code>,
1.189 snj 4747: <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 4748: variable would be evaluated, too.</p>
4749: <p>Example 3 outputs each space character preceded by a
4750: backslash (or not), depending on the implementation of the
1.189 snj 4751: <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 4752: <p>Example 4 handles correctly every string that does not start
4753: with a dash. In that case, the result depends on the
1.189 snj 4754: 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 4755: guarantee that your input does not start with a dash, this form is
4756: appropriate.</p>
4757: <p>Example 5 handles even the case of a leading dash
4758: correctly.</p>
1.79 rillig 4759: <p>Example 6 also works with every string and is the
4760: light-weight solution, since it does not involve a pipe, which has
4761: its own problems.</p>
1.75 rillig 4762: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4763: because the quoting has already been done when adding elements to
4764: the list.</p>
4765: <p>As internal lists shall not be passed to the shell, there is
4766: no example for it.</p>
4767: </div>
1.148 asau 4768: <div class="sect2">
1.75 rillig 4769: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4770: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4771: <p>There are many possible sources of wrongly quoted variables.
4772: This section lists some of the commonly known ones.</p>
1.148 asau 4773: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4774: <li class="listitem">
1.75 rillig 4775: <p>Whenever you use the value of a list, think
4776: about what happens to leading or trailing whitespace. If the
4777: list is a well-formed shell expression, you can apply the
4778: <code class="varname">:M*</code> modifier to strip leading and trailing
4779: whitespace from each word. The <code class="varname">:M</code> operator
4780: first splits its argument according to the rules of the shell,
4781: and then creates a new list consisting of all words that match
4782: the shell glob expression <code class="varname">*</code>, that is: all.
4783: One class of situations where this is needed is when adding a
4784: variable like <code class="varname">CPPFLAGS</code> to
4785: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4786: invokes other configure scripts, it strips the leading and
4787: trailing whitespace from the variable and then passes it to the
4788: other configure scripts. But these configure scripts expect the
4789: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4790: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4791: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4792: here is how we do it:</p>
4793: <pre class="programlisting">
1.100 rillig 4794: CPPFLAGS= # empty
4795: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4796: CPPFLAGS+= ${MY_CPPFLAGS}
4797:
4798: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4799:
4800: all:
4801: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4802: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4803: </pre>
1.75 rillig 4804: </li>
1.128 wiz 4805: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 4806: <code class="varname">${PREFIX}</code> is a properly quoted shell
4807: expression, but there is the C compiler after it, which also
4808: expects a properly quoted string (this time in C syntax). The
4809: version above is therefore only correct if
4810: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4811: or double quotes. If you want to allow these, you have to add
4812: another layer of quoting to each variable that is used as a C
4813: string literal. You cannot use the <code class="varname">:Q</code>
4814: operator for it, as this operator only works for the
4815: shell.</p></li>
1.128 wiz 4816: <li class="listitem">
1.75 rillig 4817: <p>Whenever a variable can be empty, the
4818: <code class="varname">:Q</code> operator can have surprising results. Here
4819: are two completely different cases which can be solved with the
4820: same trick.</p>
4821: <pre class="programlisting">
1.100 rillig 4822: EMPTY= # empty
4823: empty_test:
4824: for i in a ${EMPTY:Q} c; do \
4825: echo "$$i"; \
4826: done
4827:
4828: for_test:
4829: .for i in a:\ a:\test.txt
4830: echo ${i:Q}
4831: echo "foo"
4832: .endfor
1.1 grant 4833: </pre>
1.75 rillig 4834: <p>The first example will only print two of the three lines
4835: we might have expected. This is because
4836: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4837: the shell cannot see. The workaround is to write
4838: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4839: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4840: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4841: <p>The second example will only print three lines instead of
4842: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4843: This is because the backslash of the value
4844: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.189 snj 4845: <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
4846: <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 4847: <code class="varname">${i:Q}""</code>.</p>
4848: </li>
4849: </ul></div>
4850: </div>
1.148 asau 4851: <div class="sect2">
1.75 rillig 4852: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4853: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 4854: <p>The pkgsrc bmake program does not handle the following
4855: assignment correctly. In case <code class="varname">_othervar_</code>
4856: contains a ``-'' character, one of the closing braces is included
4857: in <code class="varname">${VAR}</code> after this code executes.</p>
4858: <pre class="programlisting">
1.100 rillig 4859: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 4860: </pre>
1.75 rillig 4861: <p>For a more complex code snippet and a workaround, see the
1.189 snj 4862: 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 4863: <code class="varname">bug1</code>.</p>
4864: </div>
4865: </div>
4866: </div>
1.148 asau 4867: <div class="chapter">
1.75 rillig 4868: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4869: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4870: <div class="toc">
4871: <p><b>Table of Contents</b></p>
1.195 wiz 4872: <dl class="toc">
1.106 rillig 4873: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4874: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4875: <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 4876: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4877: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4878: <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 4879: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197 wiz 4880: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4881: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75 rillig 4882: </dl>
4883: </div>
1.87 wiz 4884: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4885: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4886: the package (relative to the <code class="filename">${PREFIX}</code>
4887: directory it's been installed in) plus some additional statements
1.189 snj 4888: - 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 4889: This chapter addresses some issues that need attention when
4890: dealing with the <code class="filename">PLIST</code> file (or files, see
4891: below!).</p>
1.148 asau 4892: <div class="sect1">
1.75 rillig 4893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4894: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4895: <p>Be sure to add a RCS ID line as the first thing in any
4896: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4897: <pre class="programlisting">
1.100 rillig 4898: @comment $NetBSD$
1.87 wiz 4899: </pre>
1.75 rillig 4900: </div>
1.148 asau 4901: <div class="sect1">
1.75 rillig 4902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4903: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4904: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4905: to output a PLIST that matches any new files since the package
1.110 hubertf 4906: 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 4907: more information on this target.</p>
1.75 rillig 4908: </div>
1.148 asau 4909: <div class="sect1">
1.75 rillig 4910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 4911: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4912: </h2></div></div></div>
1.87 wiz 4913: <p>If you have used any of the *-dirs packages, as explained in
1.197 wiz 4914: <a class="xref" href="#faq.common-dirs" title="13.9. Sharing directories between packages">Section 13.9, “Sharing directories between packages”</a>, you may have noticed that
1.110 hubertf 4915: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 4916: <code class="varname">@comment</code>s instead of real
4917: <code class="varname">@dirrm</code> lines. You can also do this for
4918: specific directories and files, so that the results of that
4919: command are very close to reality. This helps <span class="emphasis"><em>a
4920: lot</em></span> during the update of packages.</p>
4921: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4922: of AWK patterns and actions that are used to filter the output of
4923: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4924: scripting you like to it, but be careful with quoting.</p>
4925: <p>For example, to get all files inside the
4926: <code class="filename">libdata/foo</code> directory removed from the
4927: resulting PLIST:</p>
4928: <pre class="programlisting">
1.100 rillig 4929: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 4930: </pre>
4931: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4932: to a specific (shared) directory converted to
4933: <code class="varname">@comment</code>s:</p>
1.75 rillig 4934: <pre class="programlisting">
1.100 rillig 4935: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 4936: </pre>
1.75 rillig 4937: </div>
1.148 asau 4938: <div class="sect1">
1.75 rillig 4939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4940: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4941: <p>A number of variables are substituted automatically in
4942: PLISTs when a package is installed on a system. This includes the
4943: following variables:</p>
1.148 asau 4944: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4945: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4946: <dd>
4947: <p>Some packages like emacs and perl embed information
1.87 wiz 4948: about which architecture they were built on into the
4949: pathnames where they install their files. To handle this
4950: case, PLIST will be preprocessed before actually used, and
4951: the symbol
1.128 wiz 4952: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4953: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4954: same is done if the string
4955: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4956: PLIST somewhere - use this on packages that have GNU
4957: autoconf-created configure scripts.</p>
1.148 asau 4958: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4959: <h3 class="title">Legacy note</h3>
4960: <p>There used to be a symbol
1.128 wiz 4961: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4962: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4963: -m</strong></span>, but that's no longer supported and has
4964: been removed.</p>
1.75 rillig 4965: </div>
4966: </dd>
4967: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4968: <dd>
4969: <p>Some packages want to embed the OS name and version
1.87 wiz 4970: into some paths. To do this, use these variables in the
4971: <code class="filename">PLIST</code>:
4972: </p>
1.148 asau 4973: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4974: <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>
4975: <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>
4976: <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 4977: </ul></div>
4978: </dd>
4979: </dl></div>
1.199 tnn 4980: <p>For a list of values which are replaced by
4981: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4982: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4983: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87 wiz 4984: <p>If you want to change other variables not listed above, you
4985: can add variables and their expansions to this variable in the
1.110 hubertf 4986: 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 4987: <pre class="programlisting">
1.100 rillig 4988: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 4989: </pre>
1.128 wiz 4990: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4991: in the <code class="filename">PLIST</code> with
1.128 wiz 4992: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4993: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4994: the common case of conditionally including some
4995: <code class="filename">PLIST</code> entries. It can be done by adding
4996: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 4997: setting the corresponding <code class="varname">PLIST.foo</code> variable
4998: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 4999: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 5000: in the <code class="filename">PLIST</code> with either
1.128 wiz 5001: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5002: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5003: For example, in <code class="filename">Makefile</code>:</p>
5004: <pre class="programlisting">
5005: PLIST_VARS+= foo
5006: .if <em class="replaceable"><code>condition</code></em>
5007: PLIST.foo= yes
5008: .else
5009: </pre>
5010: <p>And then in <code class="filename">PLIST</code>:</p>
5011: <pre class="programlisting">
5012: @comment $NetBSD$
5013: bin/bar
5014: man/man1/bar.1
5015: ${PLIST.foo}bin/foo
5016: ${PLIST.foo}man/man1/foo.1
5017: ${PLIST.foo}share/bar/foo.data
5018: ${PLIST.foo}@dirrm share/bar
5019: </pre>
1.75 rillig 5020: </div>
1.148 asau 5021: <div class="sect1">
1.75 rillig 5022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5023: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5024: <p>Man pages should be installed in compressed form if
1.87 wiz 5025: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5026: and uncompressed otherwise. To handle this in the
1.128 wiz 5027: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5028: appended/removed automatically for man pages according to
5029: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5030: or not, see above for details. This modification of the
5031: <code class="filename">PLIST</code> file is done on a copy of it, not
5032: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5033: </div>
1.148 asau 5034: <div class="sect1">
1.75 rillig 5035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5036: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5037: </h2></div></div></div>
1.76 rillig 5038: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5039: in generating the binary package, set the variable
5040: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.189 snj 5041: 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 5042: important. The default for <code class="varname">PLIST_SRC</code> is
5043: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5044: </div>
1.148 asau 5045: <div class="sect1">
1.75 rillig 5046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5047: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5048: <p>Some packages decide to install a different set of files based on
1.87 wiz 5049: the operating system being used. These differences can be
5050: automatically handled by using the following files:</p>
1.148 asau 5051: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5052: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5053: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5054: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5055: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5056: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5057: </ul></div>
5058: </div>
1.148 asau 5059: <div class="sect1">
1.75 rillig 5060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197 wiz 5061: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
5062: <p>Some packages decide to generate hard-to-guess file names
5063: during installation that are hard to wire down.</p>
5064: <p>In such cases, you can set the
5065: <code class="varname">GENERATE_PLIST</code> variable to shell code
5066: terminated (with a semicolon) that will output PLIST entries which
5067: will be appended to the PLIST</p>
5068: <p>You can find one example in editors/xemacs:</p>
5069: <pre class="programlisting">
5070: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
5071: </pre>
5072: <p>which will append something like
5073: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
5074: <code class="filename">PLIST</code>.
5075: </p>
5076: </div>
5077: <div class="sect1">
5078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5079: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5080: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5081: multiple (and unrelated) packages install files. These
1.125 wiz 5082: directories were problematic because you had to add special
5083: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5084: centralized package handle them.</p>
1.125 wiz 5085: <p>In pkgsrc, it is now easy: Each package should create
5086: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5087: will remove any directories left empty after uninstalling a
5088: package.</p>
5089: <p>If a package needs an empty directory to work, create
5090: the directory during installation as usual, and also add an
5091: entry to the PLIST:
5092: </p>
1.87 wiz 5093: <pre class="programlisting">
1.125 wiz 5094: @pkgdir path/to/empty/directory
1.87 wiz 5095: </pre>
1.125 wiz 5096: <p>
1.197 wiz 5097: or take a look at <code class="varname">MAKE_DIRS</code> and
5098: <code class="varname">OWN_DIRS</code>.
1.125 wiz 5099: </p>
1.75 rillig 5100: </div>
5101: </div>
1.148 asau 5102: <div class="chapter">
1.75 rillig 5103: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5104: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5105: <div class="toc">
5106: <p><b>Table of Contents</b></p>
1.195 wiz 5107: <dl class="toc">
1.106 rillig 5108: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5109: <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 5110: <dd><dl>
1.106 rillig 5111: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5112: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5113: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5114: and
5115: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5116: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5117: </dl></dd>
1.128 wiz 5118: <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 5119: <dd><dl>
1.128 wiz 5120: <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 5121: <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 5122: </dl></dd>
5123: </dl>
5124: </div>
5125: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5126: are seen by a package's configure and build processes. This is implemented
5127: in a two step process:</p>
1.128 wiz 5128: <div class="orderedlist"><ol class="orderedlist" type="1">
5129: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5130: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5131: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5132: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5133: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5134: <code class="option">-L${LOCALBASE}/lib</code> into references to
5135: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5136: native compiler on some operating systems look like GCC, so that
5137: packages that expect GCC won't require modifications to build with
5138: those native compilers.</p></li>
1.75 rillig 5139: </ol></div>
5140: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5141: package may be built consistently despite what other software may be
5142: installed. Please note that the normal system header and library paths,
5143: e.g. <code class="filename">/usr/include</code>,
5144: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5145: designed to insulate the package build from non-system-supplied
5146: software.</p>
1.148 asau 5147: <div class="sect1">
1.75 rillig 5148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5149: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5150: <p>The process of converting packages to use the buildlink3
1.128 wiz 5151: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5152: The things to keep in mind are:</p>
1.128 wiz 5153: <div class="orderedlist"><ol class="orderedlist" type="1">
5154: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5155: instead of the actual toolchain. Some packages are tricky,
5156: and the only way to know for sure is the check
5157: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5158: wrappers are being invoked.</p></li>
1.128 wiz 5159: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5160: the package Makefile, e.g. Java VMs, standalone shells,
5161: etc., because the code to symlink files into
5162: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5163: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5164: </p></li>
1.128 wiz 5165: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5166: <code class="filename">buildlink3.mk</code> files that you list in a
5167: package's Makefile are added as dependencies for that package.
5168: </p></li>
1.75 rillig 5169: </ol></div>
1.87 wiz 5170: <p>If a dependency on a particular package is required for its libraries and
5171: headers, then we replace:</p>
1.75 rillig 5172: <pre class="programlisting">
1.100 rillig 5173: DEPENDS+= foo>=1.1.0:../../category/foo
5174: </pre>
1.75 rillig 5175: <p>with</p>
5176: <pre class="programlisting">
1.100 rillig 5177: .include "../../category/foo/buildlink3.mk"
5178: </pre>
1.75 rillig 5179: <p>The buildlink3.mk files usually define the required dependencies.
5180: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5181: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5182: <pre class="programlisting">
1.100 rillig 5183: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5184: .include "../../category/foo/buildlink3.mk"
5185: </pre>
1.76 rillig 5186: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5187: files in <code class="filename">pkgsrc/mk</code>
5188: that handle special package issues:</p>
1.148 asau 5189: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5190: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5191: the native or a pkgsrc Berkeley DB implementation based on
5192: the values of <code class="varname">BDB_ACCEPTED</code> and
5193: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5194: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5195: comes with neither Curses nor NCurses, this will take care
1.189 snj 5196: 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 5197: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5198: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5199: adding a dependency on Heimdal or MIT-krb5 for packages that
5200: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5201: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5202: system-provided Motif installation or adds a dependency on
1.189 snj 5203: <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 5204: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.151 obache 5205: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5206: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5207: which Motif version will be used.</p></li>
1.161 ryoon 5208: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 5209: system-provided GNU readline or editline (libedit) installation,
1.189 snj 5210: 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>,
5211: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.161 ryoon 5212: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5213: If your package really needs GNU readline library, its Makefile
5214: should include <code class="filename">devel/readline/buildlink3.mk</code>
5215: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 5216: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5217: variables that may be used by packages that use the
5218: Open Sound System (OSS) API.</p></li>
1.128 wiz 5219: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5220: any of the Postgres versions in the variable
5221: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5222: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5223: the file for more information.</p></li>
1.128 wiz 5224: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5225: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.189 snj 5226: 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 5227: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5228: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5229: library.</p></li>
1.75 rillig 5230: </ul></div>
1.76 rillig 5231: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5232: files provide a more complete
5233: description of how to use them properly.</p>
1.75 rillig 5234: </div>
1.148 asau 5235: <div class="sect1">
1.75 rillig 5236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5237: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5238: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5239: included by Makefiles to indicate the need to compile and link
5240: against header files and libraries provided by the package. A
5241: <code class="filename">buildlink3.mk</code> file should always provide
5242: enough information to add the correct type of dependency
5243: relationship and include any other
5244: <code class="filename">buildlink3.mk</code> files that it needs to find
5245: headers and libraries that it needs in turn.</p>
5246: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.189 snj 5247: 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 5248: package is highly recommended. For most packages, the following
5249: command will generate a good starting point for
5250: <code class="filename">buildlink3.mk</code> files:</p>
5251: <pre class="screen">
5252: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5253: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5254: </pre>
1.148 asau 5255: <div class="sect2">
1.75 rillig 5256: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5257: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5258: <p>The following real-life example
1.87 wiz 5259: <code class="filename">buildlink3.mk</code> is taken
5260: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5261: <pre class="programlisting">
1.120 snj 5262: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5263:
1.120 snj 5264: BUILDLINK_TREE+= tiff
1.1 grant 5265:
1.120 snj 5266: .if !defined(TIFF_BUILDLINK3_MK)
5267: TIFF_BUILDLINK3_MK:=
1.87 wiz 5268:
1.120 snj 5269: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5270: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5271: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5272:
1.100 rillig 5273: .include "../../devel/zlib/buildlink3.mk"
5274: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5275: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5276:
1.120 snj 5277: BUILDLINK_TREE+= -tiff
1.100 rillig 5278: </pre>
1.87 wiz 5279: <p>The header and footer manipulate
1.120 snj 5280: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5281: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5282: the dependency tree.</p>
5283: <p>The main section is protected from multiple inclusion
1.87 wiz 5284: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5285: added. Several important variables are set in the section:</p>
1.148 asau 5286: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5287: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5288: is the actual dependency recorded in the installed
5289: package; this should always be set using
1.110 hubertf 5290: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5291: we're appending to any pre-existing list of values. This
5292: variable should be set to the first version of the
1.133 wiz 5293: package that had an backwards-incompatible API change.
1.87 wiz 5294: </p></li>
1.128 wiz 5295: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5296: is the location of the <em class="replaceable"><code>pkg</code></em>
5297: pkgsrc directory.</p></li>
1.128 wiz 5298: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5299: (not shown above) controls whether we use
5300: <code class="varname">BUILD_DEPENDS</code> or
5301: <code class="varname">DEPENDS</code> to add the dependency on
5302: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5303: selected by setting
5304: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5305: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5306: used.</p></li>
1.128 wiz 5307: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5308: and
5309: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5310: (not shown above) are lists of subdirectories of
1.76 rillig 5311: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5312: to add to the header and library search paths. These
1.128 wiz 5313: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5314: respectively.</p></li>
1.128 wiz 5315: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5316: (not shown above) is the list of preprocessor flags to add
5317: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5318: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5319: should be avoided and instead be handled using
5320: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5321: above.</p></li>
1.75 rillig 5322: </ul></div>
1.87 wiz 5323: <p>The following variables are all optionally defined within
5324: this second section (protected against multiple inclusion) and
5325: control which package files are symlinked into
5326: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5327: transformed during the symlinking:</p>
1.148 asau 5328: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5329: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5330: (not shown above) is a shell glob pattern relative to
1.76 rillig 5331: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5332: to be symlinked into
1.76 rillig 5333: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5334: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5335: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5336: (not shown above) is a shell pipeline that
5337: outputs to stdout a list of files relative to
5338: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5339: The resulting files are to be symlinked
5340: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5341: this takes the <code class="filename">+CONTENTS</code> of a
5342: <em class="replaceable"><code>pkg</code></em> and filters it through
5343: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5344: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5345: (not shown above) is a filter command that filters
1.76 rillig 5346: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5347: relative to
1.76 rillig 5348: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194 bsiegert 5349: on stdout. By default,
1.75 rillig 5350: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5351: outputs the contents of the <code class="filename">include</code>
5352: and <code class="filename">lib</code> directories in the package
1.194 bsiegert 5353: <code class="filename">+CONTENTS</code>.</p></li>
1.128 wiz 5354: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5355: (not shown above) is a list of sed arguments used to
5356: transform the name of the source filename into a
1.110 hubertf 5357: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5358: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5359: </ul></div>
1.120 snj 5360: <p>This section can additionally include any
1.87 wiz 5361: <code class="filename">buildlink3.mk</code> needed for
5362: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5363: Including these <code class="filename">buildlink3.mk</code> files
5364: means that the headers and libraries for these
5365: dependencies are also symlinked into
5366: <code class="filename">${BUILDLINK_DIR}</code>
5367: whenever the <em class="replaceable"><code>pkg</code></em>
5368: <code class="filename">buildlink3.mk</code>
1.120 snj 5369: file is included. Dependencies are only added for directly
5370: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 5371: <p>When providing a <code class="filename">buildlink3.mk</code> and
5372: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 5373: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 5374: header files are automatically exposed when the package is
5375: use.</p>
5376: <p>In particular, if only an executable
5377: (<code class="filename">bin/foo</code>) is linked against a library, that
5378: library does not need to be propagated in the
5379: <code class="filename">buildlink3.mk</code> file.</p>
5380: <p>The following steps should help you decide if a
5381: <code class="filename">buildlink3.mk</code> file needs to be included:
5382: </p>
5383: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5384: <li class="listitem"><p>Look at the installed header files: What
5385: headers do they include? The packages providing these files
5386: must be buildlinked.</p></li>
1.155 wiz 5387: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5388: libraries and look against what other libraries they link.
5389: Some of the packages providing these probably need to be
5390: buildlinked; however, it's not automatic, since e.g. GTK on
5391: some systems pulls in the X libraries, so they will show up in
5392: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 5393: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 5394: used as a hint.</p></li>
1.153 wiz 5395: </ul></div>
5396: <p>
5397: </p>
1.75 rillig 5398: </div>
1.148 asau 5399: <div class="sect2">
1.75 rillig 5400: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5401: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5402: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5403: and
5404: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5405: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5406: <p>These two variables differ in that one describes source
5407: compatibility (API) and the other binary compatibility (ABI).
5408: The difference is that a change in the API breaks compilation of
5409: programs while changes in the ABI stop compiled programs from
5410: running.</p>
5411: <p>Changes to the
1.134 wiz 5412: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5413: variable in a <code class="filename">buildlink3.mk</code> file happen
5414: very rarely. One possible reason is that all packages depending
5415: on this already need a newer version. In case it is bumped see
5416: the description below.</p>
5417: <p>The most common example of an ABI change is that the major
5418: version of a shared library is increased. In this case,
5419: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5420: should be adjusted to require at least the new package version.
5421: Then the packages that depend on this package need their
5422: <code class="varname">PKGREVISION</code>s increased and, if they have
5423: <code class="filename">buildlink3.mk</code> files, their
5424: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5425: adjusted, too. This is needed so pkgsrc will require the correct
5426: package dependency and not settle for an older one when building
5427: the source.</p>
1.110 hubertf 5428: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5429: more information about dependencies on other packages,
5430: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5431: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5432: <p>Please take careful consideration before adjusting
5433: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5434: or
5435: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5436: as we don't want to cause unneeded package deletions and
5437: rebuilds. In many cases, new versions of packages work just
5438: fine with older dependencies.</p>
5439: <p>Also it is not needed to set
1.133 wiz 5440: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5441: when it is identical to
1.87 wiz 5442: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5443: </div>
5444: </div>
1.148 asau 5445: <div class="sect1">
1.75 rillig 5446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5447: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5448: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5449: coincide with headers and libraries present in the base system.
1.76 rillig 5450: Aside from a <code class="filename">buildlink3.mk</code> file, these
5451: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5452: file that includes the necessary checks to decide whether using
5453: the built-in software or the pkgsrc software is
1.87 wiz 5454: appropriate.</p>
5455: <p>The only requirements of a builtin.mk file for
5456: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5457: <div class="orderedlist"><ol class="orderedlist" type="1">
5458: <li class="listitem"><p>It should set
1.87 wiz 5459: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5460: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5461: after it is included.</p></li>
1.128 wiz 5462: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5463: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5464: which is already set before the
5465: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5466: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5467: is <span class="emphasis"><em>very</em></span> important and takes careful
5468: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5469: </ol></div>
1.148 asau 5470: <div class="sect2">
1.75 rillig 5471: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5472: <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 5473: <p>The following is the recommended template for builtin.mk
1.87 wiz 5474: files:</p>
1.75 rillig 5475: <pre class="programlisting">
1.100 rillig 5476: .if !defined(IS_BUILTIN.foo)
5477: #
5478: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5479: # genuinely exists in the system or not.
5480: #
5481: IS_BUILTIN.foo?= no
5482:
5483: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5484: # version can be determined.
5485: #
5486: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5487: BUILTIN_PKG.foo?= foo-1.0
5488: . endif
5489: .endif # IS_BUILTIN.foo
5490:
5491: .if !defined(USE_BUILTIN.foo)
5492: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5493: . if defined(BUILTIN_PKG.foo)
5494: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5495: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5496: USE_BUILTIN.foo!= \
5497: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5498: && ${ECHO} "yes" || ${ECHO} "no"
5499: . endif
5500: . endfor
5501: . endif
5502: .endif # USE_BUILTIN.foo
5503:
5504: CHECK_BUILTIN.foo?= no
5505: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5506: #
5507: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5508: # "yes" or "no".
5509: #
5510: .endif # CHECK_BUILTIN.foo
5511: </pre>
1.87 wiz 5512: <p>The first section sets
5513: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5514: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5515: in the base system. This should not be a base system software
5516: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5517: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5518: included as part of the base system. This variable is only
5519: used internally within the <code class="filename">builtin.mk</code>
5520: file.</p>
5521: <p>The second section sets
5522: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5523: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5524: system if it exists (if
5525: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5526: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5527: within the <code class="filename">builtin.mk</code> file.</p>
5528: <p>The third section sets
5529: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5530: and is <span class="emphasis"><em>required</em></span> in all
5531: <code class="filename">builtin.mk</code> files. The code in this
5532: section must make the determination whether the built-in
5533: software is adequate to satisfy the dependencies listed in
5534: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5535: This is typically done by comparing
5536: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5537: against each of the dependencies in
5538: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5539: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5540: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5541: end of the <code class="filename">builtin.mk</code> file. Note that
5542: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5543: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5544: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5545: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5546: that the built-in version of the software is similar enough to
5547: be used as a replacement.</p>
5548: <p>The last section is guarded by
5549: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5550: and includes code that uses the value of
5551: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5552: set in the previous section. This typically includes, e.g.,
5553: adding additional dependency restrictions and listing additional
5554: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5555: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5556: </div>
1.148 asau 5557: <div class="sect2">
1.75 rillig 5558: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5559: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5560: <p>When building packages, it's possible to choose whether to set
5561: a global preference for using either the built-in (native)
5562: version or the pkgsrc version of software to satisfy a
5563: dependency. This is controlled by setting
5564: <code class="varname">PREFER_PKGSRC</code> and
5565: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5566: 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 5567: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5568: use the pkgsrc versions of software, while
5569: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5570: built-in versions. Preferences are determined by the most
5571: specific instance of the package in either
5572: <code class="varname">PREFER_PKGSRC</code> or
5573: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5574: in neither or in both variables, then
5575: <code class="varname">PREFER_PKGSRC</code> has precedence over
5576: <code class="varname">PREFER_NATIVE</code>. For example, to require
5577: using pkgsrc versions of software for all but the most basic
5578: bits on a NetBSD system, you can set:</p>
5579: <pre class="programlisting">
1.100 rillig 5580: PREFER_PKGSRC= yes
5581: PREFER_NATIVE= getopt skey tcp_wrappers
5582: </pre>
1.87 wiz 5583: <p>A package <span class="emphasis"><em>must</em></span> have a
5584: <code class="filename">builtin.mk</code>
5585: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5586: otherwise it is simply ignored in that list.</p>
1.75 rillig 5587: </div>
5588: </div>
5589: </div>
1.148 asau 5590: <div class="chapter">
1.75 rillig 5591: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5592: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5593: <div class="toc">
5594: <p><b>Table of Contents</b></p>
1.195 wiz 5595: <dl class="toc">
1.106 rillig 5596: <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 5597: <dd><dl>
1.106 rillig 5598: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5599: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5600: </dl></dd>
1.106 rillig 5601: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5602: <dd><dl>
1.128 wiz 5603: <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 5604: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5605: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5606: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5607: </dl></dd>
5608: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5609: <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>
5610: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5611: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5612: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5613: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5614: <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 5615: </dl>
5616: </div>
5617: <p>This chapter describes the framework known as
5618: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5619: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5620: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5621: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5622: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5623: provided that packages are correctly designed.</p></li>
1.128 wiz 5624: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5625: <li class="listitem"><p>Registration of system users and groups.</p></li>
5626: <li class="listitem"><p>Registration of system shells.</p></li>
5627: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5628: </ul></div>
5629: <p>The following sections inspect each of the above points in detail.</p>
5630: <p>You may be thinking that many of the things described here could be
5631: easily done with simple code in the package's post-installation target
5632: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5633: as the code in them is only executed when building from source. Machines
5634: using binary packages could not benefit from it at all (as the code itself
5635: could be unavailable). Therefore, the only way to achieve any of the items
5636: described above is by means of the installation scripts, which are
5637: automatically generated by pkginstall.</p>
1.148 asau 5638: <div class="sect1">
1.75 rillig 5639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5640: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5641: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5642: of files and directories that belong to a package. The names used in it
1.76 rillig 5643: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5644: which means that it cannot register files outside this directory (absolute
5645: path names are not allowed). Despite this restriction, some packages need
5646: to install files outside this location; e.g., under
1.76 rillig 5647: <code class="filename">${VARBASE}</code> or
1.87 wiz 5648: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5649: is to create such files during installation time by using
5650: installation scripts.</p>
5651: <p>The generic installation scripts are shell scripts that can
5652: contain arbitrary code. The list of scripts to execute is taken from
5653: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5654: <code class="filename">INSTALL</code>. A similar variable exists for package
5655: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5656: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5657: commands, so they have the potential to create and manage files
5658: anywhere in the file system.</p>
5659: <p>Using these general installation files is not recommended, but
5660: may be needed in some special cases. One reason for avoiding them is
5661: that the user has to trust the packager that there is no unwanted or
5662: simply erroneous code included in the installation script. Also,
5663: previously there were many similar scripts for the same functionality,
5664: and fixing a common error involved finding and changing all of
5665: them.</p>
5666: <p>The pkginstall framework offers another, standardized way. It
5667: provides generic scripts to abstract the manipulation of such files
5668: and directories based on variables set in the package's
5669: <code class="filename">Makefile</code>. The rest of this section describes
5670: these variables.</p>
1.148 asau 5671: <div class="sect2">
1.75 rillig 5672: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5673: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5674: <p>The following variables can be set to request the creation of
5675: directories anywhere in the file system:</p>
1.148 asau 5676: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5677: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5678: contain a list of directories that should be created and should attempt
5679: to be destroyed by the installation scripts. The difference between
5680: the two is that the latter prompts the administrator to remove any
5681: directories that may be left after deinstallation (because they were
5682: not empty), while the former does not.</p></li>
1.128 wiz 5683: <li class="listitem">
1.75 rillig 5684: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5685: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5686: which directories should be created and should attempt to be destroyed
5687: by the installation scripts. Each tuple holds the following values,
5688: separated by spaces: the directory name, its owner, its group and its
5689: numerical mode. For example:</p>
5690: <pre class="programlisting">
1.100 rillig 5691: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5692: </pre>
1.75 rillig 5693: <p>The difference between the two is exactly the same as their
5694: non-<code class="varname">PERMS</code> counterparts.</p>
5695: </li>
5696: </ul></div>
5697: </div>
1.148 asau 5698: <div class="sect2">
1.75 rillig 5699: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5700: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5701: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5702: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5703: To overcome this problem, the only solution is to extract the file in the
5704: known place (i.e., inside the installation prefix) and copy it to the
5705: appropriate location during installation (done by the installation scripts
5706: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5707: file</em></span> in the following paragraphs, which describe the variables
5708: that can be used to automatically and consistently handle files outside the
5709: installation prefix:</p>
1.148 asau 5710: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5711: <li class="listitem">
1.75 rillig 5712: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5713: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5714: During installation time, the master file is copied to the target one
5715: if and only if the latter does not exist. Upon deinstallation, the
5716: target file is removed provided that it was not modified by the
5717: installation.</p>
5718: <p>The difference between the two is that the latter prompts the
5719: administrator to remove any files that may be left after
5720: deinstallation (because they were not empty), while the former does
5721: not.</p>
5722: </li>
1.128 wiz 5723: <li class="listitem">
1.75 rillig 5724: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5725: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5726: files as well as their target locations. For each of them, it also
5727: specifies their owner, their group and their numeric permissions, in
5728: this order. For example:</p>
5729: <pre class="programlisting">
1.137 wiz 5730: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5731: </pre>
1.75 rillig 5732: <p>The difference between the two is exactly the same as their
5733: non-<code class="varname">PERMS</code> counterparts.</p>
5734: </li>
5735: </ul></div>
5736: </div>
5737: </div>
1.148 asau 5738: <div class="sect1">
1.75 rillig 5739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5740: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5741: <p>Configuration files are special in the sense that they are installed
5742: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5743: need special treatment during installation (most of which is automated by
5744: pkginstall). The main concept you must bear in mind is that files marked
5745: as configuration files are automatically copied to the right place (somewhere
5746: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5747: and only if</em></span> they didn't exist before. Similarly, they will not
5748: be removed if they have local modifications. This ensures that
5749: administrators never lose any custom changes they may have made.</p>
1.148 asau 5750: <div class="sect2">
1.75 rillig 5751: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5752: <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 5753: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5754: specifies where configuration files shall be installed. Its contents are
5755: set based upon the following variables:</p>
1.148 asau 5756: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5757: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5758: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5759: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5760: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5761: Packages must not use it directly.</p></li>
1.128 wiz 5762: <li class="listitem">
1.75 rillig 5763: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5764: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5765: for the package being built shall be installed. The definition of this
5766: variable only makes sense in the package's
1.76 rillig 5767: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5768: <p>As an example, consider the Apache package,
1.189 snj 5769: <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 5770: configuration files under the
1.76 rillig 5771: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5772: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5773: Makefile.</p>
5774: </li>
1.128 wiz 5775: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5776: variable that holds this package's configuration directory (if
5777: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5778: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5779: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5780: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5781: directory where the configuration files for the package identified by
5782: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5783: </ul></div>
5784: <p>Based on the above variables, pkginstall determines the value of
5785: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5786: variable that can be used within a package to refer to its configuration
5787: directory. The algorithm used to set its value is basically the
5788: following:</p>
1.128 wiz 5789: <div class="orderedlist"><ol class="orderedlist" type="1">
5790: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5791: its value is used.</p></li>
1.128 wiz 5792: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5793: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5794: <code class="filename">Makefile</code>, the resulting value is
5795: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5796: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5797: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5798: </ol></div>
1.76 rillig 5799: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5800: 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
5801: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5802: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5803: </div>
1.148 asau 5804: <div class="sect2">
1.75 rillig 5805: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5806: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5807: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5808: known place, you need to teach each package where it shall install its
5809: files. In some cases you will have to patch the package Makefiles to
5810: achieve it. If you are lucky, though, it may be as easy as passing an
5811: extra flag to the configuration script; this is the case of GNU Autoconf-
5812: generated files:</p>
5813: <pre class="programlisting">
1.100 rillig 5814: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5815: </pre>
1.75 rillig 5816: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5817: for</em></span> its configuration files, not where they will be originally
5818: installed (although the difference is never explicit,
5819: unfortunately).</p>
5820: </div>
1.148 asau 5821: <div class="sect2">
1.75 rillig 5822: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5823: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5824: <p>As said before, pkginstall automatically handles configuration files.
5825: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5826: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5827: directly</strong></span>. Bad news is that many software installation scripts
5828: will, out of the box, mess with the contents of that directory. So what is
5829: the correct procedure to fix this issue?</p>
5830: <p>You must teach the package (usually by manually patching it) to
5831: install any configuration files under the examples hierarchy,
1.76 rillig 5832: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5833: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5834: has the original copies available.</p>
5835: <p>Once the required configuration files are in place (i.e., under the
5836: examples hierarchy), the pkginstall framework can use them as master copies
5837: during the package installation to update what is in
1.76 rillig 5838: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5839: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5840: 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 5841: about their syntax and their purpose. Here is an example, taken from the
1.189 snj 5842: <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 5843: <pre class="programlisting">
1.100 rillig 5844: EGDIR= ${PREFIX}/share/doc/mutt/samples
5845: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5846: </pre>
1.75 rillig 5847: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5848: package and has no meaning outside it.</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-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5853: <p>The automatic copying of config files can be toggled by setting the
5854: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5855: installation.</p>
5856: </div>
5857: </div>
1.148 asau 5858: <div class="sect1">
1.75 rillig 5859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5860: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5861: <p>System startup scripts are special files because they must be
5862: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5863: 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 5864: can be used. However, pkginstall provides a special mechanism to handle
5865: these files.</p>
5866: <p>In order to provide system startup scripts, the package has
5867: to:</p>
1.128 wiz 5868: <div class="orderedlist"><ol class="orderedlist" type="1">
5869: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5870: the <code class="literal">.sh</code> suffix appended. Considering the
1.189 snj 5871: <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 5872: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5873: <li class="listitem">
1.75 rillig 5874: <p>Tell pkginstall to handle it, appending the name of the script,
5875: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5876: Continuing the previous example:</p>
5877: <pre class="programlisting">
1.100 rillig 5878: RCD_SCRIPTS+= cupsd
1.1 grant 5879: </pre>
1.75 rillig 5880: </li>
5881: </ol></div>
5882: <p>Once this is done, pkginstall will do the following steps for each
5883: script in an automated fashion:</p>
1.128 wiz 5884: <div class="orderedlist"><ol class="orderedlist" type="1">
5885: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5886: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5887: variable.</p></li>
1.128 wiz 5888: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5889: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5890: that this master file must be explicitly registered in the
1.76 rillig 5891: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5892: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5893: from the examples hierarchy into the system-wide startup scripts
5894: directory.</p></li>
5895: </ol></div>
1.148 asau 5896: <div class="sect2">
1.75 rillig 5897: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5898: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5899: <p>The automatic copying of config files can be toggled by setting the
5900: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5901: installation. Note that the scripts will be always copied inside the
1.76 rillig 5902: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5903: matter what the value of this variable is.</p>
5904: </div>
5905: </div>
1.148 asau 5906: <div class="sect1">
1.75 rillig 5907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5908: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5909: <p>If a package needs to create special users and/or groups during
5910: installation, it can do so by using the pkginstall framework.</p>
5911: <p>Users can be created by adding entries to the
5912: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5913: syntax:</p>
5914: <pre class="programlisting">
1.100 rillig 5915: user:group
1.1 grant 5916: </pre>
1.87 wiz 5917: <p>Further specification of user details may be done by setting
5918: per-user variables.
5919: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5920: numeric UID for the user.
5921: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5922: user's description or comment.
5923: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5924: user's home directory, and defaults to
5925: <code class="filename">/nonexistent</code> if not specified.
5926: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5927: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5928: not specified.</p>
1.75 rillig 5929: <p>Similarly, groups can be created by adding entries to the
5930: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5931: <pre class="programlisting">
1.100 rillig 5932: group
1.1 grant 5933: </pre>
1.93 rillig 5934: <p>The numeric GID of the group may be set by defining
1.75 rillig 5935: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5936: <p>If a package needs to create the users and groups at an earlier
5937: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5938: either <code class="literal">configure</code> or <code class="literal">build</code> to
5939: indicate the phase before which the users and groups are created. In
5940: this case, the numeric UIDs and GIDs of the created users and groups
5941: are automatically hardcoded into the final installation scripts.</p>
5942: </div>
1.148 asau 5943: <div class="sect1">
1.75 rillig 5944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5945: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5946: <p>Packages that install system shells should register them in the shell
1.76 rillig 5947: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5948: administrator. This must be done from the installation scripts to keep
5949: binary packages working on any system. pkginstall provides an easy way to
5950: accomplish this task.</p>
5951: <p>When a package provides a shell interpreter, it has to set the
5952: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5953: add some hooks to the installation scripts to handle it. Consider the
1.189 snj 5954: 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 5955: <pre class="programlisting">
1.100 rillig 5956: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5957: </pre>
1.148 asau 5958: <div class="sect2">
1.75 rillig 5959: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5960: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5961: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5962: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5963: environment variable to <code class="literal">NO</code>.</p>
5964: </div>
5965: </div>
1.148 asau 5966: <div class="sect1">
1.75 rillig 5967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5968: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5969: <p>Packages that install X11 fonts should update the database files
5970: that index the fonts within each fonts directory. This can easily be
5971: accomplished within the pkginstall framework.</p>
5972: <p>When a package installs X11 fonts, it must list the directories in
5973: which fonts are installed in the
5974: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5975: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5976: <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 5977: installation scripts to run the appropriate commands to update the fonts
5978: database files within each of those directories. For convenience, if the
5979: directory path is relative, it is taken to be relative to the package's
1.189 snj 5980: 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 5981: <pre class="programlisting">
1.175 wiz 5982: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5983: </pre>
1.148 asau 5984: <div class="sect2">
1.75 rillig 5985: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5986: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5987: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5988: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5989: environment variable to <code class="literal">NO</code>.</p>
5990: </div>
5991: </div>
5992: </div>
1.148 asau 5993: <div class="chapter">
1.75 rillig 5994: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5995: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 5996: <div class="toc">
5997: <p><b>Table of Contents</b></p>
1.195 wiz 5998: <dl class="toc">
1.106 rillig 5999: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 6000: <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 6001: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6002: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6003: </dl>
6004: </div>
6005: <p>Many packages have the ability to be built to support different
1.76 rillig 6006: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6007: in pkgsrc that provides generic handling of those options that
6008: determine different ways in which the packages can be built. It's
6009: possible for the user to specify exactly which sets of options will be
6010: built into a package or to allow a set of global default options
6011: apply.</p>
1.107 rillig 6012: <p>There are two broad classes of behaviors that one might want to
6013: control via options. One is whether some particular feature is
6014: enabled in a program that will be built anyway, often by including or
6015: not including a dependency on some other package. The other is
6016: whether or not an additional program will be built as part of the
6017: package. Generally, it is better to make a split package for such
6018: additional programs instead of using options, because it enables
6019: binary packages to be built which can then be added separately. For
6020: example, the foo package might have minimal dependencies (those
6021: packages without which foo doesn't make sense), and then the foo-gfoo
6022: package might include the GTK frontend program gfoo. This is better
6023: than including a gtk option to foo that adds gfoo, because either that
6024: option is default, in which case binary users can't get foo without
6025: gfoo, or not default, in which case they can't get gfoo. With split
6026: packages, they can install foo without having GTK, and later decide to
6027: install gfoo (pulling in GTK at that time). This is an advantage to
6028: source users too, avoiding the need for rebuilds.</p>
6029: <p>Plugins with widely varying dependencies should usually be split
6030: instead of options.</p>
6031: <p>It is often more work to maintain split packages, especially if
6032: the upstream package does not support this. The decision of split
6033: vs. option should be made based on the likelihood that users will want
6034: or object to the various pieces, the size of the dependencies that are
6035: included, and the amount of work.</p>
6036: <p>A further consideration is licensing. Non-free parts, or parts
6037: that depend on non-free dependencies (especially plugins) should
6038: almost always be split if feasible.</p>
1.148 asau 6039: <div class="sect1">
1.75 rillig 6040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6041: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6042: <p>Global default options are listed in
6043: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6044: that should be built into every package if that option is supported.
1.110 hubertf 6045: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6046: </div>
1.148 asau 6047: <div class="sect1">
1.75 rillig 6048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6049: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6050: </h2></div></div></div>
1.75 rillig 6051: <p>The following example shows how
1.76 rillig 6052: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6053: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6054: <code class="filename">Makefile</code>, or in a file,
6055: e.g. <code class="filename">options.mk</code>, that is included by the
6056: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6057: <pre class="programlisting">
1.100 rillig 6058: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6059: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6060: PKG_OPTIONS_OPTIONAL_GROUPS= database
6061: PKG_OPTIONS_GROUP.database= mysql pgsql
6062: PKG_SUGGESTED_OPTIONS= wibble-foo
6063: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6064: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6065:
6066: .include "../../mk/bsd.prefs.mk"
6067:
6068: # this package was previously named wibble2
6069: .if defined(PKG_OPTIONS.wibble2)
6070: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6071: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6072: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6073: .endif
6074:
6075: .include "../../mk/bsd.options.mk"
6076:
6077: # Package-specific option-handling
6078:
6079: ###
6080: ### FOO support
6081: ###
6082: .if !empty(PKG_OPTIONS:Mwibble-foo)
6083: CONFIGURE_ARGS+= --enable-foo
6084: .endif
6085:
6086: ###
6087: ### LDAP support
6088: ###
6089: .if !empty(PKG_OPTIONS:Mldap)
6090: . include "../../databases/openldap-client/buildlink3.mk"
6091: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6092: .endif
6093:
6094: ###
6095: ### database support
6096: ###
6097: .if !empty(PKG_OPTIONS:Mmysql)
6098: . include "../../mk/mysql.buildlink3.mk"
6099: .endif
6100: .if !empty(PKG_OPTIONS:Mpgsql)
6101: . include "../../mk/pgsql.buildlink3.mk"
6102: .endif
1.75 rillig 6103: </pre>
6104: <p>The first section contains the information about which build
6105: options are supported by the package, and any default options settings
6106: if needed.</p>
1.128 wiz 6107: <div class="orderedlist"><ol class="orderedlist" type="1">
6108: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.189 snj 6109: <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 6110: options. It should be set to
1.78 rillig 6111: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6112: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6113: at the point where the options are processed.</p></li>
1.128 wiz 6114: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6115: build options supported by the package.</p></li>
1.128 wiz 6116: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6117: list of names of groups of mutually exclusive options. The options in
6118: each group are listed in
6119: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6120: The most specific setting of any option from the group takes
6121: precedence over all other options in the group. Options from the
6122: groups will be automatically added to
6123: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6124: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6125: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6126: packages will fail if no option from the group is
6127: selected.</p></li>
1.128 wiz 6128: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6129: of names of sets of options. At least one option from each set must
6130: be selected. The options in each set are listed in
6131: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6132: Options from the sets will be automatically added to
6133: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6134: fail if no option from the set is selected.</p></li>
1.128 wiz 6135: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6136: build options which are enabled by default.</p></li>
1.128 wiz 6137: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6138: of
1.128 wiz 6139: <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 6140: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6141: their option counterparts. Pairs should be added with
1.128 wiz 6142: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6143: warning will be issued if the user uses a legacy
6144: variable.</p></li>
1.128 wiz 6145: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6146: of
1.128 wiz 6147: <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 6148: pairs that map options that have been renamed to their new
1.128 wiz 6149: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6150: the listing of global legacy options. A warning will be issued if
6151: the user uses a legacy option.</p></li>
1.128 wiz 6152: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6153: options implied by deprecated variables used. This can be used for
6154: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6155: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6156: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6157: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6158: a list of warnings about deprecated variables or options used, and
6159: what to use instead.</p></li>
6160: </ol></div>
6161: <p>A package should never modify
6162: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6163: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6164: To suggest a default set of options, use
6165: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6166: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6167: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6168: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6169: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6170: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6171: happen with platform-specific options if none of them is supported on
6172: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6173: empty list and the package is otherwise treated as not using the
6174: options framework.</p>
1.76 rillig 6175: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6176: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6177: build options, properly filtered to remove unsupported and duplicate
6178: options.</p>
6179: <p>The remaining sections contain the logic that is specific to
6180: each option. The correct way to check for an option is to check
6181: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6182: <pre class="programlisting">
1.100 rillig 6183: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6184: </pre>
6185: </div>
1.148 asau 6186: <div class="sect1">
1.75 rillig 6187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6188: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6189: <p>Options that enable similar features in different packages (like
6190: optional support for a library) should use a common name in all
6191: packages that support it (like the name of the library). If another
6192: package already has an option with the same meaning, use the same
6193: name.</p>
6194: <p>Options that enable features specific to one package, where it's
6195: unlikely that another (unrelated) package has the same (or a similar)
6196: optional feature, should use a name prefixed with
6197: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6198: <p>If a group of related packages share an optional feature
6199: specific to that group, prefix it with the name of the
1.128 wiz 6200: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6201: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6202: <p>For new options, add a line to
1.76 rillig 6203: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6204: fields, separated by tab. The first field is the option name, the
6205: second its description. The description should be a whole sentence
6206: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6207: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6208: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6209: </div>
1.148 asau 6210: <div class="sect1">
1.107 rillig 6211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6212: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6213: <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 6214: different dependencies based on the options with which the package was
6215: built. For querying these options, the file
6216: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6217: typical example looks like this:</p>
6218: <pre class="programlisting">
6219: pkgbase := libpurple
6220: .include "../../mk/pkg-build-options.mk"
6221:
6222: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6223: ...
6224: .endif
6225: </pre>
6226: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6227: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6228: options of the libpurple package, which can then be queried like
6229: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6230: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6231: details.</p>
6232: </div>
1.75 rillig 6233: </div>
1.148 asau 6234: <div class="chapter">
1.75 rillig 6235: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6236: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6237: <div class="toc">
6238: <p><b>Table of Contents</b></p>
1.195 wiz 6239: <dl class="toc">
1.106 rillig 6240: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6241: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6242: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6243: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6244: <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 6245: <dd><dl>
6246: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6247: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6248: </dl></dd>
1.128 wiz 6249: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6250: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6251: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6252: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6253: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6254: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6255: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6256: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6257: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6258: <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 6259: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6260: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6261: </dl>
6262: </div>
1.148 asau 6263: <div class="sect1">
1.75 rillig 6264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6265: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6266: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6267: built. Building a package is separated into different
6268: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6269: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6270: described in the following sections. Each phase is split into
1.87 wiz 6271: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6272: containing phase, prefixed by one of <code class="varname">pre-</code>,
6273: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6274: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6275: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6276: <p>Never override the regular targets (like
6277: <code class="varname">fetch</code>), if you have to, override the
6278: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6279: <p>The basic steps for building a program are always the same. First
1.87 wiz 6280: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6281: the local system and then extracted. After any pkgsrc-specific patches
6282: to compile properly are applied, the software can be configured, then
6283: built (usually by compiling), and finally the generated binaries, etc.
6284: can be put into place on the system.</p>
1.97 rillig 6285: <p>To get more details about what is happening at each step,
6286: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6287: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6288: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6289: </div>
1.148 asau 6290: <div class="sect1">
1.75 rillig 6291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6292: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6293: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6294: the next section, here's a brief discussion on where programs are
6295: installed, and which variables influence this.</p>
1.75 rillig 6296: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6297: where all files of the final program shall be installed. It is
6298: usually set to <code class="varname">LOCALBASE</code>
6299: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6300: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6301: <code class="varname">PREFIX</code> needs to be put
6302: into the various places in the program's source where paths to
1.110 hubertf 6303: 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 6304: <p>When choosing which of these variables to use,
1.87 wiz 6305: follow the following rules:</p>
1.148 asau 6306: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6307: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6308: where the current pkg will be installed. When referring to a
6309: pkg's own installation path, use
1.128 wiz 6310: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6311: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6312: are installed. If you need to construct a -I or -L argument
6313: to the compiler to find includes and libraries installed by
1.128 wiz 6314: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6315: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6316: installed all packages in <code class="filename">/usr/local</code>. As
6317: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6318: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6319: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6320: distribution (from xsrc, etc.) is installed. When looking for
6321: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6322: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6323: <li class="listitem">
1.88 wiz 6324: <p>X11-based packages are special in that they may be
6325: installed in either <code class="varname">X11BASE</code> or
6326: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6327: <p>Usually, X11 packages should be installed under
1.88 wiz 6328: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6329: will need to include
6330: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6331: request the presence of X11 and to get the right compilation
6332: flags.</p>
1.75 rillig 6333: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6334: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6335: files. These packages are special and they must be placed under
6336: <code class="varname">X11BASE</code>. To accomplish this, set either
6337: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6338: your package.</p>
1.75 rillig 6339: <p>Some notes: If you need
1.87 wiz 6340: to find includes or libraries installed by a pkg that has
6341: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6342: its pkg <code class="filename">Makefile</code>, you need to look in
6343: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6344: <code class="filename">${LOCALBASE}</code>. To force installation of
6345: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.189 snj 6346: <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 6347: is enabled by default.</p>
1.75 rillig 6348: </li>
1.128 wiz 6349: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6350: the installed location of an X11
6351: package. <code class="varname">X11PREFIX</code> will be set to
6352: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6353: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6354: installed.</p></li>
1.128 wiz 6355: <li class="listitem">
1.88 wiz 6356: <p>If xpkgwedge is installed, it is possible to have some
6357: packages installed in <code class="varname">X11BASE</code> and some in
6358: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6359: installed package, the <code class="varname">EVAL_PREFIX</code>
6360: definition can be used. It takes pairs in the format
1.189 snj 6361: <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 6362: variable <code class="varname">DIRNAME</code> will be set to the prefix
6363: of the installed package <package>, or
1.128 wiz 6364: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6365: installed.</p>
1.75 rillig 6366: <p>This is best illustrated by example.</p>
6367: <p>The following lines are taken from
1.87 wiz 6368: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6369: <pre class="programlisting">
1.100 rillig 6370: EVAL_PREFIX+= GTKDIR=gtk+
6371: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6372: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6373: CONFIGURE_ARGS+= --enable-multibyte
6374: </pre>
1.88 wiz 6375: <p>Specific defaults can be defined for the packages
6376: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6377: definition of the form:</p>
1.75 rillig 6378: <pre class="programlisting">
1.100 rillig 6379: GTKDIR_DEFAULT= ${LOCALBASE}
6380: </pre>
1.75 rillig 6381: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6382: to the first definition in
6383: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6384: </li>
1.128 wiz 6385: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.189 snj 6386: 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 6387: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6388: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6389: </ul></div>
6390: </div>
1.148 asau 6391: <div class="sect1">
1.75 rillig 6392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6393: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6394: <p>When building a package, various directories are used to store
1.87 wiz 6395: source files, temporary files, pkgsrc-internal files, and so on. These
6396: directories are explained here.</p>
1.75 rillig 6397: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6398: are two common base directories for these relative directories:
6399: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6400: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6401: inside the package itself.</p>
1.148 asau 6402: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6403: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6404: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6405: root directory. Generally, you don't need
6406: it.</p></dd>
1.97 rillig 6407: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6408: <dd><p>This is an absolute pathname that points to the
6409: current package.</p></dd>
1.75 rillig 6410: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6411: <dd><p>This is a pathname relative to
1.87 wiz 6412: <code class="varname">PKGSRCDIR</code> that points to the current
6413: package.</p></dd>
1.75 rillig 6414: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6415: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6416: where all work takes place. The distfiles are extracted to this
1.87 wiz 6417: directory. It also contains temporary directories and log files used by
6418: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6419: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6420: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6421: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6422: where the distfiles are extracted. It is usually a direct subdirectory
6423: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6424: that isn't hidden. This variable may be changed by a package
6425: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6426: </dl></div>
1.114 jmcneill 6427: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6428: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6429: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6430: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6431: If users would like to have their pkgsrc trees behave in a
6432: read-only manner, then the value of
6433: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6434: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6435: </div>
1.148 asau 6436: <div class="sect1">
1.75 rillig 6437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6438: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6439: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6440: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6441: phase. This will automatically run all phases that are required for this
6442: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6443: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6444: the package will be built, but not installed.</p>
1.75 rillig 6445: </div>
1.148 asau 6446: <div class="sect1">
1.75 rillig 6447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6448: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6449: <p>The first step in building a package is to fetch the
1.88 wiz 6450: distribution files (distfiles) from the sites that are providing
6451: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6452: phase.</p>
1.148 asau 6453: <div class="sect2">
1.81 rillig 6454: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6455: <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 6456: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6457: defines all URLs from where the distfile, whose name is
6458: derived from the <code class="varname">DISTNAME</code> variable, is
6459: fetched. The more complicated cases are described
6460: below.</p>
6461: <p>The variable <code class="varname">DISTFILES</code> specifies
6462: the list of distfiles that have to be fetched. Its value
1.174 asau 6463: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6464: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 6465: so that most packages don't need to define it at all.
6466: <code class="varname">EXTRACT_SUFX</code> is
6467: <code class="literal">.tar.gz</code> by default, but can be changed
6468: freely. Note that if your package requires additional
6469: distfiles to the default one, you cannot just append the
6470: additional filenames using the <code class="literal">+=</code>
6471: operator, but you have write for example:</p>
1.81 rillig 6472: <pre class="programlisting">
1.174 asau 6473: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 6474: </pre>
1.88 wiz 6475: <p>Each distfile is fetched from a list of sites, usually
6476: <code class="varname">MASTER_SITES</code>. If the package has multiple
6477: <code class="varname">DISTFILES</code> or multiple
6478: <code class="varname">PATCHFILES</code> from different sites, you can
6479: set
6480: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6481: to the list of URLs where the file
6482: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6483: (including the suffix) can be found.</p>
6484: <pre class="programlisting">
1.100 rillig 6485: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6486: DISTFILES+= foo-file.tar.gz
6487: SITES.foo-file.tar.gz= \
6488: http://www.somewhere.com/somehow/ \
6489: http://www.somewhereelse.com/mirror/somehow/
6490: </pre>
1.81 rillig 6491: <p>When actually fetching the distfiles, each item from
1.88 wiz 6492: <code class="varname">MASTER_SITES</code> or
6493: <code class="varname">SITES.*</code> gets the name of each distfile
6494: appended to it, without an intermediate slash. Therefore,
6495: all site values have to end with a slash or other separator
6496: character. This allows for example to set
6497: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6498: that gets the name of the distfile as a parameter. In this
6499: case, the definition would look like:</p>
1.81 rillig 6500: <pre class="programlisting">
1.100 rillig 6501: MASTER_SITES= http://www.example.com/download.cgi?file=
6502: </pre>
1.125 wiz 6503: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 6504: In that case the URL is taken as is, fetched and the result
6505: stored under the name of the distfile. You can use this style
6506: for the case when the download URL style does not match the
6507: above common case. For example, if permanent download URL is a
6508: redirector to the real download URL, or the download file name
6509: is offered by an HTTP Content-Disposition header. In the
6510: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6511: created instead of the default
6512: <code class="filename">v1.0.0.tar.gz</code>.</p>
6513: <pre class="programlisting">
6514: DISTNAME= foo-1.0.0
6515: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6516: </pre>
1.81 rillig 6517: <p>There are some predefined values for
1.88 wiz 6518: <code class="varname">MASTER_SITES</code>, which can be used in
6519: packages. The names of the variables should speak for
6520: themselves.</p>
6521: <pre class="programlisting">
1.100 rillig 6522: ${MASTER_SITE_APACHE}
6523: ${MASTER_SITE_BACKUP}
6524: ${MASTER_SITE_CYGWIN}
6525: ${MASTER_SITE_DEBIAN}
6526: ${MASTER_SITE_FREEBSD}
6527: ${MASTER_SITE_FREEBSD_LOCAL}
6528: ${MASTER_SITE_GENTOO}
6529: ${MASTER_SITE_GNOME}
6530: ${MASTER_SITE_GNU}
6531: ${MASTER_SITE_GNUSTEP}
1.174 asau 6532: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 6533: ${MASTER_SITE_IFARCHIVE}
6534: ${MASTER_SITE_KDE}
6535: ${MASTER_SITE_MOZILLA}
1.174 asau 6536: ${MASTER_SITE_MOZILLA_ALL}
6537: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 6538: ${MASTER_SITE_MYSQL}
1.174 asau 6539: ${MASTER_SITE_NETLIB}
1.100 rillig 6540: ${MASTER_SITE_OPENOFFICE}
6541: ${MASTER_SITE_PERL_CPAN}
6542: ${MASTER_SITE_PGSQL}
1.174 asau 6543: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 6544: ${MASTER_SITE_R_CRAN}
6545: ${MASTER_SITE_SOURCEFORGE}
6546: ${MASTER_SITE_SOURCEFORGE_JP}
6547: ${MASTER_SITE_SUNSITE}
6548: ${MASTER_SITE_SUSE}
6549: ${MASTER_SITE_TEX_CTAN}
6550: ${MASTER_SITE_XCONTRIB}
6551: ${MASTER_SITE_XEMACS}
1.174 asau 6552: ${MASTER_SITE_XORG}
1.100 rillig 6553: </pre>
1.88 wiz 6554: <p>Some explanations for the less self-explaining ones:
6555: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6556: 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 6557: 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 6558: <p>If you choose one of these predefined sites, you may
6559: want to specify a subdirectory of that site. Since these
6560: macros may expand to more than one actual site, you
6561: <span class="emphasis"><em>must</em></span> use the following construct to
6562: specify a subdirectory:</p>
1.81 rillig 6563: <pre class="programlisting">
1.100 rillig 6564: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6565: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6566: </pre>
1.81 rillig 6567: <p>Note the trailing slash after the subdirectory
1.88 wiz 6568: name.</p>
1.81 rillig 6569: </div>
1.148 asau 6570: <div class="sect2">
1.81 rillig 6571: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6572: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6573: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6574: all the distfiles exist in a local directory
1.93 rillig 6575: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6576: user). If the files do not exist, they are fetched using
6577: commands of the form</p>
1.75 rillig 6578: <pre class="programlisting">
1.100 rillig 6579: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6580: </pre>
1.88 wiz 6581: <p>where <code class="literal">${site}</code> varies through
6582: several possibilities in turn: first,
6583: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6584: sites specified in either <code class="varname">SITES.file</code> if
6585: defined, else <code class="varname">MASTER_SITES</code> or
6586: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6587: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6588: all except the first and the last can be optionally sorted
6589: by the user, via setting either
6590: <code class="varname">MASTER_SORT_RANDOM</code>, and
6591: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6592: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6593: <p> The specific command and arguments used depend on the
6594: <code class="varname">FETCH_USING</code> parameter. The example above is
6595: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6596: <p>The distfiles mirror run by the NetBSD Foundation uses the
6597: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6598: distfiles, if they are freely distributable. Packages setting
6599: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6600: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6601: mirrored.</p>
1.81 rillig 6602: </div>
1.75 rillig 6603: </div>
1.148 asau 6604: <div class="sect1">
1.75 rillig 6605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6606: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6607: <p>After the distfile(s) are fetched, their checksum is
6608: generated and compared with the checksums stored in the
6609: distinfo file. If the checksums don't match, the build is
6610: aborted. This is to ensure the same distfile is used for
6611: building, and that the distfile wasn't changed, e.g. by some
6612: malign force, deliberately changed distfiles on the master
6613: distribution site or network lossage.</p>
1.75 rillig 6614: </div>
1.148 asau 6615: <div class="sect1">
1.75 rillig 6616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6617: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6618: <p>When the distfiles are present on the local system, they
1.88 wiz 6619: need to be extracted, as they usually come in the form of some
6620: compressed archive format.</p>
1.75 rillig 6621: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6622: extracted. If you only need some of them, you can set the
6623: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6624: files.</p>
6625: <p>Extracting the files is usually done by a little
1.93 rillig 6626: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6627: already knows how to extract various archive formats, so most
6628: likely you will not need to change anything here. But if you
6629: need, the following variables may help you:</p>
1.148 asau 6630: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6631: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6632: <dd><p>Use these variables to override the default
1.88 wiz 6633: options for an extract command, which are defined in
1.93 rillig 6634: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6635: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6636: <dd><p>This variable can be set to
1.114 jmcneill 6637: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6638: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6639: absolute pathname pointing to the command with which tar
1.114 jmcneill 6640: archives should be extracted. It is preferred to choose bsdtar over gtar
6641: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6642: </dl></div>
1.88 wiz 6643: <p>If the <code class="filename">extract</code> program doesn't
6644: serve your needs, you can also override the
6645: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6646: command used for extracting the files. This command is
6647: executed in the <code class="filename">${WRKSRC}</code>
6648: directory. During execution of this command, the shell
6649: variable <code class="varname">extract_file</code> holds the absolute
6650: pathname of the file that is going to be extracted.</p>
1.75 rillig 6651: <p>And if that still does not suffice, you can override the
1.88 wiz 6652: <code class="varname">do-extract</code> target in the package
6653: Makefile.</p>
1.75 rillig 6654: </div>
1.148 asau 6655: <div class="sect1">
1.75 rillig 6656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6657: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6658: <p>After extraction, all the patches named by the
1.88 wiz 6659: <code class="varname">PATCHFILES</code>, those present in the patches
6660: subdirectory of the package as well as in
6661: $LOCALPATCHES/$PKGPATH (e.g.
6662: <code class="filename">/usr/local/patches/graphics/png</code>) are
6663: applied. Patchfiles ending in <code class="filename">.Z</code> or
6664: <code class="filename">.gz</code> are uncompressed before they are
6665: applied, files ending in <code class="filename">.orig</code> or
6666: <code class="filename">.rej</code> are ignored. Any special options to
1.189 snj 6667: <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 6668: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more details.</p>
1.189 snj 6669: <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 6670: it fail if the patches apply with some lines of fuzz. Please
6671: fix (regen) the patches so that they apply cleanly. The
6672: rationale behind this is that patches that don't apply cleanly
6673: may end up being applied in the wrong place, and cause severe
6674: harm there.</p>
1.75 rillig 6675: </div>
1.148 asau 6676: <div class="sect1">
1.75 rillig 6677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6678: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6679: <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 6680: </p>
1.75 rillig 6681: </div>
1.148 asau 6682: <div class="sect1">
1.75 rillig 6683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6684: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6685: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6686: linkers. The following variables can be used to tweak the
6687: wrappers.</p>
1.148 asau 6688: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6689: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6690: <dd><p>The command used to print progress
1.88 wiz 6691: messages. Does nothing by default. Set to
6692: <code class="literal">${ECHO}</code> to see the progress
6693: messages.</p></dd>
1.75 rillig 6694: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6695: <dd><p>This variable can be set to
1.88 wiz 6696: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6697: depending on whether you want additional information in the
6698: wrapper log file.</p></dd>
1.75 rillig 6699: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6700: <dd><p>This variable can be set to
1.88 wiz 6701: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6702: on whether the wrapper should use its cache, which will
6703: improve the speed. The default value is
6704: <code class="literal">yes</code>, but is forced to
6705: <code class="literal">no</code> if the platform does not support
6706: it.</p></dd>
1.75 rillig 6707: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6708: <dd><p>A list of reordering commands. A reordering
6709: command has the form
6710: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6711: It ensures that that
6712: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6713: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6714: </p></dd>
1.75 rillig 6715: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6716: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6717: investigate further]</p></dd>
1.75 rillig 6718: </dl></div>
6719: </div>
1.148 asau 6720: <div class="sect1">
1.75 rillig 6721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6722: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6723: <p>Most pieces of software need information on the header
6724: files, system calls, and library routines which are available
6725: on the platform they run on. The process of determining this
6726: information is known as configuration, and is usually
6727: automated. In most cases, a script is supplied with the
6728: distfiles, and its invocation results in generation of header
6729: files, Makefiles, etc.</p>
6730: <p>If the package contains a configure script, this can be
6731: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6732: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6733: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6734: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6735: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6736: <pre class="programlisting">
1.100 rillig 6737: .for d in ${CONFIGURE_DIRS}
6738: cd ${WRKSRC} \
6739: && cd ${d} \
6740: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6741: .endfor
6742: </pre>
1.88 wiz 6743: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6744: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6745: <code class="varname">WRKSRC</code>. In each of these directories, the
6746: configure script is run with the environment
6747: <code class="varname">CONFIGURE_ENV</code> and arguments
6748: <code class="varname">CONFIGURE_ARGS</code>. The variables
6749: <code class="varname">CONFIGURE_ENV</code>,
6750: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6751: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6752: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6753: package.</p>
1.144 wiz 6754: <p>If the program uses the Perl way of configuration (mainly Perl
6755: modules, but not only), i.e. a file called
6756: <code class="filename">Makefile.PL</code>, it should include
6757: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6758: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6759: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6760: <p>If the program uses an <code class="filename">Imakefile</code>
6761: for configuration, the appropriate steps can be invoked by
6762: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6763: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6764: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6765: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6766: xmkmf's environment by adding them to the
6767: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6768: <p>If the program uses <code class="filename">cmake</code>
6769: for configuration, the appropriate steps can be invoked by
1.128 wiz 6770: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6771: You can add variables to cmake's environment by adding them to the
6772: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6773: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6774: The top directory argument is given by the
6775: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6776: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6777: <p>If there is no configure step at all, set
1.128 wiz 6778: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6779: </div>
1.148 asau 6780: <div class="sect1">
1.75 rillig 6781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6782: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6783: <p>For building a package, a rough equivalent of the
6784: following code is executed.</p>
1.75 rillig 6785: <pre class="programlisting">
1.100 rillig 6786: .for d in ${BUILD_DIRS}
6787: cd ${WRKSRC} \
6788: && cd ${d} \
6789: && env ${MAKE_ENV} \
6790: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6791: -f ${MAKE_FILE} \
6792: ${BUILD_TARGET}
6793: .endfor
6794: </pre>
1.88 wiz 6795: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6796: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6797: <code class="varname">WRKSRC</code>. In each of these directories,
6798: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6799: <code class="varname">MAKE_ENV</code> and arguments
6800: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6801: <code class="varname">MAKE_ENV</code>,
6802: <code class="varname">BUILD_MAKE_FLAGS</code>,
6803: <code class="varname">MAKE_FILE</code> and
6804: <code class="varname">BUILD_TARGET</code> may all be changed by the
6805: package.</p>
1.75 rillig 6806: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6807: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6808: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6809: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6810: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6811: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6812: <p>If there is no build step at all, set
1.128 wiz 6813: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6814: </div>
1.148 asau 6815: <div class="sect1">
1.75 rillig 6816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6817: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6818: <p>[TODO]</p>
6819: </div>
1.148 asau 6820: <div class="sect1">
1.75 rillig 6821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6822: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6823: <p>Once the build stage has completed, the final step is to
1.88 wiz 6824: install the software in public directories, so users can
6825: access the programs and files.</p>
1.75 rillig 6826: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6827: equivalent of the following code is executed. Additionally,
6828: before and after this code, much magic is performed to do
6829: consistency checks, registering the package, and so on.</p>
6830: <pre class="programlisting">
1.100 rillig 6831: .for d in ${INSTALL_DIRS}
6832: cd ${WRKSRC} \
6833: && cd ${d} \
6834: && env ${MAKE_ENV} \
6835: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6836: -f ${MAKE_FILE} \
6837: ${INSTALL_TARGET}
6838: .endfor
6839: </pre>
1.75 rillig 6840: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6841: <span class="emphasis"><em>build</em></span> phase.
6842: <code class="varname">INSTALL_DIRS</code> defaults to
6843: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6844: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6845: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6846: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6847: defined.</p>
1.75 rillig 6848: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6849: variables are useful. They are all variations of the
1.189 snj 6850: <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 6851: permissions preset. <code class="varname">INSTALL</code> is the plain
6852: install command. The specialized variants, together with their
6853: intended use, are:</p>
1.148 asau 6854: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6855: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6856: <dd><p>directories that contain
6857: binaries</p></dd>
1.75 rillig 6858: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6859: <dd><p>directories that contain
6860: scripts</p></dd>
1.75 rillig 6861: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6862: <dd><p>directories that contain shared and static
6863: libraries</p></dd>
1.75 rillig 6864: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6865: <dd><p>directories that contain data
6866: files</p></dd>
1.75 rillig 6867: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6868: <dd><p>directories that contain man
6869: pages</p></dd>
1.75 rillig 6870: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6871: <dd><p>binaries that can be stripped from debugging
6872: symbols</p></dd>
1.75 rillig 6873: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6874: <dd><p>binaries that cannot be
6875: stripped</p></dd>
1.75 rillig 6876: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6877: <dd><p>game
6878: binaries</p></dd>
1.75 rillig 6879: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6880: <dd><p>shared and static
6881: libraries</p></dd>
1.75 rillig 6882: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6883: <dd><p>data files</p></dd>
6884: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6885: <dd><p>data files for
6886: games</p></dd>
1.75 rillig 6887: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6888: <dd><p>man pages</p></dd>
6889: </dl></div>
6890: <p>Some other variables are:</p>
1.148 asau 6891: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6892: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6893: <dd><p>A list of directories relative to
1.88 wiz 6894: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6895: beginning of the <span class="emphasis"><em>install</em></span> phase.
6896: The package is supposed to create all needed directories itself
6897: before installing files to it and list all other directories here.
6898: </p></dd>
1.75 rillig 6899: </dl></div>
1.97 rillig 6900: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6901: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6902: mostly relevant for packages in the <code class="filename">regress</code>
6903: category.</p>
1.75 rillig 6904: </div>
1.148 asau 6905: <div class="sect1">
1.75 rillig 6906: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6907: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6908: <p>Once the install stage has completed, a binary package of
6909: the installed files can be built. These binary packages can be
6910: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6911: the <span class="command"><strong>make bin-install</strong></span> or by using
6912: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6913: <p>By default, the binary packages are created in
6914: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6915: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6916: one for each category in the <code class="varname">CATEGORIES</code>
6917: variable. <code class="varname">PACKAGES</code> defaults to
6918: <code class="filename">pkgsrc/packages</code>.</p>
6919: </div>
1.148 asau 6920: <div class="sect1">
1.88 wiz 6921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6922: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6923: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6924: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6925: to clean the work directories of all dependencies too, use
1.110 hubertf 6926: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6927: </div>
1.148 asau 6928: <div class="sect1">
1.75 rillig 6929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6930: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6931: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6932: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6933: <dd><p>For any of the main targets described in the
6934: previous section, two auxiliary targets exist with
1.128 wiz 6935: <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 6936: prefix for the main target's name. These targets are
1.88 wiz 6937: invoked before and after the main target is called,
6938: allowing extra configuration or installation steps be
6939: performed from a package's Makefile, for example, which
6940: a program's configure script or install target
6941: omitted.</p></dd>
1.75 rillig 6942: <dt><span class="term">do-*</span></dt>
1.88 wiz 6943: <dd><p>Should one of the main targets do the wrong thing,
6944: and should there be no variable to fix this, you can
6945: redefine it with the do-* target. (Note that redefining
6946: the target itself instead of the do-* target is a bad
6947: idea, as the pre-* and post-* targets won't be called
6948: anymore, etc.) You will not usually need to do
6949: this.</p></dd>
1.75 rillig 6950: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6951: <dd>
1.110 hubertf 6952: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6953: you noticed some file was not installed properly, you
6954: can repeat the installation with this target, which will
1.128 wiz 6955: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6956: <p>This is the default value of
6957: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6958: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6959: package</strong></span>, where the defaults are
1.128 wiz 6960: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6961: respectively.</p>
6962: </dd>
1.75 rillig 6963: <dt><span class="term">deinstall</span></dt>
6964: <dd>
1.189 snj 6965: <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 6966: current directory, effectively de-installing the
6967: package. The following variables can be used to tune the
6968: behaviour:</p>
1.148 asau 6969: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6970: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.189 snj 6971: <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 6972: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6973: <dd><p>Remove all packages that require (depend on)
6974: the given package. This can be used to remove any
6975: packages that may have been pulled in by a given
1.110 hubertf 6976: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6977: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6978: <code class="filename">pkgsrc/x11/kde</code>, this is
6979: likely to remove whole KDE. Works by adding
1.189 snj 6980: <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 6981: command line.</p></dd>
1.75 rillig 6982: </dl></div>
6983: </dd>
1.88 wiz 6984: <dt><span class="term">bin-install</span></dt>
6985: <dd><p>Install a binary package from local disk and via FTP
6986: from a list of sites (see the
6987: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6988: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6989: available anywhere. The arguments given to
1.110 hubertf 6990: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6991: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6992: operation, etc.</p></dd>
1.75 rillig 6993: <dt><span class="term">update</span></dt>
6994: <dd>
1.88 wiz 6995: <p>This target causes the current package to be
6996: updated to the latest version. The package and all
6997: depending packages first get de-installed, then current
6998: versions of the corresponding packages get compiled and
6999: installed. This is similar to manually noting which
7000: packages are currently installed, then performing a
1.110 hubertf 7001: series of <span class="command"><strong>make deinstall</strong></span> and
7002: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7003: <code class="varname">UPDATE_TARGET</code> is set to) for these
7004: packages.</p>
1.128 wiz 7005: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 7006: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7007: update</strong></span> was interrupted for some reason.
7008: However, in this case, make sure you don't call
1.110 hubertf 7009: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7010: list of dependent packages in <code class="varname">WRKDIR</code>.
7011: Otherwise, you lose the ability to automatically update
7012: the current package along with the dependent packages
7013: you have installed.</p>
1.110 hubertf 7014: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7015: update</strong></span> will only work as long as the package
7016: tree remains unchanged. If the source code for one of
7017: the packages to be updated has been changed, resuming
1.110 hubertf 7018: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7019: fail!</p>
7020: <p>The following variables can be used either on the
1.110 hubertf 7021: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7022: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7023: update</strong></span>:</p>
1.148 asau 7024: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7025: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7026: <dd><p>Install target to recursively use for the
7027: updated package and the dependent packages.
7028: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7029: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7030: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7031: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7032: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7033: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7034: endless loop!</p></dd>
1.75 rillig 7035: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7036: <dd><p>Don't clean up after updating. Useful if
7037: you want to leave the work sources of the updated
7038: packages around for inspection or other purposes.
7039: Be sure you eventually clean up the source tree
1.128 wiz 7040: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7041: or you may run into troubles with old source code
7042: still lying around on your next
1.110 hubertf 7043: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7044: update</strong></span>.</p></dd>
1.75 rillig 7045: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7046: <dd><p>Deinstall each package before installing
7047: (making <code class="varname">DEPENDS_TARGET</code>). This
7048: may be necessary if the
1.128 wiz 7049: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7050: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7051: update</strong></span>.</p></dd>
1.75 rillig 7052: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7053: <dd><p>Allows you to disable recursion and hardcode
7054: the target for packages. The default is
1.128 wiz 7055: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7056: facilitating a recursive update of prerequisite
7057: packages. Only set
7058: <code class="varname">DEPENDS_TARGET</code> if you want to
7059: disable recursive updates. Use
7060: <code class="varname">UPDATE_TARGET</code> instead to just
7061: set a specific target for each package to be
1.110 hubertf 7062: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7063: (see above).</p></dd>
1.75 rillig 7064: </dl></div>
7065: </dd>
7066: <dt><span class="term">clean-update</span></dt>
7067: <dd>
1.88 wiz 7068: <p>Clean the source tree for all packages that would
1.110 hubertf 7069: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7070: from the current directory. This target should not be
7071: used if the current package (or any of its depending
7072: packages) have already been de-installed (e.g., after
1.110 hubertf 7073: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7074: some packages you intended to update. As a rule of
7075: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7076: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7077: and only if you have a dirty package tree (e.g., if you
7078: used <code class="varname">NOCLEAN</code>).</p>
7079: <p>If you are unsure about whether your tree is
1.110 hubertf 7080: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7081: clean</strong></span> at the top of the tree, or use the
7082: following sequence of commands from the directory of the
7083: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7084: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7085: time, otherwise you lose all the packages you wanted to
7086: update!):</p>
1.87 wiz 7087: <pre class="screen">
7088: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7089: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7090: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7091: </pre>
1.88 wiz 7092: <p>The following variables can be used either on the
1.110 hubertf 7093: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7094: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 7095: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7096: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7097: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7098: reconstruct the list of directories to update for
1.110 hubertf 7099: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7100: update</strong></span> successfully installed all
7101: packages you wanted to update. Normally, this is
1.110 hubertf 7102: done automatically on <span class="command"><strong>make
1.88 wiz 7103: update</strong></span>, but may have been suppressed by
7104: the <code class="varname">NOCLEAN</code> variable (see
7105: above).</p></dd>
1.75 rillig 7106: </dl></div>
7107: </dd>
1.88 wiz 7108: <dt><span class="term">replace</span></dt>
7109: <dd>
7110: <p>Update the installation of the current package. This
7111: differs from update in that it does not replace dependent
1.189 snj 7112: 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 7113: target to work.</p>
7114: <p><span class="emphasis"><em>Be careful when using this
7115: target!</em></span> There are no guarantees that dependent
7116: packages will still work, in particular they will most
1.110 hubertf 7117: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7118: library package whose shared library major version changed
7119: between your installed version and the new one. For this
7120: reason, this target is not officially supported and only
7121: recommended for advanced users.</p>
7122: </dd>
1.75 rillig 7123: <dt><span class="term">info</span></dt>
1.189 snj 7124: <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 7125: package. You can use this to check which version of a
7126: package is installed.</p></dd>
7127: <dt><span class="term">index</span></dt>
7128: <dd>
7129: <p>This is a top-level command, i.e. it should be used in
7130: the <code class="filename">pkgsrc</code> directory. It creates a
7131: database of all packages in the local pkgsrc tree, including
7132: dependencies, comment, maintainer, and some other useful
7133: information. Individual entries are created by running
1.110 hubertf 7134: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7135: directories. This index file is saved as
7136: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7137: verbose format by running <span class="command"><strong>make
1.88 wiz 7138: print-index</strong></span>. You can search in it with
1.110 hubertf 7139: <span class="command"><strong>make search
1.88 wiz 7140: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7141: extract a list of all packages that depend on a particular
1.110 hubertf 7142: one by running <span class="command"><strong>make show-deps
1.88 wiz 7143: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7144: <p>Running this command takes a very long time, some
7145: hours even on fast machines!</p>
7146: </dd>
1.75 rillig 7147: <dt><span class="term">readme</span></dt>
1.88 wiz 7148: <dd>
7149: <p>This target generates a
7150: <code class="filename">README.html</code> file, which can be
1.189 snj 7151: 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 7152: contain references to any packages which are in the
7153: <code class="varname">PACKAGES</code> directory on the local
7154: host. The generated files can be made to refer to URLs
7155: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7156: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7157: wanted to generate <code class="filename">README.html</code>
7158: files which pointed to binary packages on the local
7159: machine, in the directory
7160: <code class="filename">/usr/packages</code>, set
7161: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7162: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7163: <code class="varname">${PACKAGES}</code> directory and its
7164: subdirectories will be searched for all the binary
7165: packages.</p>
7166: <p>The target can be run at the toplevel or in category
7167: directories, in which case it descends recursively.</p>
7168: </dd>
1.75 rillig 7169: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7170: <dd><p>This is a top-level command, run it in
7171: <code class="filename">pkgsrc</code>. Use this target to create a
7172: file <code class="filename">README-all.html</code> which contains a
7173: list of all packages currently available in the NetBSD
7174: Packages Collection, together with the category they belong
7175: to and a short description. This file is compiled from the
7176: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7177: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7178: readme</strong></span>.</p></dd>
1.75 rillig 7179: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7180: <dd><p>This is very much the same as the
1.128 wiz 7181: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7182: used when generating a pkgsrc tree to be written to a
7183: CD-ROM. This target also produces
7184: <code class="filename">README.html</code> files, and can be made
7185: to refer to URLs based on
7186: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7187: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7188: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7189: <dd><p>This target shows which distfiles and patchfiles
7190: are needed to build the package
7191: (<code class="varname">ALLFILES</code>, which contains all
7192: <code class="varname">DISTFILES</code> and
1.87 wiz 7193: <code class="varname">PATCHFILES</code>, but not
7194: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7195: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7196: <dd><p>This target shows nothing if the package is not
7197: installed. If a version of this package is installed,
7198: but is not the version provided in this version of
7199: pkgsrc, then a warning message is displayed. This target
7200: can be used to show which of your installed packages are
7201: downlevel, and so the old versions can be deleted, and
7202: the current ones added.</p></dd>
1.75 rillig 7203: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7204: <dd><p>This target shows the directory in the pkgsrc
7205: hierarchy from which the package can be built and
7206: installed. This may not be the same directory as the one
7207: from which the package was installed. This target is
7208: intended to be used by people who may wish to upgrade
7209: many packages on a single host, and can be invoked from
7210: the top-level pkgsrc Makefile by using the
1.128 wiz 7211: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7212: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7213: <dd><p>This target shows which installed packages match
7214: the current package's <code class="varname">DEPENDS</code>. Useful
7215: if out of date dependencies are causing build
7216: problems.</p></dd>
1.75 rillig 7217: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7218: <dd><p>After a package is installed, check all its
7219: binaries and (on ELF platforms) shared libraries to see
7220: if they find the shared libs they need. Run by default
1.110 hubertf 7221: 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 7222: <dt><span class="term">print-PLIST</span></dt>
7223: <dd>
1.128 wiz 7224: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7225: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7226: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7227: -newer work/.extract_done</strong></span>. An attempt is made
7228: to care for shared libs etc., but it is
1.87 wiz 7229: <span class="emphasis"><em>strongly</em></span> recommended to review the
7230: result before putting it into
7231: <code class="filename">PLIST</code>. On upgrades, it's useful to
7232: diff the output of this command against an already
7233: existing <code class="filename">PLIST</code> file.</p>
1.189 snj 7234: <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 7235: other methods that don't update file access times, be
7236: sure to add these files manually to your
1.128 wiz 7237: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7238: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7239: them!</p>
1.128 wiz 7240: <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 7241: information on this target.</p>
1.75 rillig 7242: </dd>
7243: <dt><span class="term">bulk-package</span></dt>
7244: <dd>
1.88 wiz 7245: <p>Used to do bulk builds. If an appropriate binary
7246: package already exists, no action is taken. If not, this
7247: target will compile, install and package it (and its
7248: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 7249: 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
7250: builds)</i></a>).
1.88 wiz 7251: After creating the binary package, the sources, the
7252: just-installed package and its required packages are
7253: removed, preserving free disk space.</p>
7254: <p><span class="emphasis"><em>Beware that this target may deinstall
7255: all packages installed on a system!</em></span></p>
1.75 rillig 7256: </dd>
7257: <dt><span class="term">bulk-install</span></dt>
7258: <dd>
1.88 wiz 7259: <p>Used during bulk-installs to install required
7260: packages. If an up-to-date binary package is available,
1.189 snj 7261: 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 7262: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7263: but the installed binary won't be removed.</p>
1.88 wiz 7264: <p>A binary package is considered
1.128 wiz 7265: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.189 snj 7266: <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 7267: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7268: <li class="listitem"><p>None of the package's files
1.88 wiz 7269: (<code class="filename">Makefile</code>, ...) were modified
7270: since it was built.</p></li>
1.128 wiz 7271: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7272: packages were modified since it was built.</p></li>
1.75 rillig 7273: </ul></div>
1.88 wiz 7274: <p><span class="emphasis"><em>Beware that this target may deinstall
7275: all packages installed on a system!</em></span></p>
1.75 rillig 7276: </dd>
7277: </dl></div>
7278: </div>
7279: </div>
1.148 asau 7280: <div class="chapter">
1.75 rillig 7281: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7282: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7283: <div class="toc">
7284: <p><b>Table of Contents</b></p>
1.195 wiz 7285: <dl class="toc">
1.106 rillig 7286: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7287: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7288: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7289: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7290: </dl>
7291: </div>
1.87 wiz 7292: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7293: by pkgsrc and also for individual packages to define what commands
7294: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7295: or for later run-time of an installed packaged (such as
7296: <code class="varname">DEPENDS</code>).
7297: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7298: package will not be used.</p>
7299: <p>When building a package, the replacement tools are
1.75 rillig 7300: made available in a directory (as symlinks or wrapper scripts)
7301: that is early in the executable search path. Just like the buildlink
1.87 wiz 7302: system, this helps with consistent builds.</p>
7303: <p>A tool may be needed to help build a specific package. For example,
7304: perl, GNU make (gmake) or yacc may be needed.</p>
7305: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7306: tool may be inefficient for building a package with pkgsrc.
7307: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7308: yacc) or a better sed.</p>
7309: <p>The tools used by a package can be listed by running
1.110 hubertf 7310: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 7311: <div class="sect1">
1.75 rillig 7312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7313: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7314: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7315: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7316: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7317: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7318: These can be seen by running:
1.110 hubertf 7319: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7320: <p>If a package needs a specific program to build
1.75 rillig 7321: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7322: to define the tools needed.</p>
1.75 rillig 7323: </div>
1.148 asau 7324: <div class="sect1">
1.75 rillig 7325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7326: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7327: <p>In the following examples, the :run means that it is needed at
7328: run-time (and becomes a DEPENDS).
1.75 rillig 7329: The default is a build dependency which can be set with
7330: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7331: and pkg-config:build.)</p>
1.75 rillig 7332: <pre class="programlisting">
7333: USE_TOOLS+= gmake perl:run pkg-config
7334: </pre>
1.87 wiz 7335: <p>When using the tools framework, a
1.75 rillig 7336: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7337: which contains the full path to the appropriate tool. For example,
1.128 wiz 7338: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7339: on Linux systems.</p>
7340: <p>If you always need a pkgsrc version of the
1.75 rillig 7341: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7342: </p>
7343: </div>
1.148 asau 7344: <div class="sect1">
1.75 rillig 7345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7346: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7347: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7348: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7349: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7350: the name of the common tools. For example:</p>
7351: <pre class="programlisting">
7352: .if exists(/usr/bin/bzcat)
7353: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7354: .elif exists(/usr/bin/bzip2)
7355: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7356: .endif
1.69 rillig 7357:
1.75 rillig 7358: TOOLS_PLATFORM.true?= true # shell builtin
7359: </pre>
7360: </div>
1.148 asau 7361: <div class="sect1">
1.97 rillig 7362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7363: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 asau 7364: <div class="qandaset">
1.200 ! tnn 7365: <a name="idm73164880"></a><dl>
1.106 rillig 7366: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7367: </dt>
1.106 rillig 7368: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7369: tools?</a>
7370: </dt>
1.106 rillig 7371: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7372: package is using while being built? I want to know whether it
7373: uses sed or not.</a>
7374: </dt>
7375: </dl>
1.148 asau 7376: <table border="0" style="width: 100%;">
7377: <colgroup>
1.97 rillig 7378: <col align="left" width="1%">
1.128 wiz 7379: <col>
1.148 asau 7380: </colgroup>
1.97 rillig 7381: <tbody>
1.148 asau 7382: <tr class="question">
1.97 rillig 7383: <td align="left" valign="top">
1.200 ! tnn 7384: <a name="tools.new"></a><a name="idm73164496"></a><p><b>18.4.1.</b></p>
1.97 rillig 7385: </td>
7386: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7387: </tr>
7388: <tr class="answer">
7389: <td align="left" valign="top"></td>
7390: <td align="left" valign="top"><p>TODO</p></td>
7391: </tr>
1.148 asau 7392: <tr class="question">
1.97 rillig 7393: <td align="left" valign="top">
1.200 ! tnn 7394: <a name="tools.listall"></a><a name="idm73163472"></a><p><b>18.4.2.</b></p>
1.97 rillig 7395: </td>
7396: <td align="left" valign="top"><p>How do I get a list of all available
7397: tools?</p></td>
7398: </tr>
7399: <tr class="answer">
7400: <td align="left" valign="top"></td>
7401: <td align="left" valign="top"><p>TODO</p></td>
7402: </tr>
1.148 asau 7403: <tr class="question">
1.97 rillig 7404: <td align="left" valign="top">
1.200 ! tnn 7405: <a name="tools.used"></a><a name="idm73162448"></a><p><b>18.4.3.</b></p>
1.97 rillig 7406: </td>
7407: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7408: package is using while being built? I want to know whether it
7409: uses sed or not.</p></td>
7410: </tr>
7411: <tr class="answer">
7412: <td align="left" valign="top"></td>
7413: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7414: to do it.)</p></td>
7415: </tr>
7416: </tbody>
7417: </table>
7418: </div>
7419: </div>
1.75 rillig 7420: </div>
1.148 asau 7421: <div class="chapter">
1.75 rillig 7422: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7423: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7424: <div class="toc">
7425: <p><b>Table of Contents</b></p>
1.195 wiz 7426: <dl class="toc">
1.106 rillig 7427: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7428: <dd><dl>
1.106 rillig 7429: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7430: <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 7431: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7432: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7433: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7434: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7435: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7436: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7437: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7438: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7439: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7440: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7441: </dl></dd>
1.128 wiz 7442: <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 7443: <dd><dl>
7444: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7445: <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>
1.199 tnn 7446: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106 rillig 7447: </dl></dd>
1.128 wiz 7448: <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 7449: <dd><dl>
7450: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7451: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7452: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7453: </dl></dd>
7454: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7455: <dd><dl>
7456: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7457: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7458: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7459: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7460: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7461: </dl></dd>
1.128 wiz 7462: <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 7463: <dd><dl>
7464: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7465: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7466: <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 7467: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7468: </dl></dd>
1.128 wiz 7469: <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 7470: <dd><dl>
7471: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7472: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7473: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7474: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7475: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7476: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7477: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7478: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7479: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7480: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7481: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7482: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7483: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7484: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7485: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7486: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7487: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7488: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7489: emulation</a></span></dt>
1.106 rillig 7490: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7491: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7492: </dl></dd>
1.106 rillig 7493: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7494: </dl>
7495: </div>
1.148 asau 7496: <div class="sect1">
1.75 rillig 7497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7498: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 asau 7499: <div class="sect2">
1.75 rillig 7500: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7501: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7502: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7503: different platforms. As a result, it is important to ensure,
7504: where possible, that packages in pkgsrc are portable. This
7505: chapter mentions some particular details you should pay
7506: attention to while working on pkgsrc.</p>
1.78 rillig 7507: </div>
1.148 asau 7508: <div class="sect2">
1.78 rillig 7509: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7510: <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 7511: </h3></div></div></div>
1.78 rillig 7512: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7513: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7514: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7515: want to use those variables in the preprocessor directives of
1.189 snj 7516: <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 7517: <code class="literal">.for</code>), you need to include the file
7518: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7519: loads the user preferences.</p>
1.78 rillig 7520: <p>But note that some variables may not be completely defined
1.87 wiz 7521: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7522: included, as they may contain references to variables that are
7523: not yet defined. In shell commands this is no problem, since
7524: variables are actually macros, which are only expanded when they
7525: are used. But in the preprocessor directives mentioned above and
7526: in dependency lines (of the form <code class="literal">target:
7527: dependencies</code>) the variables are expanded at load
7528: time.</p>
1.148 asau 7529: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7530: <h3 class="title">Note</h3>
7531: <p>Currently there is no exhaustive list of all
1.87 wiz 7532: variables that tells you whether they can be used at load time
7533: or only at run time, but it is in preparation.</p>
1.78 rillig 7534: </div>
7535: </div>
1.148 asau 7536: <div class="sect2">
1.78 rillig 7537: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7538: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7539: <p>Occasionally, packages require interaction from the user,
7540: and this can be in a number of ways:</p>
1.148 asau 7541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7542: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7543: interaction such as entering username/password or accepting a
7544: license on a web page.</p></li>
1.128 wiz 7545: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7546: passwords.</p></li>
1.128 wiz 7547: <li class="listitem"><p>help to configure the package before it is built</p></li>
7548: <li class="listitem"><p>help during the build process</p></li>
7549: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7550: </ul></div>
1.88 wiz 7551: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7552: provided to notify the pkgsrc mechanism of an interactive stage
7553: which will be needed, and this should be set in the package's
7554: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7555: <pre class="programlisting">
1.100 rillig 7556: INTERACTIVE_STAGE= build
1.87 wiz 7557: </pre>
1.78 rillig 7558: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7559: <pre class="programlisting">
1.100 rillig 7560: INTERACTIVE_STAGE= configure install
1.87 wiz 7561: </pre>
1.88 wiz 7562: <p>The user can then decide to skip this package by setting the
7563: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7564: </div>
1.148 asau 7565: <div class="sect2">
1.75 rillig 7566: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7567: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7568: <p>Authors of software can choose the licence under which
7569: software can be copied. This is due to copyright law, and reasons
7570: for license choices are outside the scope of pkgsrc. The pkgsrc
7571: system recognizes that there are a number of licenses which some
7572: users may find objectionable or difficult or impossible to comply
7573: with. The Free Software Foundation has declared some licenses
7574: "Free", and the Open Source Initiative has a definition of "Open
7575: Source". The pkgsrc system, as a policy choice, does not label
7576: packages which have licenses that are Free or Open Source.
7577: However, packages without a license meeting either of those tests
7578: are labeled with a license tag denoting the license. Note that a
7579: package with no license to copy trivially does not meet either the
7580: Free or Open Source test.</p>
7581: <p>For packages which are not Free or Open Source, pkgsrc will
7582: not build the package unless the user has indicated to pkgsrc that
7583: packages with that particular license may be built. Note that
7584: this documentation avoids the term "accepted the license". The
7585: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7586: accidentally building a package with a non-free license;
1.98 wiz 7587: judgement and responsibility remain with the user. (Installation
7588: of binary packages are not currently subject to this mechanism;
7589: this is a bug.)</p>
7590: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7591: or the GPL, and not the other. The free licenses are added to the
7592: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7593: user can override the default by setting the
7594: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7595: of "+=". The licenses accepted by default are:
7596: </p>
7597: <pre class="programlisting">
1.154 rodent 7598: apache-1.1 apache-2.0
7599: arphic-public
7600: artistic artistic-2.0
7601: boost-license
7602: cc-by-sa-v3.0
1.161 ryoon 7603: cc0-1.0-universal
1.154 rodent 7604: cddl-1.0
7605: cpl-1.0
7606: epl-v1.0
7607: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7608: gnu-gpl-v1
7609: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7610: gnu-gpl-v3 gnu-lgpl-v3
7611: ibm-public-license-1.0
7612: ipafont
7613: isc
7614: lppl-1.3c
7615: lucent
7616: miros
7617: mit
7618: mpl-1.0 mpl-1.1 mpl-2.0
7619: mplusfont
7620: ofl-v1.0 ofl-v1.1
7621: original-bsd modified-bsd 2-clause-bsd
7622: php
7623: png-license
7624: postgresql-license
7625: public-domain
7626: python-software-foundation
7627: qpl-v1.0
1.158 rodent 7628: sgi-free-software-b-v2.0
1.154 rodent 7629: sleepycat-public
7630: unlicense
7631: x11
7632: zlib
7633: zpl
1.121 jnemeth 7634: </pre>
7635: <p>
7636: </p>
1.78 rillig 7637: <p>The license tag mechanism is intended to address
1.87 wiz 7638: copyright-related issues surrounding building, installing and
7639: using a package, and not to address redistribution issues (see
7640: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7641: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7642: Packages with redistribution restrictions should set these
7643: tags.</p>
1.98 wiz 7644: <p>Denoting that a package may be copied according to a
7645: particular license is done by placing the license in
1.87 wiz 7646: <code class="filename">pkgsrc/licenses</code> and setting the
7647: <code class="varname">LICENSE</code> variable to a string identifying the
1.189 snj 7648: 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 7649: <pre class="programlisting">
1.100 rillig 7650: LICENSE= xv-license
1.87 wiz 7651: </pre>
7652: <p>When trying to build, the user will get a notice that the
1.98 wiz 7653: package is covered by a license which has not been placed in the
7654: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7655: <pre class="programlisting">
1.100 rillig 7656: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7657: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7658: ===> To view the license, enter "/usr/bin/make show-license".
7659: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7660: ===> ACCEPTABLE_LICENSES+=xv-license
7661: *** Error code 1
1.87 wiz 7662: </pre>
1.110 hubertf 7663: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7664: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7665: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7666: convey to pkgsrc that it should not in the future fail because of
7667: that license:</p>
1.78 rillig 7668: <pre class="programlisting">
1.100 rillig 7669: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7670: </pre>
1.154 rodent 7671: <p>When adding a package with a new license, the following steps
7672: are required:</p>
7673: <div class="orderedlist"><ol class="orderedlist" type="1">
7674: <li class="listitem">
7675: <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>
7676: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7677: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7678: <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 7679: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154 rodent 7680: </ul></div>
7681: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7682: </li>
7683: <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>
7684: </ol></div>
1.98 wiz 7685: <p>When the license changes (in a way other than formatting),
7686: please make sure that the new license has a different name (e.g.,
7687: append the version number if it exists, or the date). Just
7688: because a user told pkgsrc to build programs under a previous
7689: version of a license does not mean that pkgsrc should build
1.99 rillig 7690: programs under the new licenses. The higher-level point is that
1.98 wiz 7691: pkgsrc does not evaluate licenses for reasonableness; the only
7692: test is a mechanistic test of whether a particular text has been
7693: approved by either of two bodies.</p>
1.78 rillig 7694: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7695: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7696: is deprecated because it does not crisply refer to a particular
7697: license text. Another problem with such usage is that it does not
7698: enable a user to tell pkgsrc to proceed for a single package
7699: without also telling pkgsrc to proceed for all packages with that
7700: tag.</p>
1.75 rillig 7701: </div>
1.148 asau 7702: <div class="sect2">
1.75 rillig 7703: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7704: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7705: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7706: Because a license tag is required unless the package is Free or
7707: Open Source, all packages with restrictions should have license
7708: tags. By declaring the restrictions, package tools can
7709: automatically refrain from e.g. placing binary packages on FTP
7710: sites.</p>
7711: <p>There are four restrictions that may be encoded, which are
7712: the cross product of sources (distfiles) and binaries not being
7713: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7714: language in any license, and because non-Free licenses tend to be
7715: different from each other, pkgsrc adopts a definition of FTP and
7716: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7717: should not be made available over the Internet at no charge.
7718: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7719: made available on some kind of media, together with other source
7720: and binary packages, and which is sold for a distribution charge.
7721: </p>
7722: <p>In order to encode these restrictions, the package system
1.87 wiz 7723: defines five make variables that can be set to note these
7724: restrictions:</p>
1.148 asau 7725: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7726: <li class="listitem">
1.75 rillig 7727: <p><code class="varname">RESTRICTED</code></p>
7728: <p>This variable should be set whenever a restriction
1.87 wiz 7729: exists (regardless of its kind). Set this variable to a
1.98 wiz 7730: string containing the reason for the restriction. It should
7731: be understood that those wanting to understand the restriction
7732: will have to read the license, and perhaps seek advice of
7733: counsel.</p>
1.75 rillig 7734: </li>
1.128 wiz 7735: <li class="listitem">
1.75 rillig 7736: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7737: <p>Binaries may not be placed on CD-ROM containing other
7738: binary packages, for which a distribution charge may be made.
7739: In this case, set this variable to
7740: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7741: </li>
1.128 wiz 7742: <li class="listitem">
1.75 rillig 7743: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7744: <p>Binaries may not made available on the Internet without
7745: charge. In this case, set this variable to
7746: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7747: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7748: </li>
1.128 wiz 7749: <li class="listitem">
1.75 rillig 7750: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7751: <p>Distfiles may not be placed on CD-ROM, together with
7752: other distfiles, for which a fee may be charged. In this
7753: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7754: </p>
1.75 rillig 7755: </li>
1.128 wiz 7756: <li class="listitem">
1.75 rillig 7757: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7758: <p>Distfiles may not made available via FTP at no charge.
7759: In this case, set this variable to
7760: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7761: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7762: </li>
7763: </ul></div>
1.139 wiz 7764: <p>Please note that packages will to be removed from pkgsrc
7765: when the distfiles are not distributable and cannot be obtained
7766: for a period of one full quarter branch. Packages with manual /
7767: interactive fetch must have a maintainer and it is his/her
7768: responsibility to ensure this.</p>
1.75 rillig 7769: </div>
1.148 asau 7770: <div class="sect2">
1.75 rillig 7771: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7772: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7773: <p>Your package may depend on some other package being present
1.88 wiz 7774: - and there are various ways of expressing this dependency.
7775: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7776: <code class="varname">DEPENDS</code> definitions, the
7777: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7778: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7779: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7780: 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 7781: <p>The basic difference between the two variables is as
1.87 wiz 7782: follows: The <code class="varname">DEPENDS</code> definition registers
7783: that pre-requisite in the binary package so it will be pulled in
7784: when the binary package is later installed, whilst the
7785: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7786: dependency that is only needed for building the package.</p>
1.75 rillig 7787: <p>This means that if you only need a package present whilst
1.87 wiz 7788: you are building, it should be noted as a
7789: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7790: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7791: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7792: <pre class="programlisting">
1.100 rillig 7793: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7794: </pre>
1.128 wiz 7795: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7796: may include any of the wildcard version numbers recognized by
1.189 snj 7797: <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 7798: <div class="orderedlist"><ol class="orderedlist" type="1">
7799: <li class="listitem">
1.75 rillig 7800: <p>If your package needs another package's binaries or
1.160 wiz 7801: libraries to build and run, and if that package has a
1.87 wiz 7802: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7803: <pre class="programlisting">
1.100 rillig 7804: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7805: </pre>
1.75 rillig 7806: </li>
1.128 wiz 7807: <li class="listitem">
1.160 wiz 7808: <p>If your package needs another package's binaries or
7809: libraries only for building, and if that package has a
7810: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7811: <pre class="programlisting">
7812: .include "../../graphics/jpeg/buildlink3.mk"
7813: </pre>
7814: <p>but set
7815: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7816: to make it a build dependency only. This case is rather
7817: rare.</p>
7818: </li>
7819: <li class="listitem">
1.132 spz 7820: <p>If your package needs binaries from another package to build,
7821: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7822: <pre class="programlisting">
1.132 spz 7823: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 7824: </pre>
1.75 rillig 7825: </li>
1.132 spz 7826: <li class="listitem"><p>If your package needs a library with which to link and
7827: there is no <code class="filename">buildlink3.mk</code> file
7828: available, create one. Using
7829: <code class="varname">DEPENDS</code> won't be sufficient because the
7830: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7831: <li class="listitem">
1.132 spz 7832: <p>If your package needs some executable to be able to run
7833: correctly and if there's no
7834: <code class="filename">buildlink3.mk</code> file, this is specified
7835: using the <code class="varname">DEPENDS</code> variable. The
1.189 snj 7836: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.132 spz 7837: be able to execute the latex binary from the teTeX package
7838: when it runs, and that is specified:</p>
1.75 rillig 7839: <pre class="programlisting">
1.132 spz 7840: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7841: </pre>
1.132 spz 7842: </li>
7843: <li class="listitem">
7844: <p>You can use wildcards in package dependencies. Note that
7845: such wildcard dependencies are retained when creating binary
7846: packages. The dependency is checked when installing the binary
7847: package and any package which matches the pattern will be
7848: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7849: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7850: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7851: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7852: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7853: <p>Wildcards can also be used to specify that a package
1.87 wiz 7854: will only build against a certain minimum version of a
7855: pre-requisite:</p>
1.75 rillig 7856: <pre class="programlisting">
1.132 spz 7857: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 7858: </pre>
1.132 spz 7859: <p>This means that the package will build using version 6.0
7860: of ImageMagick or newer. Such a dependency may be warranted
7861: if, for example, the command line options of an executable
7862: have changed.</p>
7863: <p>If you need to depend on minimum versions of libraries,
7864: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7865: <p>For security fixes, please update the package
1.110 hubertf 7866: 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 7867: information.</p>
1.75 rillig 7868: </li>
1.165 bsiegert 7869: <li class="listitem">
7870: <p>If the package depends on either one of two (or more)
7871: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7872: comma-separated list between curly braces.</p>
7873: <p>As an example, take a package that depends on the Perl
7874: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7875: itself since version 5.10.0. This either/or dependency is
7876: expressed as:</p>
7877: <pre class="programlisting">
7878: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7879: </pre>
7880: </li>
1.75 rillig 7881: </ol></div>
7882: <p>If your package needs files from another package to build,
1.87 wiz 7883: add the relevant distribution files to
7884: <code class="varname">DISTFILES</code>, so they will be extracted
1.189 snj 7885: 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 7886: (It relies on the jpeg sources being present in source form
7887: during the build.)</p>
1.75 rillig 7888: </div>
1.148 asau 7889: <div class="sect2">
1.75 rillig 7890: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7891: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7892: <p>Your package may conflict with other packages a user might
1.87 wiz 7893: already have installed on his system, e.g. if your package
1.88 wiz 7894: installs the same set of files as another package in the pkgsrc
1.190 wiz 7895: tree or has the same <code class="varname">PKGNAME</code>.</p>
7896: <p>These cases are handled automatically by the packaging tools
7897: at package installation time and do not need to be handled
7898: manually.</p>
7899: <p>In case the conflicts can not be recognized automatically
7900: (e.g., packages using the same config file location but no other
7901: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7902: space-separated list of packages (including version string) your
7903: package conflicts with.</p>
1.190 wiz 7904: <p>For example, if both <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
7905: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7906: use the same config file, you would set in
7907: <code class="filename">foo/bar/Makefile</code>:</p>
1.87 wiz 7908: <pre class="programlisting">
1.190 wiz 7909: CONFLICTS= baz-[0-9]*
1.87 wiz 7910: </pre>
1.190 wiz 7911: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75 rillig 7912: <pre class="programlisting">
1.190 wiz 7913: CONFLICTS= bar-[0-9]*
1.87 wiz 7914: </pre>
1.75 rillig 7915: </div>
1.148 asau 7916: <div class="sect2">
1.75 rillig 7917: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7918: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7919: <p>There are several reasons why a package might be
1.88 wiz 7920: instructed to not build under certain circumstances. If the
1.87 wiz 7921: package builds and runs on most platforms, the exceptions
1.193 dholland 7922: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7923: the package builds and runs on a small handful of platforms,
7924: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7925: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7926: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7927: (OS-version-platform) that can use glob-style
7928: wildcards.</p>
7929: <p>If a package is not appropriate for some platforms (as
7930: oopposed to merely broken), a different set of variables should be
7931: used as this affects failure reporting and statistics.
7932: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7933: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7934: the package is appropriate for only a small handful of platforms
7935: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7936: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7937: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7938: (OS-version-platform) that can use glob-style
7939: wildcards.</p>
1.88 wiz 7940: <p>Some packages are tightly bound to a specific version of an
1.189 snj 7941: 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 7942: backwards compatible with other versions of the OS, and should be
7943: uploaded to a version specific directory on the FTP server. Mark
7944: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7945: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7946: the package system internals, but may be used in the
7947: future.</p>
1.75 rillig 7948: <p>If the package should be skipped (for example, because it
1.87 wiz 7949: provides functionality already provided by the system), set
1.88 wiz 7950: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7951: the package should fail because some preconditions are not met,
7952: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7953: message.</p>
1.75 rillig 7954: </div>
1.148 asau 7955: <div class="sect2">
1.75 rillig 7956: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7957: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7958: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7959: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7960: be set in the package Makefile. This will be carried into any
7961: binary package that is made from this pkgsrc entry. A
1.128 wiz 7962: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.189 snj 7963: 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 7964: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7965: </div>
1.148 asau 7966: <div class="sect2">
1.75 rillig 7967: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7968: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7969: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7970: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7971: and after committing that file, ask pkgsrc-security@NetBSD.org to
7972: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7973: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7974: <code class="varname">PKGREVISION</code> should be increased (this is of
7975: course not necessary if the problem is fixed by using a newer
7976: release of the software), and the pattern in the
7977: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7978: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7979: branch, be sure to submit a pullup request!</p>
1.75 rillig 7980: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7981: semi-automatically by a weekly cron job.</p>
1.75 rillig 7982: </div>
1.148 asau 7983: <div class="sect2">
1.75 rillig 7984: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7985: <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 7986: <p>When making fixes to an existing package it can be useful
1.87 wiz 7987: to change the version number in <code class="varname">PKGNAME</code>. To
7988: avoid conflicting with future versions by the original author, a
1.128 wiz 7989: <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 7990: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7991: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7992: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7993: <pre class="programlisting">
1.100 rillig 7994: DISTNAME= foo-17.42
7995: PKGREVISION= 9
1.87 wiz 7996: </pre>
1.75 rillig 7997: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7998: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7999: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 8000: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8001: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8002: <p>When a new release of the package is released, the
1.87 wiz 8003: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8004: minor release of the above package, things should be like:</p>
1.75 rillig 8005: <pre class="programlisting">
1.100 rillig 8006: DISTNAME= foo-17.43
1.87 wiz 8007: </pre>
8008: <p><code class="varname">PKGREVISION</code> should be incremented for any
8009: non-trivial change in the resulting binary package. Without a
8010: <code class="varname">PKGREVISION</code> bump, someone with the previous
8011: version installed has no way of knowing that their package is out
8012: of date. Thus, changes without increasing
8013: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8014: trivial that no reasonable person would want to upgrade", and this
8015: is the rough test for when increasing
8016: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8017: changes that do not merit increasing
8018: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 8019: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8020: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 8021: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 8022: or comments in Makefile.</p></li>
1.128 wiz 8023: <li class="listitem"><p>
1.100 rillig 8024: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 8025: <li class="listitem"><p>
1.100 rillig 8026: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8027: <li class="listitem"><p>
1.100 rillig 8028: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8029: </ul></div>
1.87 wiz 8030: <p>Examples of changes that do merit an increase to
8031: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 8032: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8033: <li class="listitem"><p>
1.100 rillig 8034: Security fixes</p></li>
1.128 wiz 8035: <li class="listitem"><p>
1.100 rillig 8036: Changes or additions to a patch file</p></li>
1.128 wiz 8037: <li class="listitem"><p>
1.100 rillig 8038: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8039: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8040: </ul></div>
1.78 rillig 8041: <p>PKGREVISION must also be incremented when dependencies have ABI
8042: changes.</p>
1.75 rillig 8043: </div>
1.148 asau 8044: <div class="sect2">
1.79 rillig 8045: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8046: <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 8047: <p>When you want to replace the same text in multiple files
1.87 wiz 8048: or when the replacement text varies, patches alone cannot help.
8049: This is where the SUBST framework comes in. It provides an
8050: easy-to-use interface for replacing text in files.
8051: Example:</p>
8052: <pre class="programlisting">
1.100 rillig 8053: SUBST_CLASSES+= fix-paths
8054: SUBST_STAGE.fix-paths= pre-configure
8055: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8056: SUBST_FILES.fix-paths= src/*.c
8057: SUBST_FILES.fix-paths+= scripts/*.sh
8058: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8059: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8060: </pre>
1.79 rillig 8061: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8062: that are used to identify the different SUBST blocks that are
8063: defined. The SUBST framework is heavily used by pkgsrc, so it is
8064: important to always use the <code class="literal">+=</code> operator with
8065: this variable. Otherwise some substitutions may be
8066: skipped.</p>
1.79 rillig 8067: <p>The remaining variables of each SUBST block are
1.87 wiz 8068: parameterized with the identifier from the first line
8069: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8070: parameters to a function call.</p>
1.79 rillig 8071: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8072: which the replacement will take place. All combinations of
8073: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8074: <code class="literal">post-</code> together with a phase name are
8075: possible, though only few are actually used. Most commonly used
8076: are <code class="literal">post-patch</code> and
8077: <code class="literal">pre-configure</code>. Of these two,
8078: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8079: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8080: have the state after applying the patches but before making any
8081: other changes. This is especially useful when you are debugging
8082: a package in order to create new patches for it. Similarly,
8083: <code class="literal">post-build</code> is preferred over
8084: <code class="literal">pre-install</code>, because the install phase should
8085: generally be kept as simple as possible. When you use
8086: <code class="literal">post-build</code>, you have the same files in the
8087: working directory that will be installed later, so you can check
8088: if the substitution has succeeded.</p>
1.79 rillig 8089: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8090: that is printed just before the substitution is done.</p>
1.79 rillig 8091: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8092: globbing patterns that specifies the files in which the
8093: substitution will take place. The patterns are interpreted
8094: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8095: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.189 snj 8096: <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 8097: command should be prefixed with <code class="literal">-e</code>, so that
8098: all SUBST blocks look uniform.</p>
1.79 rillig 8099: <p>There are some more variables, but they are so seldomly
1.87 wiz 8100: used that they are only documented in the
8101: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8102: </div>
1.75 rillig 8103: </div>
1.148 asau 8104: <div class="sect1">
1.75 rillig 8105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8106: <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 8107: <div class="sect2">
1.75 rillig 8108: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8109: <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 8110: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8111: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8112: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8113: with the name of each file to download as an argument, expecting
8114: it to output the URL of the directory from which to download
1.189 snj 8115: 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 8116: example of this usage.</p>
1.75 rillig 8117: <p>If the download can't be automated, because the user must
1.87 wiz 8118: submit personal information to apply for a password, or must pay
8119: for the source, or whatever, you can set
8120: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8121: displayed to the user before aborting the build. Example:</p>
8122: <pre class="programlisting">
1.100 rillig 8123: FETCH_MESSAGE= "Please download the files"
8124: FETCH_MESSAGE+= " "${DISTFILES:Q}
8125: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8126: </pre>
1.75 rillig 8127: </div>
1.148 asau 8128: <div class="sect2">
1.75 rillig 8129: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8130: <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 8131: <p>Sometimes authors of a software package make some
1.87 wiz 8132: modifications after the software was released, and they put up a
8133: new distfile without changing the package's version number. If a
8134: package is already in pkgsrc at that time, the checksum will
8135: no longer match. The contents of the new distfile should be
8136: compared against the old one before changing anything, to make
8137: sure the distfile was really updated on purpose, and that
8138: no trojan horse or so crept in.
1.97 rillig 8139: Please mention that the distfiles were compared and what was found
1.159 rodent 8140: in your commit message.</p>
8141: <p>Then, the correct way to work around this is to
1.87 wiz 8142: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8143: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8144: <code class="varname">DISTFILES</code> and
1.93 rillig 8145: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8146: subdirectory of the local distfiles directory.
1.110 hubertf 8147: (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 8148: In case this
1.87 wiz 8149: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8150: including the <code class="filename">nbX</code> suffix) or a date stamp
1.159 rodent 8151: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8152: <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>
8153: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8154: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8155: path in the filenames.
1.159 rodent 8156: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8157: Furthermore, a mail to the package's authors seems appropriate
8158: telling them that changing distfiles after releases without
8159: changing the file names is not good practice.</p>
1.75 rillig 8160: </div>
1.199 tnn 8161: <div class="sect2">
8162: <div class="titlepage"><div><div><h3 class="title">
8163: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.200 ! tnn 8164: <p>Helper methods exist for packages hosted on github.com which will often have distfile names that clash with other packages, for example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes from below:
! 8165: </p>
1.199 tnn 8166: <div class="sect3">
8167: <div class="titlepage"><div><div><h4 class="title">
8168: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
8169: <p>
8170: If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/archive/v1.0.zip</code>, then you are packaging a tagged release.
8171: </p>
8172: <pre class="programlisting">
8173: DISTNAME= exampleproject-1.0
1.200 ! tnn 8174: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
! 8175: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
! 8176: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 8177: EXTRACT_SUFX= .zip
8178: </pre>
8179: </div>
8180: <div class="sect3">
8181: <div class="titlepage"><div><div><h4 class="title">
8182: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
8183: <p>
8184: If your distfile URL looks similar to <code class="literal">http://github.com/example/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>, then you are packaging a specific commit not tied to a release.
8185: </p>
8186: <pre class="programlisting">
8187: DISTNAME= example-1.0
1.200 ! tnn 8188: MASTER_SITES= ${MASTER_SITE_GITHUB:example/}
! 8189: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
! 8190: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.199 tnn 8191: </pre>
8192: </div>
8193: <div class="sect3">
8194: <div class="titlepage"><div><div><h4 class="title">
8195: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
8196: <p>
8197: If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/releases/download/rel-1.6/offensive-1.6.zip</code>, then you are packaging a release.
8198: </p>
8199: <pre class="programlisting">
8200: DISTNAME= offensive-1.6
1.200 ! tnn 8201: PKGNAME= ${DISTNAME:S/offensive/proper/}
! 8202: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
! 8203: GITHUB_PROJECT= exampleproject
! 8204: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
! 8205: EXTRACT_SUFX= .zip
1.199 tnn 8206: </pre>
8207: </div>
8208: </div>
1.75 rillig 8209: </div>
1.148 asau 8210: <div class="sect1">
1.75 rillig 8211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8212: <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 8213: <div class="sect2">
1.75 rillig 8214: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8215: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8216: <p>pkgsrc supports many different machines, with different
1.87 wiz 8217: object formats like a.out and ELF, and varying abilities to do
8218: shared library and dynamic loading at all. To accompany this,
8219: varying commands and options have to be passed to the
8220: compiler, linker, etc. to get the Right Thing, which can be
8221: pretty annoying especially if you don't have all the machines
8222: at your hand to test things. The
1.189 snj 8223: <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 8224: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8225: both static and dynamic libraries from a set of source files,
8226: thus being platform-independent.</p>
8227: <p>Here's how to use libtool in a package in seven simple
8228: steps:</p>
1.128 wiz 8229: <div class="orderedlist"><ol class="orderedlist" type="1">
8230: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8231: Makefile.</p></li>
1.128 wiz 8232: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8233: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8234: add it to the definition of <code class="varname">CC</code>, if only
8235: libraries are being built in a given Makefile. This one command
8236: will build both PIC and non-PIC library objects, so you need not
8237: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8238: <li class="listitem">
1.75 rillig 8239: <p>For the linking of the library, remove any
1.128 wiz 8240: <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
8241: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8242: <pre class="programlisting">
1.100 rillig 8243: ${LIBTOOL} --mode=link \
8244: ${CC} -o ${.TARGET:.a=.la} \
8245: ${OBJS:.o=.lo} \
8246: -rpath ${PREFIX}/lib \
8247: -version-info major:minor
1.87 wiz 8248: </pre>
1.75 rillig 8249: <p>Note that the library is changed to have a
1.87 wiz 8250: <code class="filename">.la</code> extension, and the objects are
8251: changed to have a <code class="filename">.lo</code>
8252: extension. Change <code class="varname">OBJS</code> as
8253: necessary. This automatically creates all of the
8254: <code class="filename">.a</code>,
8255: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8256: necessary) in the build directory. Be sure to include
1.128 wiz 8257: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8258: minor are zero, as libtool will otherwise strip off the
8259: shared library version.</p>
1.75 rillig 8260: <p>From the libtool manual:</p>
8261: <pre class="programlisting">
1.100 rillig 8262: So, libtool library versions are described by three integers:
1.69 rillig 8263:
1.100 rillig 8264: CURRENT
8265: The most recent interface number that this library implements.
1.69 rillig 8266:
1.100 rillig 8267: REVISION
8268: The implementation number of the CURRENT interface.
1.69 rillig 8269:
1.100 rillig 8270: AGE
8271: The difference between the newest and oldest interfaces that
8272: this library implements. In other words, the library implements
8273: all the interface numbers in the range from number `CURRENT -
8274: AGE' to `CURRENT'.
1.1 grant 8275:
1.100 rillig 8276: If two libraries have identical CURRENT and AGE numbers, then the
8277: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8278: </pre>
1.128 wiz 8279: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8280: different results for a.out and ELF (excluding symlinks)
8281: in only one case. An ELF library of the form
1.128 wiz 8282: <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 8283: will have a symlink of
1.128 wiz 8284: <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 8285: on an a.out platform. This is handled
8286: automatically.</p>
1.128 wiz 8287: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8288: directory of the library being built.</p>
1.76 rillig 8289: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8290: <code class="filename">.la</code> file, the other files will be
8291: added automatically.</p>
1.75 rillig 8292: </li>
1.128 wiz 8293: <li class="listitem">
1.76 rillig 8294: <p>When linking shared object (<code class="filename">.so</code>)
1.189 snj 8295: 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 8296: shared libraries, use <span class="quote">“<span class="quote">-module
8297: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8298: tacked on.</p>
1.76 rillig 8299: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8300: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8301: </li>
1.128 wiz 8302: <li class="listitem">
1.75 rillig 8303: <p>When linking programs that depend on these libraries
1.87 wiz 8304: <span class="emphasis"><em>before</em></span> they are installed, preface
1.189 snj 8305: 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 8306: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8307: libraries (static or shared), but please be aware that
8308: libtool will not allow you to specify a relative path in
1.128 wiz 8309: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8310: expects you to change that argument to be the
8311: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8312: <pre class="programlisting">
1.100 rillig 8313: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8314: </pre>
1.75 rillig 8315: <p>should be changed to:</p>
8316: <pre class="programlisting">
1.100 rillig 8317: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8318: </pre>
1.75 rillig 8319: <p>and it will do the right thing with the libraries.</p>
8320: </li>
1.128 wiz 8321: <li class="listitem">
1.189 snj 8322: <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>
8323: 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 8324: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8325: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8326: <pre class="programlisting">
1.126 jakllsch 8327: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8328: </pre>
1.76 rillig 8329: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8330: shared library, any needed symlinks, and run
1.189 snj 8331: <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 8332: </li>
1.128 wiz 8333: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8334: the <code class="filename">.la</code>
8335: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8336: </ol></div>
8337: </div>
1.148 asau 8338: <div class="sect2">
1.75 rillig 8339: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8340: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8341: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8342: package Makefile. This will override the package's own libtool
8343: in most cases. For older libtool using packages, libtool is
8344: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8345: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8346: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8347: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8348: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8349: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8350: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8351: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8352: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8353: libraries built and installed, then use
8354: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8355: <p>If your package makes use of the platform-independent library
1.87 wiz 8356: for loading dynamic shared objects, that comes with libtool
8357: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8358: <p>Some packages use libtool incorrectly so that the package
8359: may not work or build in some circumstances. Some of the more
8360: common errors are:</p>
1.148 asau 8361: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8362: <li class="listitem">
1.75 rillig 8363: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8364: executable or library. This in itself isn't a problem if one of two things
8365: has been done:</p>
1.128 wiz 8366: <div class="orderedlist"><ol class="orderedlist" type="1">
8367: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8368: <code class="filename">libfoo.la</code>, not
8369: <code class="filename">foo.la</code></p></li>
1.128 wiz 8370: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8371: </ol></div>
8372: </li>
1.128 wiz 8373: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8374: The function lt_dlinit() should be called and the macro
8375: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8376: executables.</p></li>
1.75 rillig 8377: </ul></div>
8378: </div>
1.148 asau 8379: <div class="sect2">
1.75 rillig 8380: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8381: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8382: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8383: to regenerate the configure script and Makefile.in makefile
8384: templates, then they should be executed in a pre-configure
8385: target.</p>
1.75 rillig 8386: <p>For packages that need only autoconf:</p>
8387: <pre class="programlisting">
1.100 rillig 8388: AUTOCONF_REQD= 2.50 # if default version is not good enough
8389: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8390: ...
1.1 grant 8391:
1.100 rillig 8392: pre-configure:
8393: cd ${WRKSRC} && autoconf
1.1 grant 8394:
1.100 rillig 8395: ...
1.87 wiz 8396: </pre>
1.75 rillig 8397: <p>and for packages that need automake and autoconf:</p>
8398: <pre class="programlisting">
1.100 rillig 8399: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8400: USE_TOOLS+= automake # use "automake14" for automake-1.4
8401: ...
8402:
8403: pre-configure:
8404: set -e; cd ${WRKSRC}; \
8405: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8406:
1.100 rillig 8407: ...
1.87 wiz 8408: </pre>
1.75 rillig 8409: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8410: require GNU Make.</p>
1.75 rillig 8411: <p>There are times when the configure process makes
1.87 wiz 8412: additional changes to the generated files, which then causes
8413: the build process to try to re-execute the automake sequence.
8414: This is prevented by touching various files in the configure
8415: stage. If this causes problems with your package you can set
8416: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8417: Makefile.</p>
1.75 rillig 8418: </div>
8419: </div>
1.148 asau 8420: <div class="sect1">
1.75 rillig 8421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8422: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 8423: <div class="sect2">
1.87 wiz 8424: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8425: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8426: <p>Compilers for the C, C++, and Fortran languages comes with
8427: the NetBSD base system. By default, pkgsrc assumes that a package
8428: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8429: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8430: <p>To declare which language's compiler a package needs, set
8431: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8432: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8433: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8434: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8435: written in C++, usually need a C compiler for the configure
8436: phase.</p>
8437: </div>
1.148 asau 8438: <div class="sect2">
1.87 wiz 8439: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8440: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8441: <p>If a program is written in Java, use the Java framework in
8442: pkgsrc. The package must include
8443: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8444: provides the following variables:</p>
1.148 asau 8445: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8446: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8447: dependency on the JDK is added. If
1.128 wiz 8448: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8449: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8450: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8451: JDK.</p></li>
1.128 wiz 8452: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8453: a package needs a Java2 implementation. The supported values
1.128 wiz 8454: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8455: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8456: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8457: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8458: above. This variable is not set by default.</p></li>
1.130 wiz 8459: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8460: automatically set to the runtime location of the used Java
8461: implementation dependency. It may be used to set
8462: <code class="varname">JAVA_HOME</code> to a good value if the program
8463: needs this variable to be defined.
8464: </p></li>
1.87 wiz 8465: </ul></div>
8466: </div>
1.148 asau 8467: <div class="sect2">
1.87 wiz 8468: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8469: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8470: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8471: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8472: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8473: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8474: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8475: that you want adjusted. Every occurrence of
8476: <code class="filename">*/bin/perl</code> in a she-bang line will be
8477: replaced with the full path to the perl executable.</p>
1.87 wiz 8478: <p>If a particular version of perl is needed, set the
8479: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8480: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8481: <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 8482: about handling perl modules.</p>
8483: </div>
1.148 asau 8484: <div class="sect2">
1.87 wiz 8485: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8486: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8487: <p><code class="varname">REPLACE_SH</code>,
8488: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8489: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8490: hash bangs in files. Please use the appropriate one, prefering
8491: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8492: Each should contain a list of scripts, relative to
8493: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8494: occurrence of the matching shell in a she-bang line will be
8495: replaced with the full path to the shell executable.
1.147 wiz 8496: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8497: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8498: </div>
1.148 asau 8499: <div class="sect2">
1.147 wiz 8500: <div class="titlepage"><div><div><h3 class="title">
8501: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8502: <p>Currently, there is no special handling for other languages
8503: in pkgsrc. If a compiler package provides a
8504: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8505: just add a (build) dependency on the appropriate compiler
8506: package.</p>
8507: </div>
8508: </div>
1.148 asau 8509: <div class="sect1">
1.87 wiz 8510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8511: <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 8512: <p>The most common failures when building a package are that
8513: some platforms do not provide certain header files, functions or
8514: libraries, or they provide the functions in a library that the
8515: original package author didn't know. To work around this, you
8516: can rewrite the source code in most cases so that it does not
8517: use the missing functions or provides a replacement function.</p>
1.148 asau 8518: <div class="sect2">
1.77 rillig 8519: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8520: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8521: <p>If a package already comes with a GNU configure script, the
8522: preferred way to fix the build failure is to change the
8523: configure script, not the code. In the other cases, you can
8524: utilize the C preprocessor, which defines certain macros
8525: depending on the operating system and hardware architecture it
8526: compiles for. These macros can be queried using for example
8527: <code class="varname">#if defined(__i386)</code>. Almost every operating
8528: system, hardware architecture and compiler has its own macro.
8529: For example, if the macros <code class="varname">__GNUC__</code>,
8530: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8531: are all defined, you know that you are using NetBSD on an i386
8532: compatible CPU, and your compiler is GCC.</p>
8533: <p>The list of the following macros for hardware and
8534: operating system depends on the compiler that is used. For
8535: example, if you want to conditionally compile code on Solaris,
8536: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8537: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8538: <div class="sect3">
1.75 rillig 8539: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8540: <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 8541: <p>To distinguish between 4.4 BSD-derived systems and the
8542: rest of the world, you should use the following code.</p>
8543: <pre class="programlisting">
1.100 rillig 8544: #include <sys/param.h>
8545: #if (defined(BSD) && BSD >= 199306)
8546: /* BSD-specific code goes here */
8547: #else
8548: /* non-BSD-specific code goes here */
8549: #endif
1.75 rillig 8550: </pre>
1.77 rillig 8551: <p>If this distinction is not fine enough, you can also test
8552: for the following macros.</p>
1.75 rillig 8553: <pre class="programlisting">
1.151 obache 8554: Cygwin __CYGWIN__
8555: DragonFly __DragonFly__
1.100 rillig 8556: FreeBSD __FreeBSD__
1.151 obache 8557: Haiku __HAIKU__
1.100 rillig 8558: Interix __INTERIX
8559: IRIX __sgi (TODO: get a definite source for this)
8560: Linux linux, __linux, __linux__
1.193 dholland 8561: Mac OS X __APPLE__
1.151 obache 8562: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8563: Minix3 __minix
1.100 rillig 8564: NetBSD __NetBSD__
8565: OpenBSD __OpenBSD__
8566: Solaris sun, __sun
1.75 rillig 8567: </pre>
8568: </div>
1.148 asau 8569: <div class="sect3">
1.75 rillig 8570: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8571: <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 8572: <pre class="programlisting">
1.100 rillig 8573: i386 i386, __i386, __i386__
8574: MIPS __mips
8575: SPARC sparc, __sparc
1.75 rillig 8576: </pre>
8577: </div>
1.148 asau 8578: <div class="sect3">
1.75 rillig 8579: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8580: <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 8581: <pre class="programlisting">
1.100 rillig 8582: GCC __GNUC__ (major version), __GNUC_MINOR__
8583: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8584: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8585: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8586: </pre>
8587: </div>
8588: </div>
1.148 asau 8589: <div class="sect2">
1.78 rillig 8590: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8591: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8592: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8593: combinations of compiler version and architecture and almost
8594: always relation to optimisation being enabled. Common symptoms
8595: are gcc internal errors or never finishing compiling a
1.78 rillig 8596: file.</p>
8597: <p>Typically, a workaround involves testing the
8598: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8599: optimisation for that combination of file,
1.198 tnn 8600: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8601: <p>This used to be a big problem in the past, but is rarely
8602: needed now as compiler technology has matured. If you still need
8603: to add a compiler specific workaround, please do so in the file
8604: <code class="filename">hacks.mk</code> and describe the symptom and
8605: compiler version as detailed as possible.</p>
1.78 rillig 8606: </div>
1.148 asau 8607: <div class="sect2">
1.78 rillig 8608: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8609: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8610: </h3></div></div></div>
1.92 rillig 8611: <p>This error message often means that a package did not
1.78 rillig 8612: link to a shared library it needs. The following functions are
8613: known to cause this error message over and over.</p>
8614: <div class="informaltable">
8615: <a name="undefined-reference-functions"></a><table border="1">
8616: <colgroup>
8617: <col>
8618: <col>
8619: <col>
8620: </colgroup>
8621: <thead><tr>
8622: <th>Function</th>
8623: <th>Library</th>
8624: <th>Affected platforms</th>
8625: </tr></thead>
8626: <tbody>
8627: <tr>
8628: <td>accept, bind, connect</td>
8629: <td>-lsocket</td>
8630: <td>Solaris</td>
8631: </tr>
8632: <tr>
8633: <td>crypt</td>
8634: <td>-lcrypt</td>
8635: <td>DragonFly, NetBSD</td>
8636: </tr>
8637: <tr>
8638: <td>dlopen, dlsym</td>
8639: <td>-ldl</td>
8640: <td>Linux</td>
8641: </tr>
8642: <tr>
8643: <td>gethost*</td>
8644: <td>-lnsl</td>
8645: <td>Solaris</td>
8646: </tr>
8647: <tr>
8648: <td>inet_aton</td>
8649: <td>-lresolv</td>
8650: <td>Solaris</td>
8651: </tr>
8652: <tr>
8653: <td>nanosleep, sem_*, timer_*</td>
8654: <td>-lrt</td>
8655: <td>Solaris</td>
8656: </tr>
8657: <tr>
8658: <td>openpty</td>
8659: <td>-lutil</td>
8660: <td>Linux</td>
8661: </tr>
8662: </tbody>
8663: </table>
8664: </div>
8665: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8666: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8667: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8668: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8669: bmake</strong></span>.</p>
1.148 asau 8670: <div class="sect3">
1.92 rillig 8671: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8672: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8673: <p>When you are using the SunPro compiler, there is another
8674: possibility. That compiler cannot handle the following code:</p>
8675: <pre class="programlisting">
1.100 rillig 8676: extern int extern_func(int);
1.93 rillig 8677:
1.100 rillig 8678: static inline int
8679: inline_func(int x)
8680: {
1.92 rillig 8681: return extern_func(x);
1.100 rillig 8682: }
1.93 rillig 8683:
1.100 rillig 8684: int main(void)
8685: {
1.92 rillig 8686: return 0;
1.100 rillig 8687: }
1.92 rillig 8688: </pre>
8689: <p>It generates the code for <code class="function">inline_func</code> even if
8690: that function is never used. This code then refers to
8691: <code class="function">extern_func</code>, which can usually not be resolved. To
8692: solve this problem you can try to tell the package to disable inlining
8693: of functions.</p>
8694: </div>
1.87 wiz 8695: </div>
1.148 asau 8696: <div class="sect2">
1.87 wiz 8697: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8698: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8699: <p>Sometimes packages fail to build because the compiler runs
8700: into an operating system specific soft limit. With the
8701: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8702: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8703: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8704: Setting this variable is similar to running the shell builtin
1.110 hubertf 8705: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8706: segment size or maximum stack size of a process, respectively, to
8707: their hard limits.</p>
1.78 rillig 8708: </div>
1.75 rillig 8709: </div>
1.148 asau 8710: <div class="sect1">
1.75 rillig 8711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8712: <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 8713: <div class="sect2">
1.75 rillig 8714: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8715: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8716: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8717: with some operating systems cannot create more than one
8718: directory at a time. As such, you should call
8719: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8720: <pre class="programlisting">
1.100 rillig 8721: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8722: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8723: </pre>
1.128 wiz 8724: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8725: dir2</code></span>”</span> to the
1.87 wiz 8726: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8727: automatically do the right thing.</p>
1.75 rillig 8728: </div>
1.148 asau 8729: <div class="sect2">
1.75 rillig 8730: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8731: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8732: <p>In general, documentation should be installed into
1.87 wiz 8733: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8734: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8735: includes the version number of the package).</p>
1.84 wiz 8736: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8737: directory where HTML documentation is installed with the
1.128 wiz 8738: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8739: is needed because otherwise the documentation ends up in
8740: <code class="filename">${PREFIX}/share/doc/html</code> or other
8741: places.</p>
8742: <p>An exception to the above is that library API documentation
1.189 snj 8743: 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 8744: browsers (devhelp) should be left at their default location, which
8745: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8746: documentation can be recognized from files ending in
8747: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8748: (It is also acceptable to install such files in
8749: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8750: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8751: <code class="filename">.devhelp*</code> file must be directly in that
8752: directory then, no additional subdirectory level is allowed in
8753: this case. This is usually achieved by using
1.128 wiz 8754: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8755: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8756: though.)</p>
1.75 rillig 8757: </div>
1.148 asau 8758: <div class="sect2">
1.75 rillig 8759: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8760: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8761: <p>Certain packages, most of them in the games category, install
1.87 wiz 8762: a score file that allows all users on the system to record their
8763: highscores. In order for this to work, the binaries need to be
8764: installed setgid and the score files owned by the appropriate
1.142 wiz 8765: group and/or owner (traditionally the "games" user/group). Set
8766: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8767: following variables, documented in more detail in
8768: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8769: behaviour: <code class="varname">GAMEDATAMODE</code>,
8770: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8771: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 8772: <p>A package should therefore never hard code file ownership or
1.87 wiz 8773: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8774: <code class="varname">INSTALL_GAME_DATA</code> to set these
8775: correctly.</p>
1.75 rillig 8776: </div>
1.148 asau 8777: <div class="sect2">
1.75 rillig 8778: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8779: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8780: <p><code class="varname">DESTDIR</code> support means that a package
8781: installs into a staging directory, not the final location of the
8782: files. Then a binary package is created which can be used for
8783: installation as usual. There are two ways: Either the package must
1.128 wiz 8784: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8785: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8786: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8787: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 8788: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8789: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8790: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8791: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8792: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8793: the inclusion.</p></li>
1.128 wiz 8794: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8795: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8796: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8797: automatically. Many manual rules and pre/post-install often are
8798: incorrect; fix them.</p></li>
1.128 wiz 8799: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8800: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8801: <li class="listitem"><p>In general, packages should support
1.103 wiz 8802: <code class="varname">UNPRIVILEGED</code> to be able to use
8803: DESTDIR.</p></li>
8804: </ul></div>
8805: </div>
1.148 asau 8806: <div class="sect2">
1.103 wiz 8807: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8808: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8809: <p>Your package may also contain scripts with hardcoded paths to
8810: other interpreters besides (or as well as) perl. To correct the
8811: full pathname to the script interpreter, you need to set the
8812: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8813: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8814: <pre class="programlisting">
1.100 rillig 8815: REPLACE_INTERPRETER+= tcl
8816: REPLACE.tcl.old= .*/bin/tclsh
8817: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8818: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8819: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8820: </pre>
1.148 asau 8821: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8822: <h3 class="title">Note</h3>
8823: <p>Before March 2006, these variables were called
1.87 wiz 8824: <code class="varname">_REPLACE.*</code> and
8825: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8826: </div>
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="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8831: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8832: the Makefile fragment
8833: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8834: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8835: configuration for such modules as well as various hooks to tune
8836: this configuration. See comments in this file for
8837: details.</p>
1.75 rillig 8838: <p>Perl5 modules will install into different places depending
1.87 wiz 8839: on the version of perl used during the build process. To
8840: address this, pkgsrc will append lines to the
8841: <code class="filename">PLIST</code> corresponding to the files listed in
8842: the installed <code class="filename">.packlist</code> file generated by
8843: most perl5 modules. This is invoked by defining
8844: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8845: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8846: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8847: e.g.:</p>
1.75 rillig 8848: <pre class="programlisting">
1.153 wiz 8849: PERL5_PACKLIST= auto/Pg/.packlist
1.87 wiz 8850: </pre>
1.153 wiz 8851: <p>The perl5 config variables
8852: <code class="varname">installarchlib</code>,
8853: <code class="varname">installscript</code>,
8854: <code class="varname">installvendorbin</code>,
8855: <code class="varname">installvendorscript</code>,
8856: <code class="varname">installvendorarch</code>,
8857: <code class="varname">installvendorlib</code>,
8858: <code class="varname">installvendorman1dir</code>, and
8859: <code class="varname">installvendorman3dir</code> represent those
8860: locations in which components of perl5 modules may be installed,
8861: provided as variable with uppercase and prefixed with
8862: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8863: and may be used by perl5 packages that don't have a packlist.
8864: These variables are also substituted for in the
8865: <code class="filename">PLIST</code> as uppercase prefixed with
8866: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8867: </div>
1.148 asau 8868: <div class="sect2">
1.75 rillig 8869: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8870: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8871: <p>Some packages install info files or use the
1.128 wiz 8872: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8873: commands. <code class="varname">INFO_FILES</code> should be defined in
8874: the package Makefile so that <code class="filename">INSTALL</code> and
8875: <code class="filename">DEINSTALL</code> scripts will be generated to
8876: handle registration of the info files in the Info directory
1.128 wiz 8877: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8878: files registration is either provided by the system, or by a
8879: special purpose package automatically added as dependency if
8880: needed.</p>
1.75 rillig 8881: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8882: <code class="filename">${PREFIX}</code> where info files are primarily
8883: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8884: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8885: <p>The info files for the package should be listed in the
1.87 wiz 8886: package <code class="filename">PLIST</code>; however any split info files
8887: need not be listed.</p>
1.128 wiz 8888: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8889: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8890: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8891: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8892: should be noted with the <code class="varname">TEXINFO_REQD</code>
8893: variable in the package <code class="filename">Makefile</code>. By
8894: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8895: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8896: does not match the required minimum, a build dependency on the
1.189 snj 8897: <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 8898: be added automatically.</p>
1.75 rillig 8899: <p>The build and installation process of the software provided
1.87 wiz 8900: by the package should not use the
1.110 hubertf 8901: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8902: info files is the task of the package
8903: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8904: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8905: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8906: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8907: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8908: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8909: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8910: no effect except the logging of a message. The script overriding
1.110 hubertf 8911: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8912: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8913: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8914: </div>
1.148 asau 8915: <div class="sect2">
1.75 rillig 8916: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8917: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8918: <p>All packages that install manual pages should install them
1.87 wiz 8919: into the same directory, so that there is one common place to look
8920: for them. In pkgsrc, this place is
8921: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8922: should be used in packages. The default for
8923: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8924: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8925: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8926: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8927: <h3 class="title">Note</h3>
1.87 wiz 8928: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8929: is far from complete.</p>
1.75 rillig 8930: </div>
1.81 rillig 8931: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8932: <code class="filename">man/</code> as the top level directory for the man
8933: page file entries, and the pkgsrc framework will convert as
8934: needed. In all other places, the correct
8935: <code class="varname">PKGMANDIR</code> must be used.</p>
8936: <p>Packages that are
8937: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8938: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8939: <code class="filename">./configure</code>
8940: --mandir switch to set where the man pages should be installed.
8941: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8942: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8943: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8944: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8945: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8946: Or if the <code class="filename">./configure</code> script uses
8947: a non-standard use of --mandir, you can set
8948: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8949: <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 8950: information on installation of compressed manual pages.</p>
1.75 rillig 8951: </div>
1.148 asau 8952: <div class="sect2">
1.75 rillig 8953: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8954: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8955: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8956: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8957: you need to take some extra steps to make sure they get registered
8958: in the database:</p>
1.128 wiz 8959: <div class="orderedlist"><ol class="orderedlist" type="1">
8960: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8961: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8962: takes care of rebuilding the GConf database at installation and
1.87 wiz 8963: deinstallation time, and tells the package where to install
1.107 rillig 8964: GConf data files using some standard configure arguments. It
1.87 wiz 8965: also disallows any access to the database directly from the
8966: package.</p></li>
1.128 wiz 8967: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8968: <code class="filename">.schemas</code> files under
8969: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8970: installed under <code class="filename">${PREFIX}/etc</code>, you will
8971: need to manually patch the package.</p></li>
1.128 wiz 8972: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8973: directory, as they will be handled automatically. See
1.194 bsiegert 8974: <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.128 wiz 8975: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8976: your <code class="filename">Makefile</code> with a list of all
8977: <code class="filename">.schemas</code> files installed by the package, if
8978: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8979: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8980: your <code class="filename">Makefile</code> with a
8981: list of all <code class="filename">.entries</code> files installed by the
8982: package, if any. Names must not contain any directories in
8983: them.</p></li>
1.75 rillig 8984: </ol></div>
8985: </div>
1.148 asau 8986: <div class="sect2">
1.75 rillig 8987: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 8988: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8989: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8990: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8991: get registered in the database:</p>
1.128 wiz 8992: <div class="orderedlist"><ol class="orderedlist" type="1">
8993: <li class="listitem"><p>Include
1.119 mishka 8994: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8995: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8996: takes care of rebuilding the scrollkeeper database at
8997: installation and deinstallation time, and disallows any access
8998: to it directly from the package.</p></li>
1.128 wiz 8999: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9000: <code class="filename">libdata/scrollkeeper</code> directory, as they
9001: will be handled automatically.</p></li>
1.128 wiz 9002: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 9003: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9004: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 9005: </ol></div>
9006: </div>
1.148 asau 9007: <div class="sect2">
1.75 rillig 9008: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9009: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9010: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9011: the fonts database in the directory where they get installed at
9012: installation and deinstallation time. This can be automatically
9013: done by using the pkginstall framework.</p>
1.75 rillig 9014: <p>You can list the directories where fonts are installed in the
1.87 wiz 9015: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9016: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9017: <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 9018: Also make sure that the database file
9019: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9020: <p>Note that you should not create new directories for fonts;
1.87 wiz 9021: instead use the standard ones to avoid that the user needs to
9022: manually configure his X server to find them.</p>
1.75 rillig 9023: </div>
1.148 asau 9024: <div class="sect2">
1.75 rillig 9025: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9026: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9027: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9028: take some extra steps to get them registered in the GTK2 database
9029: properly:</p>
1.128 wiz 9030: <div class="orderedlist"><ol class="orderedlist" type="1">
9031: <li class="listitem"><p>Include
1.87 wiz 9032: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9033: <code class="filename">buildlink3.mk</code> file. This takes care of
9034: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 9035: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 9036: your package installs GTK2 immodules.</p></li>
1.128 wiz 9037: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 9038: GTK2 loaders.</p></li>
1.128 wiz 9039: <li class="listitem">
1.87 wiz 9040: <p>Patch the package to not touch any of the GTK2
9041: databases directly. These are:</p>
1.148 asau 9042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9043: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9044: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9045: </ul></div>
9046: </li>
1.128 wiz 9047: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 9048: any entries under the <code class="filename">libdata/gtk-2.0</code>
9049: directory, as they will be handled automatically.</p></li>
1.75 rillig 9050: </ol></div>
9051: </div>
1.148 asau 9052: <div class="sect2">
1.75 rillig 9053: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9054: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9055: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9056: registered in system-wide catalogs (like DTDs, sub-catalogs,
9057: etc.), you need to take some extra steps:</p>
1.128 wiz 9058: <div class="orderedlist"><ol class="orderedlist" type="1">
9059: <li class="listitem"><p>Include
1.87 wiz 9060: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9061: your <code class="filename">Makefile</code>, which takes care of
9062: registering those files in system-wide catalogs at
9063: installation and deinstallation time.</p></li>
1.128 wiz 9064: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9065: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9066: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9067: any XML catalogs installed by the package.</p></li>
1.128 wiz 9068: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9069: to be added to the SGML catalog. These come in groups of
9070: three strings; see xmlcatmgr(1) for more information
9071: (specifically, arguments recognized by the 'add' action).
9072: Note that you will normally not use this variable.</p></li>
1.128 wiz 9073: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9074: to be added to the XML catalog. These come in groups of three
9075: strings; see xmlcatmgr(1) for more information (specifically,
9076: arguments recognized by the 'add' action). Note that you will
9077: normally not use this variable.</p></li>
1.75 rillig 9078: </ol></div>
9079: </div>
1.148 asau 9080: <div class="sect2">
1.75 rillig 9081: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9082: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9083: <p>If a package provides extensions to the MIME database by
1.87 wiz 9084: installing <code class="filename">.xml</code> files inside
9085: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9086: need to take some extra steps to ensure that the database is kept
9087: consistent with respect to these new files:</p>
1.128 wiz 9088: <div class="orderedlist"><ol class="orderedlist" type="1">
9089: <li class="listitem"><p>Include
1.87 wiz 9090: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9091: (avoid using the <code class="filename">buildlink3.mk</code> file from
9092: this same directory, which is reserved for inclusion from
9093: other <code class="filename">buildlink3.mk</code> files). It takes
9094: care of rebuilding the MIME database at installation and
9095: deinstallation time, and disallows any access to it directly
9096: from the package.</p></li>
1.128 wiz 9097: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9098: <code class="filename">share/mime</code> directory,
9099: <span class="emphasis"><em>except</em></span> for files saved under
9100: <code class="filename">share/mime/packages</code>. The former are
9101: handled automatically by
9102: the update-mime-database program, but the latter are
9103: package-dependent and must be removed by the package that
9104: installed them in the first place.</p></li>
1.128 wiz 9105: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9106: from the PLIST. They will be handled by the shared-mime-info
9107: package.</p></li>
1.75 rillig 9108: </ol></div>
9109: </div>
1.148 asau 9110: <div class="sect2">
1.75 rillig 9111: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9112: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9113: <p>If a package uses intltool during its build, add
9114: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9115: which forces it to use the intltool package provided by pkgsrc,
9116: instead of the one bundled with the distribution file.</p>
1.75 rillig 9117: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9118: latest available version; this way, the package benefits of any
9119: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9120: </div>
1.148 asau 9121: <div class="sect2">
1.75 rillig 9122: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9123: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9124: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9125: the startup directory by default, but you can enable it, by adding
9126: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9127: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9128: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9129: it will automatically remove the scripts when the package is
9130: deinstalled.</p>
1.75 rillig 9131: </div>
1.148 asau 9132: <div class="sect2">
1.75 rillig 9133: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9134: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9135: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9136: the <code class="filename">ls-R</code> database of the tree needs to be
9137: updated.</p>
1.148 asau 9138: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9139: <h3 class="title">Note</h3>
1.125 wiz 9140: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9141: packages should install files
1.125 wiz 9142: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9143: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9144: </div>
1.128 wiz 9145: <div class="orderedlist"><ol class="orderedlist" type="1">
9146: <li class="listitem"><p>Include
1.125 wiz 9147: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9148: takes care of rebuilding the <code class="filename">ls-R</code>
9149: database at installation and deinstallation time.</p></li>
1.128 wiz 9150: <li class="listitem">
1.75 rillig 9151: <p>If your package installs files into a texmf
1.87 wiz 9152: tree other than the one
1.125 wiz 9153: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9154: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9155: trees that need database update.</p>
1.75 rillig 9156: <p>If your package also installs font map files that need
1.110 hubertf 9157: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9158: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9159: set <code class="varname">TEX_MAP_FILES</code> and/or
9160: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9161: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9162: be run automatically at installation/deinstallation to
9163: enable/disable font map files for TeX output
9164: drivers.</p>
1.75 rillig 9165: </li>
1.128 wiz 9166: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9167: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9168: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9169: </ol></div>
9170: </div>
1.148 asau 9171: <div class="sect2">
1.85 jmmv 9172: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9173: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9174: emulation</h3></div></div></div>
9175: <p>There are some packages that provide libraries and
9176: executables for running binaries from a one operating system
9177: on a different one (if the latter supports it). One example
9178: is running Linux binaries on NetBSD.</p>
1.189 snj 9179: <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 9180: helps in extracting and packaging Linux rpm packages.</p>
9181: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9182: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9183: if all libraries for each installed executable can be found by
9184: the dynamic linker. Since the standard dynamic linker is run,
9185: this fails for emulation packages, because the libraries used
9186: by the emulation are not in the standard directories.</p>
9187: </div>
1.148 asau 9188: <div class="sect2">
1.87 wiz 9189: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9190: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9191: <p>If a package installs images under the
1.87 wiz 9192: <code class="filename">share/icons/hicolor</code> and/or updates the
9193: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9194: database, you need to take some extra steps to make sure that the
9195: shared theme directory is handled appropriately and that the cache
9196: database is rebuilt:</p>
1.128 wiz 9197: <div class="orderedlist"><ol class="orderedlist" type="1">
9198: <li class="listitem"><p>Include
1.87 wiz 9199: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9200: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9201: entry that refers to the theme cache.</p></li>
1.128 wiz 9202: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9203: directories from the <code class="filename">share/icons/hicolor</code>
9204: hierarchy because they will be handled automatically.</p></li>
9205: </ol></div>
9206: <p>The best way to verify that the PLIST is correct with
9207: respect to the last two points is to regenerate it using
1.110 hubertf 9208: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9209: </div>
1.148 asau 9210: <div class="sect2">
1.85 jmmv 9211: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9212: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9213: <p>If a package installs <code class="filename">.desktop</code> files
9214: under <code class="filename">share/applications</code> and these include
1.159 rodent 9215: MIME information (MimeType key), you need to take extra steps to
9216: ensure that they are registered into the MIME database:</p>
1.128 wiz 9217: <div class="orderedlist"><ol class="orderedlist" type="1">
9218: <li class="listitem"><p>Include
1.85 jmmv 9219: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9220: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9221: <code class="filename">share/applications/mimeinfo.cache</code> file.
9222: It will be handled automatically.</p></li>
9223: </ol></div>
9224: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9225: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9226: print-PLIST</strong></span>.</p>
1.75 rillig 9227: </div>
9228: </div>
1.148 asau 9229: <div class="sect1">
1.87 wiz 9230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9231: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9232: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9233: immediately. In this case, one can plainly mark a package as broken. For
9234: this, one just sets the variable <code class="varname">BROKEN</code> to the
9235: reason why the package is broken (similar to the
9236: <code class="varname">RESTRICTED</code> variable). A user trying to build
9237: the package will immediately be shown this message, and the build
9238: will not be even tried.</p>
9239: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9240: intervals.</p>
9241: </div>
1.75 rillig 9242: </div>
1.148 asau 9243: <div class="chapter">
1.75 rillig 9244: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9245: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9246: <p>To check out all the gotchas when building a package, here are
9247: the steps that I do in order to get a package working. Please note
9248: this is basically the same as what was explained in the previous
9249: sections, only with some debugging aids.</p>
1.148 asau 9250: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9251: <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>
9252: <li class="listitem">
1.189 snj 9253: <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 9254: create a directory for a new package, change into it, then run
1.110 hubertf 9255: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9256: <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>
9257: <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>
9258: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9259: </li>
1.128 wiz 9260: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9261: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9262: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9263: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9264: configure step to the package's
9265: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9266: <li class="listitem">
1.75 rillig 9267: <p>Make the package compile, doing multiple rounds of</p>
9268: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9269: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9270: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9271: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9272: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9273: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9274: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9275: <p>Doing this step as non-root user will ensure that no files
9276: are modified that shouldn't be, especially during the build
1.110 hubertf 9277: phase. <span class="command"><strong>mkpatches</strong></span>,
9278: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.189 snj 9279: 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 9280: package.</p>
1.75 rillig 9281: </li>
1.128 wiz 9282: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9283: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9284: <li class="listitem">
1.76 rillig 9285: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9286: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9287: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9288: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9289: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9290: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9291: <p>You usually need to be <code class="username">root</code> to do
9292: this. Look if there are any files left:</p>
1.75 rillig 9293: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9294: <p>If this reveals any files that are missing in
1.88 wiz 9295: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9296: </li>
1.128 wiz 9297: <li class="listitem">
1.88 wiz 9298: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9299: package again and make a binary package:</p>
1.75 rillig 9300: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9301: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9302: </li>
1.128 wiz 9303: <li class="listitem">
1.75 rillig 9304: <p>Delete the installed package:</p>
1.88 wiz 9305: <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 9306: </li>
1.128 wiz 9307: <li class="listitem">
1.110 hubertf 9308: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9309: command, which shouldn't find anything now:</p>
1.75 rillig 9310: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9311: </li>
1.128 wiz 9312: <li class="listitem">
1.75 rillig 9313: <p>Reinstall the binary package:</p>
1.93 rillig 9314: <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 9315: </li>
1.128 wiz 9316: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9317: <li class="listitem">
1.189 snj 9318: <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 9319: reports:</p>
1.75 rillig 9320: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9321: </li>
1.128 wiz 9322: <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 9323: </ul></div>
9324: </div>
1.148 asau 9325: <div class="chapter">
1.75 rillig 9326: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9327: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9328: <div class="toc">
9329: <p><b>Table of Contents</b></p>
1.195 wiz 9330: <dl class="toc">
1.106 rillig 9331: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9332: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9333: <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 9334: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9335: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9336: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9337: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9338: </dl>
9339: </div>
1.148 asau 9340: <div class="sect1">
1.75 rillig 9341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9342: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9343: <p>Our policy is that we accept binaries only from pkgsrc
9344: developers to guarantee that the packages don't contain any
9345: trojan horses etc. This is not to annoy anyone but rather to
9346: protect our users! You're still free to put up your home-made
9347: binary packages and tell the world where to get them. NetBSD
9348: developers doing bulk builds and wanting to upload them please
1.174 asau 9349: 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
9350: builds)</i></a>.</p>
1.75 rillig 9351: </div>
1.148 asau 9352: <div class="sect1">
1.75 rillig 9353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9354: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9355: <p>First, check that your package is complete, compiles and
1.110 hubertf 9356: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.189 snj 9357: 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 9358: archive that contains all files that make up the package.
1.87 wiz 9359: Finally, send this package to the pkgsrc bug tracking system,
1.189 snj 9360: 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 9361: that, go to the web page
1.110 hubertf 9362: <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 9363: which contains some instructions and a link to a form where you
9364: can submit packages. The
1.189 snj 9365: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124 snj 9366: also available as a substitute for either of the above two tools.
9367: </p>
1.87 wiz 9368: <p>In the form of the problem report, the category should be
1.128 wiz 9369: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9370: and version number, and the description field should contain a
9371: short description of your package (contents of the COMMENT
9372: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9373: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9374: <p>If you want to submit several packages, please send a
9375: separate PR for each one, it's easier for us to track things
9376: that way.</p>
9377: <p>Alternatively, you can also import new packages into
1.128 wiz 9378: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9379: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9380: for details.</p>
9381: </div>
1.148 asau 9382: <div class="sect1">
1.75 rillig 9383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9384: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9385: <p>Please note all package additions, updates, moves, and
1.93 rillig 9386: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9387: important to keep this file up to date and conforming to the
9388: existing format, because it will be used by scripts to
1.110 hubertf 9389: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9390: sites. Additionally, check the
1.76 rillig 9391: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9392: for the package you updated or removed, in case it was mentioned
9393: there.</p>
9394: <p>When the <code class="varname">PKGREVISION</code> of a package is
9395: bumped, the change should appear in
1.93 rillig 9396: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9397: related or otherwise relevant. Mass bumps that result from a
9398: dependency being updated should not be mentioned. In all other
9399: cases it's the developer's decision.</p>
9400: <p>There is a make target that helps in creating proper
1.110 hubertf 9401: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9402: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9403: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9404: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9405: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9406: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9407: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9408: For new packages, or package moves or removals, set the
9409: <code class="varname">CTYPE</code> variable on the command line to "Added",
9410: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9411: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9412: not the same as your NetBSD login name. The target also automatically
9413: removes possibly existing entries for the package in the
9414: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9415: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9416: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9417: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9418: makes the cvs commands use the main repository.
9419: </p>
1.75 rillig 9420: </div>
1.148 asau 9421: <div class="sect1">
1.75 rillig 9422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9423: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9424: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9425: access to the pkgsrc repository.</p>
9426: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9427: Start by adding the directory and then files in the directory. Don't
9428: forget to add the new package to the category's
9429: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9430: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9431: <pre class="programlisting">
9432: <code class="prompt">$</code> cd .../pkgsrc/category
9433: <code class="prompt">$</code> cvs add pkgname
9434: <code class="prompt">$</code> cd pkgname
9435: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9436: <code class="prompt">$</code> cvs add patches/p*
9437: <code class="prompt">$</code> cvs status | less
1.141 wiz 9438: <code class="prompt">$</code> cvs commit
1.140 wiz 9439: <code class="prompt">$</code> cd ..
9440: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9441: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9442: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9443: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9444: </pre>
1.87 wiz 9445: <p>The commit message of the initial import should include part of the
1.76 rillig 9446: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9447: what the package is/does.</p>
1.140 wiz 9448: <p>Also mention the new package in
9449: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9450: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9451: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9452: </div>
1.148 asau 9453: <div class="sect1">
1.75 rillig 9454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9455: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9456: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9457: changes between old and new versions into the commit log when updating
1.87 wiz 9458: a package. There are various reasons for this:</p>
1.148 asau 9459: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9460: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9461: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9462: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9463: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9464: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9465: repository is very useful for people who read the pkgsrc-changes mailing
9466: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9467: the package.</p></li>
1.75 rillig 9468: </ul></div>
1.87 wiz 9469: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9470: has been released, it should not automatically be upgraded in the CVS
9471: repository. We prefer to be conservative in the packages that are
9472: included in pkgsrc - development or beta packages are not really the
9473: best thing for most places in which pkgsrc is used. Please use your
9474: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9475: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9476: </div>
1.148 asau 9477: <div class="sect1">
1.75 rillig 9478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9479: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9480: <p>Renaming packages is not recommended.</p>
9481: <p>When renaming packages, be sure to fix any references to old name
9482: in other Makefiles, options, buildlink files, etc.</p>
9483: <p>Also When renaming a package, please define
9484: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9485: pattern(s) of the previous package name.
9486: This may be repeated for multiple renames.
9487: The new package would be an exact replacement.
9488: </p>
1.128 wiz 9489: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9490: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9491: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9492: not be an exact replacement but is a suggestion for the replaced
9493: functionality.</p>
9494: </div>
1.148 asau 9495: <div class="sect1">
1.122 reed 9496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9497: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9498: <p>It is preferred that packages are not renamed or moved, but if needed
9499: please follow these steps.
9500: </p>
1.128 wiz 9501: <div class="orderedlist"><ol class="orderedlist" type="1">
9502: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9503: <li class="listitem">
1.75 rillig 9504: <p>Remove all CVS dirs.</p>
1.87 wiz 9505: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9506: <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 9507: <p>and use that for further work.</p>
1.75 rillig 9508: </li>
1.128 wiz 9509: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9510: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9511: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9512: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9513: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9514: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9515: for doing an update using pkgsrc building; for example, it can
1.189 snj 9516: 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 9517: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9518: new <code class="varname">PKGPATH</code> for that moved package. Note that
9519: it may have multiple matches, so the tool should also check on the
9520: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9521: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9522: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9523: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9524: place.</p></li>
1.128 wiz 9525: <li class="listitem">
1.75 rillig 9526: <p>Check if any package depends on it:
9527: </p>
9528: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9529: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9530: </li>
1.128 wiz 9531: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9532: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9533: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9534: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9535: <li class="listitem">
1.75 rillig 9536: <p>Commit the changed and removed files:</p>
9537: <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 9538: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9539: </li>
9540: </ol></div>
9541: </div>
9542: </div>
1.148 asau 9543: <div class="chapter">
1.75 rillig 9544: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9545: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9546: <p>This section contains the answers to questions that may
9547: arise when you are writing a package. If you don't find your
9548: question answered here, first have a look in the other chapters,
9549: and if you still don't have the answer, ask on the
9550: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9551: <div class="qandaset">
1.200 ! tnn 9552: <a name="idm72614864"></a><dl>
1.106 rillig 9553: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9554: MAKEFLAGS, .MAKEFLAGS and
9555: MAKE_FLAGS?</a>
9556: </dt>
1.106 rillig 9557: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9558: MAKE, GMAKE and
9559: MAKE_PROGRAM?</a>
9560: </dt>
1.106 rillig 9561: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9562: CC, PKG_CC and
9563: PKGSRC_COMPILER?</a>
9564: </dt>
1.106 rillig 9565: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9566: BUILDLINK_LDFLAGS,
9567: BUILDLINK_LDADD and
9568: BUILDLINK_LIBS?</a>
9569: </dt>
1.106 rillig 9570: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9571: VARNAME=BUILDLINK_PREFIX.foo
9572: say it's empty?</a>
9573: </dt>
1.106 rillig 9574: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9575: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9576: don't understand the := inside
9577: it.</a>
9578: </dt>
1.106 rillig 9579: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9580: developers?</a>
9581: </dt>
1.106 rillig 9582: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9583: documentation?</a>
9584: </dt>
1.106 rillig 9585: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9586: do?</a>
9587: </dt>
1.75 rillig 9588: </dl>
1.148 asau 9589: <table border="0" style="width: 100%;">
9590: <colgroup>
1.75 rillig 9591: <col align="left" width="1%">
1.128 wiz 9592: <col>
1.148 asau 9593: </colgroup>
1.75 rillig 9594: <tbody>
1.148 asau 9595: <tr class="question">
1.75 rillig 9596: <td align="left" valign="top">
1.200 ! tnn 9597: <a name="devfaq.makeflags"></a><a name="idm72614480"></a><p><b>22.1.</b></p>
1.75 rillig 9598: </td>
9599: <td align="left" valign="top"><p>What is the difference between
9600: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9601: <code class="varname">MAKE_FLAGS</code>?</p></td>
9602: </tr>
9603: <tr class="answer">
1.91 rillig 9604: <td align="left" valign="top"></td>
1.75 rillig 9605: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.189 snj 9606: 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 9607: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9608: the <code class="varname">MAKE_PROGRAM</code> when building the
9609: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9610: </tr>
1.148 asau 9611: <tr class="question">
1.75 rillig 9612: <td align="left" valign="top">
1.200 ! tnn 9613: <a name="devfaq.make"></a><a name="idm72610384"></a><p><b>22.2.</b></p>
1.75 rillig 9614: </td>
9615: <td align="left" valign="top"><p>What is the difference between
9616: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9617: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9618: </tr>
9619: <tr class="answer">
1.91 rillig 9620: <td align="left" valign="top"></td>
1.75 rillig 9621: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.189 snj 9622: <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 9623: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9624: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9625: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9626: Make program that is used for building the
9627: package.</p></td>
9628: </tr>
1.148 asau 9629: <tr class="question">
1.75 rillig 9630: <td align="left" valign="top">
1.200 ! tnn 9631: <a name="devfaq.cc"></a><a name="idm72606032"></a><p><b>22.3.</b></p>
1.75 rillig 9632: </td>
9633: <td align="left" valign="top"><p>What is the difference between
9634: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9635: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9636: </tr>
9637: <tr class="answer">
1.91 rillig 9638: <td align="left" valign="top"></td>
1.75 rillig 9639: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9640: compiler, which can be configured by the pkgsrc user.
9641: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9642: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9643: path to a compiler, but the type of compiler that should be
1.76 rillig 9644: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9645: information about the latter variable.</p></td>
9646: </tr>
1.148 asau 9647: <tr class="question">
1.75 rillig 9648: <td align="left" valign="top">
1.200 ! tnn 9649: <a name="devfaq.bl3flags"></a><a name="idm72601808"></a><p><b>22.4.</b></p>
1.75 rillig 9650: </td>
9651: <td align="left" valign="top"><p>What is the difference between
9652: <code class="varname">BUILDLINK_LDFLAGS</code>,
9653: <code class="varname">BUILDLINK_LDADD</code> and
9654: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9655: </tr>
9656: <tr class="answer">
1.91 rillig 9657: <td align="left" valign="top"></td>
1.75 rillig 9658: <td align="left" valign="top"><p>[FIXME]</p></td>
9659: </tr>
1.148 asau 9660: <tr class="question">
1.75 rillig 9661: <td align="left" valign="top">
1.200 ! tnn 9662: <a name="devfaq.bl3prefix"></a><a name="idm72599632"></a><p><b>22.5.</b></p>
1.75 rillig 9663: </td>
1.110 hubertf 9664: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9665: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9666: say it's empty?</p></td>
9667: </tr>
9668: <tr class="answer">
1.91 rillig 9669: <td align="left" valign="top"></td>
1.75 rillig 9670: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9671: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9672: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9673: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9674: command.</p></td>
9675: </tr>
1.148 asau 9676: <tr class="question">
1.78 rillig 9677: <td align="left" valign="top">
1.200 ! tnn 9678: <a name="devfaq.master_sites"></a><a name="idm72596560"></a><p><b>22.6.</b></p>
1.78 rillig 9679: </td>
9680: <td align="left" valign="top"><p>What does
9681: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9682: don't understand the <code class="literal">:=</code> inside
9683: it.</p></td>
9684: </tr>
9685: <tr class="answer">
1.91 rillig 9686: <td align="left" valign="top"></td>
1.78 rillig 9687: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9688: assignment operator, like you might expect at first sight.
9689: Instead, it is a degenerate form of
9690: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.189 snj 9691: 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 9692: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9693: case of <code class="varname">MASTER_SITE_*</code>,
9694: <em class="replaceable"><code>old_string</code></em> is the empty string and
9695: <em class="replaceable"><code>new_string</code></em> is
9696: <code class="literal">package/</code>. That's where the
9697: <code class="literal">:</code> and the <code class="literal">=</code> fall
9698: together.</p></td>
9699: </tr>
1.148 asau 9700: <tr class="question">
1.78 rillig 9701: <td align="left" valign="top">
1.200 ! tnn 9702: <a name="devfaq.mailinglists"></a><a name="idm74677456"></a><p><b>22.7.</b></p>
1.78 rillig 9703: </td>
9704: <td align="left" valign="top"><p>Which mailing lists are there for package
9705: developers?</p></td>
9706: </tr>
9707: <tr class="answer">
1.91 rillig 9708: <td align="left" valign="top"></td>
1.148 asau 9709: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9710: <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 9711: <dd><p>This is a list for technical discussions related
9712: to pkgsrc development, e.g. soliciting feedback for changes to
9713: pkgsrc infrastructure, proposed new features, questions related
9714: to porting pkgsrc to a new platform, advice for maintaining a
9715: package, patches that affect many packages, help requests moved
9716: from pkgsrc-users when an infrastructure bug is found,
9717: etc.</p></dd>
1.110 hubertf 9718: <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 9719: <dd><p>All bug reports in category "pkg" sent with
1.189 snj 9720: <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 9721: directly; use one of the other mailing
9722: lists.</p></dd>
9723: </dl></div></td>
9724: </tr>
1.148 asau 9725: <tr class="question">
1.80 rillig 9726: <td align="left" valign="top">
1.200 ! tnn 9727: <a name="devfaq.documentation"></a><a name="idm74673616"></a><p><b>22.8.</b></p>
1.80 rillig 9728: </td>
9729: <td align="left" valign="top"><p>Where is the pkgsrc
9730: documentation?</p></td>
9731: </tr>
9732: <tr class="answer">
1.91 rillig 9733: <td align="left" valign="top"></td>
1.80 rillig 9734: <td align="left" valign="top">
9735: <p>There are many places where you can find
9736: documentation about pkgsrc:</p>
1.148 asau 9737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9738: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9739: of chapters that explain large parts of pkgsrc, but some
9740: chapters tend to be outdated. Which ones they are is hard to
9741: say.</p></li>
1.128 wiz 9742: <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 9743: about certain features, announcements of new parts of the pkgsrc
9744: infrastructure and sometimes even announcements that a certain
9745: feature has been marked as obsolete. The benefit here is that
9746: each message has a date appended to it.</p></li>
1.128 wiz 9747: <li class="listitem"><p>Many of the files in the
1.80 rillig 9748: <code class="filename">mk/</code> directory start with a comment that
9749: describes the purpose of the file and how it can be used by the
1.92 rillig 9750: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9751: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9752: help</strong></span>.</p></li>
1.128 wiz 9753: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9754: information, but they tend to be highly abbreviated, especially
9755: for actions that occur often. Some contain a detailed
9756: description of what has changed, but they are geared towards the
9757: other pkgsrc developers, not towards an average pkgsrc user.
9758: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9759: don't know what has been before, these messages may not be worth
9760: too much to you.</p></li>
1.128 wiz 9761: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9762: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9763: mind of the developer who wrote the code. To get this
1.110 hubertf 9764: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9765: to see who has written it and ask on the
9766: <code class="literal">tech-pkg</code> mailing list, so that others can
9767: find your questions later (see above). To be sure that the
9768: developer in charge reads the mail, you may CC him or
9769: her.</p></li>
9770: </ul></div>
9771: </td>
9772: </tr>
1.148 asau 9773: <tr class="question">
1.92 rillig 9774: <td align="left" valign="top">
1.200 ! tnn 9775: <a name="devfaq.too-much-time"></a><a name="idm74667088"></a><p><b>22.9.</b></p>
1.92 rillig 9776: </td>
9777: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9778: do?</p></td>
9779: </tr>
9780: <tr class="answer">
9781: <td align="left" valign="top"></td>
9782: <td align="left" valign="top">
1.93 rillig 9783: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9784: anyway.</p>
1.148 asau 9785: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9786: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.189 snj 9787: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.92 rillig 9788: will tell you about newer versions of installed packages that are
9789: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9790: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9791: — it contains a list of suggested new packages and a list of
1.92 rillig 9792: cleanups and enhancements for pkgsrc that would be nice to
9793: have.</p></li>
1.128 wiz 9794: <li class="listitem"><p>Review packages for which review was requested on
1.180 wiz 9795: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92 rillig 9796: mailing list.</p></li>
9797: </ul></div>
9798: </td>
9799: </tr>
1.75 rillig 9800: </tbody>
9801: </table>
9802: </div>
9803: </div>
1.148 asau 9804: <div class="chapter">
1.85 jmmv 9805: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9806: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9807: <div class="toc">
9808: <p><b>Table of Contents</b></p>
1.195 wiz 9809: <dl class="toc">
1.106 rillig 9810: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9811: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9812: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9813: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9814: </dl>
9815: </div>
1.110 hubertf 9816: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9817: site</a>:</p>
9818: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9819: environment, an intuitive and attractive desktop for users, and the
9820: GNOME development platform, an extensive framework for building
9821: applications that integrate into the rest of the desktop.</p></blockquote></div>
9822: <p>pkgsrc provides a seamless way to automatically build and install
9823: a complete GNOME environment <span class="emphasis"><em>under many different
9824: platforms</em></span>. We can say with confidence that pkgsrc is one of
9825: the most advanced build and packaging systems for GNOME due to its
9826: included technologies buildlink3, the wrappers and tools framework and
9827: automatic configuration file management. Lots of efforts are put into
9828: achieving a completely clean deinstallation of installed software
9829: components.</p>
1.110 hubertf 9830: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9831: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9832: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9833: pkgsrc as its preferred packaging system, contributing lots of
9834: portability fixes to make GNOME build and install under it.</p>
9835: <p>This chapter is aimed at pkgsrc developers and other people
9836: interested in helping our GNOME porting and packaging efforts. It
9837: provides instructions on how to manage the existing packages and some
9838: important information regarding their internals.</p>
1.148 asau 9839: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9840: <h3 class="title">We need your help!</h3>
9841: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9842: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9843: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9844: work</a> list! There is still a long way to go to get a
9845: fully-functional GNOME desktop under NetBSD and we need your help to
9846: achieve it!</p>
9847: </div>
1.148 asau 9848: <div class="sect1">
1.85 jmmv 9849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9850: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9851: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9852: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189 snj 9853: <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 9854: the core GNOME desktop environment. It only includes the necessary
9855: bits to get it to boot correctly, although it may lack important
9856: functionality for daily operation. The idea behind this package is
9857: to let end users build their own configurations on top of this one,
9858: first installing this meta package to achieve a functional setup and
9859: then adding individual applications.</p></li>
1.189 snj 9860: <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 9861: complete installation of the GNOME platform and desktop as defined
9862: by the GNOME project; this is based on the components distributed in
9863: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9864: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9865: official FTP server. Developer-only tools found in those
9866: directories are not installed unless required by some other
9867: component to work properly. Similarly, packages from the bindings
9868: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9869: in unless required as a dependency for an end-user component. This
1.189 snj 9870: 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>
9871: <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 9872: Installs all the tools required to build a GNOME component when
9873: fetched from the CVS repository. These are required to let the
1.110 hubertf 9874: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9875: </ul></div>
9876: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9877: sorted in a way that eases updates: a package may depend on other
9878: packages listed before it but not on any listed after it. It is very
9879: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9880: change it to alphabetical sorting!</em></span></p>
9881: </div>
1.148 asau 9882: <div class="sect1">
1.85 jmmv 9883: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9884: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9885: <p>Almost all GNOME applications are written in C and use a common
9886: set of tools as their build system. Things get different with the new
9887: bindings to other languages (such as Python), but the following will
9888: give you a general idea on the minimum required tools:</p>
1.148 asau 9889: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9890: <li class="listitem">
1.85 jmmv 9891: <p>Almost all GNOME applications use the GNU Autotools as their
9892: build system. As a general rule you will need to tell this to your
9893: package:</p>
1.100 rillig 9894: <pre class="programlisting">
9895: GNU_CONFIGURE=yes
1.85 jmmv 9896: USE_LIBTOOL=yes
1.100 rillig 9897: USE_TOOLS+=gmake
9898: </pre>
1.85 jmmv 9899: </li>
1.128 wiz 9900: <li class="listitem">
1.85 jmmv 9901: <p>If the package uses pkg-config to detect dependencies, add this
9902: tool to the list of required utilities:</p>
9903: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.189 snj 9904: <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 9905: the end of the build process to ensure that you did not miss to
9906: specify any dependency in your package and that the version
9907: requirements are all correct.</p>
9908: </li>
1.128 wiz 9909: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9910: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9911: to handle dependencies and to force the package to use the latest
9912: available version.</p></li>
1.128 wiz 9913: <li class="listitem">
1.85 jmmv 9914: <p>If the package uses gtk-doc (a documentation generation
9915: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9916: tool is rather big and the distfile should come with pregenerated
9917: documentation anyway; if it does not, it is a bug that you ought to
9918: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9919: the default):</p>
9920: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9921: <p>The default location of installed HTML files
9922: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9923: and should not be changed unless the package insists on installing
9924: them somewhere else. Otherwise programs as
1.110 hubertf 9925: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9926: do that with an entry similar to:</p>
9927: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9928: </li>
9929: </ul></div>
9930: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9931: files under the installation prefix to maintain databases. In this
9932: context, shared means that those exact same directories and files are
9933: used among several different packages, leading to conflicts in the
9934: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9935: handle the most common cases, so you have to forget about using
9936: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9937: omitting shared files from them. If you find yourself doing those,
9938: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9939: <p>The following table lists the common situations that result in
9940: using shared directories or files. For each of them, the appropriate
9941: solution is given. After applying the solution be sure to
9942: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9943: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9944: <div class="table">
1.106 rillig 9945: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9946: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9947: <colgroup>
9948: <col>
9949: <col>
9950: </colgroup>
9951: <thead><tr>
9952: <th>If the package...</th>
9953: <th>Then...</th>
9954: </tr></thead>
9955: <tbody>
9956: <tr>
9957: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9958: <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 9959: </tr>
9960: <tr>
9961: <td>Installs icons under the
9962: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9963: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9964: <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 9965: </tr>
9966: <tr>
9967: <td>Installs files under
9968: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9969: <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 9970: </tr>
9971: <tr>
9972: <td>Installs <code class="filename">.desktop</code> files under
9973: <code class="filename">share/applications</code> and these include MIME
9974: information.</td>
1.110 hubertf 9975: <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 9976: </tr>
9977: </tbody>
1.91 rillig 9978: </table></div>
1.85 jmmv 9979: </div>
1.91 rillig 9980: <br class="table-break">
1.85 jmmv 9981: </div>
1.148 asau 9982: <div class="sect1">
1.85 jmmv 9983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9984: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9985: <p>When seeing GNOME as a whole, there are two kinds of
9986: updates:</p>
1.148 asau 9987: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9988: <dt><span class="term">Major update</span></dt>
9989: <dd>
9990: <p>Given that there is still a very long way for GNOME 3 (if it
9991: ever appears), we consider a major update one that goes from a
9992: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9993: where <code class="literal">Y</code> is even and greater than
9994: <code class="literal">X</code>. These are hard to achieve because they
9995: introduce lots of changes in the components' code and almost all
9996: GNOME distfiles are updated to newer versions. Some of them can
9997: even break API and ABI compatibility with the previous major
9998: version series. As a result, the update needs to be done all at
9999: once to minimize breakage.</p>
10000: <p>A major update typically consists of around 80 package
10001: updates and the addition of some new ones.</p>
10002: </dd>
10003: <dt><span class="term">Minor update</span></dt>
10004: <dd>
10005: <p>We consider a minor update one that goes from a
10006: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10007: one where <code class="literal">Y</code> is greater than
10008: <code class="literal">X</code>. These are easy to achieve because they do
10009: not update all GNOME components, can be done in an incremental way
10010: and do not break API nor ABI compatibility.</p>
10011: <p>A minor update typically consists of around 50 package
10012: updates, although the numbers here may vary a lot.</p>
10013: </dd>
10014: </dl></div>
10015: <p>In order to update the GNOME components in pkgsrc to a new stable
10016: release (either major or minor), the following steps should be
10017: followed:</p>
1.128 wiz 10018: <div class="orderedlist"><ol class="orderedlist" type="1">
10019: <li class="listitem">
1.85 jmmv 10020: <p>Get a list of all the tarballs that form the new release by
10021: using the following commands. These will leave the full list of the
1.120 snj 10022: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 10023: file:</p>
1.88 wiz 10024: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10025: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10026: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10027: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10028: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10029: awk '{ print $9 }' >>list.txt</code></strong></pre>
10030: </li>
1.128 wiz 10031: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 10032: bump their version to the release you are updating them to. The
10033: three meta packages should be always consistent with versioning.
10034: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10035: in them.</p></li>
1.128 wiz 10036: <li class="listitem">
1.85 jmmv 10037: <p>For each meta package, update all its
10038: <code class="varname">DEPENDS</code> lines to match the latest versions as
10039: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10040: newer version (even if found in the FTP) because the meta packages
10041: are supposed to list the exact versions that form a specific GNOME
10042: release. Exceptions are permitted here if a newer version solves a
10043: serious issue in the overall desktop experience; these typically
10044: come in the form of a revision bump in pkgsrc, not in newer versions
10045: from the developers.</p>
10046: <p>Packages not listed in the <code class="filename">list.txt</code> file
10047: should be updated to the latest version available (if found in
10048: pkgsrc). This is the case, for example, of the dependencies on the
1.189 snj 10049: 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 10050: </li>
1.128 wiz 10051: <li class="listitem">
1.85 jmmv 10052: <p>Generate a patch from the modified meta packages and extract the
10053: list of "new" lines. This will provide you an outline on what
10054: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10055: <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 10056: </li>
1.128 wiz 10057: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 10058: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 10059: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 10060: of <code class="filename">todo.txt</code> and update the packages listed in
10061: it in order. For major desktop updates none of these should be
1.93 rillig 10062: committed until the entire set is completed because there are chances
1.85 jmmv 10063: of breaking not-yet-updated packages.</p></li>
1.128 wiz 10064: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 10065: the tree one by one with appropriate log messages. At the end,
10066: commit the three meta package updates and all the corresponding
10067: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10068: <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>
10069: </ol></div>
10070: </div>
1.148 asau 10071: <div class="sect1">
1.85 jmmv 10072: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10073: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10074: <p>GNOME is a very big component in pkgsrc which approaches 100
10075: packages. Please, it is very important that you always, always,
10076: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 10077: 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 10078: their attention on portability issues and to ensure that future versions
10079: can be built out-of-the box on NetBSD. The less custom patches in
10080: pkgsrc, the easier further updates are. Those developers in charge of
10081: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10082: <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 10083: Bugzilla</a>. Not all components use these to track bugs, but most
10084: of them do. Do not be short on your reports: always provide detailed
10085: explanations of the current failure, how it can be improved to achieve
10086: maximum portability and, if at all possible, provide a patch against CVS
10087: head. The more verbose you are, the higher chances of your patch being
10088: accepted.</p>
10089: <p>Also, please avoid using preprocessor magic to fix portability
10090: issues. While the FreeBSD GNOME people are doing a great job in porting
10091: GNOME to their operating system, the official GNOME sources are now
10092: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10093: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10094: 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 10095: details.</p>
10096: </div>
10097: </div>
1.75 rillig 10098: </div>
1.148 asau 10099: <div class="part">
1.75 rillig 10100: <div class="titlepage"><div><div><h1 class="title">
10101: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10102: <div class="partintro">
1.75 rillig 10103: <div></div>
10104: <p>This part of the guide deals with everything
10105: from the infrastructure that is behind the interfaces described
10106: in the developer's guide. A casual package maintainer should not
10107: need anything from this part.</p>
10108: <div class="toc">
10109: <p><b>Table of Contents</b></p>
1.195 wiz 10110: <dl class="toc">
1.106 rillig 10111: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10112: <dd><dl>
1.106 rillig 10113: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10114: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10115: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10116: <dd><dl>
1.106 rillig 10117: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10118: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10119: </dl></dd>
1.106 rillig 10120: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10121: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10122: <dd><dl>
1.106 rillig 10123: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10124: <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 10125: </dl></dd>
1.106 rillig 10126: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10127: <dd><dl>
1.128 wiz 10128: <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>
10129: <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 10130: </dl></dd>
10131: </dl></dd>
1.106 rillig 10132: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10133: <dd><dl>
1.106 rillig 10134: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10135: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10136: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10137: <dd><dl>
1.106 rillig 10138: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10139: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10140: </dl></dd>
10141: </dl></dd>
1.106 rillig 10142: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10143: <dd><dl>
1.106 rillig 10144: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10145: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10146: </dl></dd>
10147: </dl>
10148: </div>
10149: </div>
1.148 asau 10150: <div class="chapter">
1.75 rillig 10151: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10152: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10153: <div class="toc">
10154: <p><b>Table of Contents</b></p>
1.195 wiz 10155: <dl class="toc">
1.106 rillig 10156: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10157: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10158: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10159: <dd><dl>
1.106 rillig 10160: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10161: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10162: </dl></dd>
1.106 rillig 10163: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10164: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10165: <dd><dl>
1.106 rillig 10166: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10167: <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 10168: </dl></dd>
1.106 rillig 10169: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10170: <dd><dl>
1.128 wiz 10171: <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>
10172: <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 10173: </dl></dd>
10174: </dl>
10175: </div>
10176: <p>The pkgsrc infrastructure consists of many small Makefile
10177: fragments. Each such fragment needs a properly specified
10178: interface. This chapter explains how such an interface looks
10179: like.</p>
1.148 asau 10180: <div class="sect1">
1.75 rillig 10181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10182: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10183: <p>Whenever a variable is defined in the pkgsrc
10184: infrastructure, the location and the way of definition provide
10185: much information about the intended use of that variable.
10186: Additionally, more documentation may be found in a header
10187: comment or in this pkgsrc guide.</p>
10188: <p>A special file is
10189: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10190: variables that are intended to be user-defined. They are either
10191: defined using the <code class="literal">?=</code> operator or they are
10192: left undefined because defining them to anything would
1.128 wiz 10193: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10194: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10195: file.</p>
10196: <p>Outside this file, the following conventions apply:
10197: Variables that are defined using the <code class="literal">?=</code>
10198: operator may be overridden by a package.</p>
10199: <p>Variables that are defined using the <code class="literal">=</code>
10200: operator may be used read-only at run-time.</p>
10201: <p>Variables whose name starts with an underscore must not be
10202: accessed outside the pkgsrc infrastructure at all. They may
10203: change without further notice.</p>
1.148 asau 10204: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10205: <h3 class="title">Note</h3>
10206: <p>These conventions are currently not applied
10207: consistently to the complete pkgsrc
10208: infrastructure.</p>
10209: </div>
10210: </div>
1.148 asau 10211: <div class="sect1">
1.81 rillig 10212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10213: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10214: <p>All variables that contain lists of things should default
10215: to being empty. Two examples that do not follow this rule are
10216: <code class="varname">USE_LANGUAGES</code> and
10217: <code class="varname">DISTFILES</code>. These variables cannot simply be
10218: modified using the <code class="literal">+=</code> operator in package
10219: <code class="filename">Makefile</code>s (or other files included by
10220: them), since there is no guarantee whether the variable is
10221: already set or not, and what its value is. In the case of
1.128 wiz 10222: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10223: the default value and just define it as in the following
10224: example.</p>
10225: <pre class="programlisting">
1.100 rillig 10226: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10227: </pre>
10228: <p>Because of the selection of this default value, the same
10229: value appears in many package Makefiles. Similarly for
10230: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10231: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10232: doesn't stand out. Nevertheless it is mentioned in many
10233: files.</p>
10234: </div>
1.148 asau 10235: <div class="sect1">
1.81 rillig 10236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10237: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 10238: <div class="sect2">
1.75 rillig 10239: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10240: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10241: <p>Variable evaluation takes place either at load time or at
10242: runtime, depending on the context in which they occur. The
10243: contexts where variables are evaluated at load time are:</p>
1.148 asau 10244: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10245: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10246: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10247: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10248: <code class="literal">.for</code>,</p></li>
1.128 wiz 10249: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10250: </ul></div>
10251: <p>A special exception are references to the iteration
10252: variables of <code class="literal">.for</code> loops, which are expanded
10253: inline, no matter in which context they appear.</p>
10254: <p>As the values of variables may change during load time,
10255: care must be taken not to evaluate them by accident. Typical
10256: examples for variables that should not be evaluated at load time
10257: are <code class="varname">DEPENDS</code> and
10258: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10259: clear, here is an example:</p>
10260: <pre class="programlisting">
1.100 rillig 10261: CONFIGURE_ARGS= # none
10262: CFLAGS= -O
10263: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10264:
1.100 rillig 10265: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10266:
1.100 rillig 10267: CFLAGS+= -Wall
1.75 rillig 10268: </pre>
10269: <p>This code shows how the use of the <code class="literal">:=</code>
10270: operator can quickly lead to unexpected results. The first
10271: paragraph is fairly common code. The second paragraph evaluates
10272: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10273: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10274: <code class="literal">-Wall</code> is appended to the
10275: <code class="varname">CFLAGS</code>, but this addition will not appear in
10276: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10277: paragraphs from above typically occur in completely unrelated
10278: files.</p>
10279: </div>
1.148 asau 10280: <div class="sect2">
1.75 rillig 10281: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10282: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10283: <p>After all the files have been loaded, the values of the
10284: variables cannot be changed anymore. Variables that are used in
10285: the shell commands are expanded at this point.</p>
10286: </div>
10287: </div>
1.148 asau 10288: <div class="sect1">
1.75 rillig 10289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10290: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10291: <p>There are many ways in which the definition and use of a
10292: variable can be restricted in order to detect bugs and
10293: violations of the (mostly unwritten) policies. See the
10294: <code class="literal">pkglint</code> developer's documentation for further
10295: details.</p>
10296: </div>
1.148 asau 10297: <div class="sect1">
1.78 rillig 10298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10299: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10300: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10301: of the following classes. Cases where a file falls into more
10302: than one class should be avoided as it often leads to subtle
10303: bugs.</p>
1.148 asau 10304: <div class="sect2">
1.75 rillig 10305: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10306: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10307: <p>In a traditional imperative programming language some of
1.76 rillig 10308: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10309: procedures. They take some input parameters and—after
10310: inclusion—provide a result in output parameters. Since all
1.76 rillig 10311: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10312: care must be taken not to use parameter names that have already
10313: another meaning. For example, <code class="varname">PKGNAME</code> is a
10314: bad choice for a parameter name.</p>
10315: <p>Procedures are completely evaluated at preprocessing time.
10316: That is, when calling a procedure all input parameters must be
10317: completely resolvable. For example,
10318: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10319: parameter since it is very likely that further text will be
10320: added after calling the procedure, which would effectively apply
10321: the procedure to only a part of the variable. Also, references
10322: to other variables wit will be modified after calling the
10323: procedure.</p>
10324: <p>A procedure can declare its output parameters either as
10325: suitable for use in preprocessing directives or as only
10326: available at runtime. The latter alternative is for variables
10327: that contain references to other runtime variables.</p>
10328: <p>Procedures shall be written such that it is possible to
10329: call the procedure more than once. That is, the file must not
10330: contain multiple-inclusion guards.</p>
10331: <p>Examples for procedures are
1.76 rillig 10332: <code class="filename">mk/bsd.options.mk</code> and
10333: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10334: that the parameters are evaluated at load time, they should be
10335: assigned using the <code class="literal">:=</code> operator, which should
10336: be used only for this purpose.</p>
10337: </div>
1.148 asau 10338: <div class="sect2">
1.75 rillig 10339: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10340: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10341: <p>Action files take some input parameters and may define
10342: runtime variables. They shall not define loadtime variables.
10343: There are action files that are included implicitly by the
10344: pkgsrc infrastructure, while other must be included
10345: explicitly.</p>
10346: <p>An example for action files is
1.76 rillig 10347: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10348: </div>
10349: </div>
1.148 asau 10350: <div class="sect1">
1.81 rillig 10351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10352: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10353: <p>Package <code class="filename">Makefile</code>s usually consist of
10354: a set of variable definitions, and include the file
10355: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10356: Before that, they may also include various other
10357: <code class="filename">*.mk</code> files if they need to query the
10358: availability of certain features like the type of compiler or
10359: the X11 implementation. Due to the heavy use of preprocessor
10360: directives like <code class="literal">.if</code> and
10361: <code class="literal">.for</code>, the order in which the files are loaded
10362: matters.</p>
10363: <p>This section describes at which point the various files
10364: are loaded and gives reasons for that order.</p>
1.148 asau 10365: <div class="sect2">
1.81 rillig 10366: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10367: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10368: </h3></div></div></div>
10369: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10370: is to define some essential variables like
10371: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10372: <code class="varname">MACHINE_ARCH</code>.</p>
10373: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10374: 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 10375: After that, those variables
1.81 rillig 10376: that have not been overridden by the user are loaded from
10377: <code class="filename">mk/defaults/mk.conf</code>.</p>
10378: <p>After the user settings, the system settings and platform
10379: settings are loaded, which may override the user
10380: settings.</p>
10381: <p>Then, the tool definitions are loaded. The tool wrappers
10382: are not yet in effect. This only happens when building a
10383: package, so the proper variables must be used instead of the
10384: direct tool names.</p>
10385: <p>As the last steps, some essential variables from the
10386: wrapper and the package system flavor are loaded, as well as the
10387: variables that have been cached in earlier phases of a package
10388: build.</p>
10389: </div>
1.148 asau 10390: <div class="sect2">
1.81 rillig 10391: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10392: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10393: </h3></div></div></div>
1.81 rillig 10394: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10395: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10396: loaded, which fill default values for those variables that have
1.93 rillig 10397: not been defined by the package. These variables may later
1.81 rillig 10398: be used even in unrelated files.</p>
10399: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10400: provides the target <code class="literal">error-check</code> that is added
10401: as a special dependency to all other targets that use
10402: <code class="varname">DELAYED_ERROR_MSG</code> or
10403: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10404: <p>Then, the package-specific hacks from
10405: <code class="filename">hacks.mk</code> are included.</p>
10406: <p>Then, various other files follow. Most of them don't have
10407: any dependencies on what they need to have included before or
10408: after them, though some do.</p>
10409: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10410: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10411: restricts the use of these variables to all the files that have
10412: been included before. Appearances in later files will be
10413: silently ignored.</p>
10414: <p>Then, the files for the main targets are included, in the
10415: order of later execution, though the actual order should not
10416: matter.</p>
10417: <p>At last, some more files are included that don't set any
10418: interesting variables but rather just define make targets to be
10419: executed.</p>
10420: </div>
10421: </div>
1.75 rillig 10422: </div>
1.148 asau 10423: <div class="chapter">
1.75 rillig 10424: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10425: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10426: <div class="toc">
10427: <p><b>Table of Contents</b></p>
1.195 wiz 10428: <dl class="toc">
1.106 rillig 10429: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10430: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10431: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10432: <dd><dl>
1.106 rillig 10433: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10434: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10435: </dl></dd>
10436: </dl>
10437: </div>
10438: <p>The pkgsrc infrastructure consists of a large codebase,
10439: and there are many corners where every little bit of a file is
10440: well thought out, making pkgsrc likely to fail as soon as
10441: anything is changed near those parts. To prevent most changes
10442: from breaking anything, a suite of regression tests should go
10443: along with every important part of the pkgsrc infrastructure.
10444: This chapter describes how regression tests work in pkgsrc and
10445: how you can add new tests.</p>
1.148 asau 10446: <div class="sect1">
1.75 rillig 10447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10448: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10449: <p></p>
10450: </div>
1.148 asau 10451: <div class="sect1">
1.75 rillig 10452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10453: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.189 snj 10454: <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 10455: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10456: can simply run that command, which will run all tests in the
1.76 rillig 10457: <code class="filename">regress</code> category.</p>
1.75 rillig 10458: </div>
1.148 asau 10459: <div class="sect1">
1.75 rillig 10460: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10461: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10462: <p>Every directory in the <code class="filename">regress</code>
10463: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10464: is considered a regression test. This file is a shell program
1.110 hubertf 10465: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10466: The following functions can be overridden to suit your
10467: needs.</p>
1.148 asau 10468: <div class="sect2">
1.75 rillig 10469: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10470: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10471: <p>These functions do not take any parameters. They are all
1.128 wiz 10472: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10473: to check the exitcodes of any commands you run in the
10474: test.</p>
1.148 asau 10475: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10476: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10477: <dd><p>This function prepares the environment for the
10478: test. By default it does nothing.</p></dd>
10479: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10480: <dd><p>This function runs the actual test. By default,
10481: it calls <code class="varname">TEST_MAKE</code> with the arguments
10482: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10483: error messages into the file
10484: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10485: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10486: <dd><p>This function is run after the test and is
10487: typically used to compare the actual output from the one that is
10488: expected. It can make use of the various helper functions from
10489: the next section.</p></dd>
10490: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10491: <dd><p>This function cleans everything up after the
10492: test has been run. By default it does nothing.</p></dd>
10493: </dl></div>
10494: </div>
1.148 asau 10495: <div class="sect2">
1.75 rillig 10496: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10497: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 asau 10498: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10499: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10500: <dd><p>This function compares the exitcode of the
1.110 hubertf 10501: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10502: If they differ, the test will fail.</p></dd>
10503: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10504: <dd><p>This function checks for each of its parameters
1.110 hubertf 10505: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10506: extended regular expression. If it does not, the test will
10507: fail.</p></dd>
10508: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10509: <dd><p>This function checks for each of its parameters
1.110 hubertf 10510: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10511: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10512: If any of the regular expressions matches, the test will
10513: fail.</p></dd>
10514: </dl></div>
10515: </div>
10516: </div>
10517: </div>
1.148 asau 10518: <div class="chapter">
1.75 rillig 10519: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10520: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10521: <div class="toc">
10522: <p><b>Table of Contents</b></p>
1.195 wiz 10523: <dl class="toc">
1.106 rillig 10524: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10525: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10526: </dl>
10527: </div>
10528: <p>The pkgsrc system has already been ported to many
10529: operating systems, hardware architectures and compilers. This
10530: chapter explains the necessary steps to make pkgsrc even more
10531: portable.</p>
1.148 asau 10532: <div class="sect1">
1.75 rillig 10533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10534: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10535: <p>To port pkgsrc to a new operating system (called
10536: <code class="literal">MyOS</code> in this example), you need to touch the
10537: following files:</p>
1.148 asau 10538: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10539: <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 10540: <dd><p>This file contains some basic definitions, for
10541: example the name of the C
10542: compiler.</p></dd>
1.76 rillig 10543: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10544: <dd><p>Insert code that defines the variables
10545: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10546: <code class="varname">LOWER_OS_VERSION</code>,
10547: <code class="varname">LOWER_VENDOR</code>,
10548: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10549: <code class="varname">APPEND_ELF</code>, and the other variables that
10550: appear in this file.</p></dd>
1.93 rillig 10551: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10552: <dd><p>This file contains the platform-specific
10553: definitions that are used by pkgsrc. Start by copying one of the
10554: other files and edit it to your
10555: needs.</p></dd>
1.93 rillig 10556: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10557: <dd><p>This file defines the paths to all the tools
10558: that are needed by one or the other package in pkgsrc, as well
10559: as by pkgsrc itself. Find out where these tools are on your
10560: platform and add them.</p></dd>
10561: </dl></div>
10562: <p>Now, you should be able to build some basic packages, like
1.189 snj 10563: <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 10564: </div>
1.148 asau 10565: <div class="sect1">
1.75 rillig 10566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10567: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10568: <p>TODO</p>
10569: </div>
10570: </div>
10571: </div>
1.148 asau 10572: <div class="appendix">
10573: <div class="titlepage"><div><div><h1 class="title">
10574: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10575: <div class="toc">
10576: <p><b>Table of Contents</b></p>
1.195 wiz 10577: <dl class="toc">
1.75 rillig 10578: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10579: <dd><dl>
10580: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10581: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10582: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10583: <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 10584: </dl></dd>
10585: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10586: </dl>
10587: </div>
10588: <p>We checked to find a piece of software that wasn't in the packages
10589: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10590: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10591: present in the tree is beyond us, but it's useful for the purposes of
10592: this exercise.</p>
1.148 asau 10593: <div class="sect1">
1.75 rillig 10594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10595: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10596: <div class="sect2">
1.75 rillig 10597: <div class="titlepage"><div><div><h3 class="title">
10598: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10599: <pre class="programlisting">
1.100 rillig 10600: # $NetBSD$
10601: #
1.1 grant 10602:
1.100 rillig 10603: DISTNAME= bison-1.25
10604: CATEGORIES= devel
10605: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10606:
1.136 dholland 10607: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10608: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10609: COMMENT= GNU yacc clone
1.1 grant 10610:
1.100 rillig 10611: GNU_CONFIGURE= yes
1.152 wiz 10612: INFO_FILES= yes
1.1 grant 10613:
1.100 rillig 10614: .include "../../mk/bsd.pkg.mk"
1.1 grant 10615: </pre>
1.75 rillig 10616: </div>
1.148 asau 10617: <div class="sect2">
1.75 rillig 10618: <div class="titlepage"><div><div><h3 class="title">
10619: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10620: <pre class="programlisting">
1.100 rillig 10621: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.189 snj 10622: 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 10623: of the NetBSD source tree is beyond me.
1.1 grant 10624: </pre>
1.75 rillig 10625: </div>
1.148 asau 10626: <div class="sect2">
1.75 rillig 10627: <div class="titlepage"><div><div><h3 class="title">
10628: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10629: <pre class="programlisting">
1.100 rillig 10630: @comment $NetBSD$
10631: bin/bison
10632: man/man1/bison.1.gz
10633: share/bison.simple
10634: share/bison.hairy
1.1 grant 10635: </pre>
1.75 rillig 10636: </div>
1.148 asau 10637: <div class="sect2">
1.75 rillig 10638: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10639: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10640: </h3></div></div></div>
1.75 rillig 10641: <p>The NetBSD package system comes with
1.189 snj 10642: <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 10643: which helps to check the contents of these
10644: files. After installation it is quite easy to use, just change to the
10645: directory of the package you wish to examine and execute
1.110 hubertf 10646: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10647: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10648: looks fine.</pre>
10649: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10650: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10651: -Wall</strong></span> for a very thorough check.</p>
10652: </div>
10653: </div>
1.148 asau 10654: <div class="sect1">
1.75 rillig 10655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10656: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10657: <p>Create the directory where the package lives,
10658: plus any auxiliary directories:</p>
10659: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10660: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10661: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10662: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10663: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10664: <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 10665: then continue with fetching the distfile:</p>
10666: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10667: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10668: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10669: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10670: ftp: Error retrieving file: 500 Internal error
10671:
10672: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10673: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10674: ftp: Error retrieving file: 500 Internal error
10675:
10676: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10677: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10678: Successfully retrieved file.</pre>
10679: <p>Generate the checksum of the distfile into
1.76 rillig 10680: <code class="filename">distinfo</code>:</p>
1.88 wiz 10681: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10682: <p>Now compile:</p>
10683: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10684: >> Checksum OK for bison-1.25.tar.gz.
10685: ===> Extracting for bison-1.25
10686: ===> Patching for bison-1.25
10687: ===> Ignoring empty patch directory
10688: ===> Configuring for bison-1.25
10689: creating cache ./config.cache
10690: checking for gcc... cc
10691: checking whether we are using GNU C... yes
10692: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10693: checking how to run the C preprocessor... cc -E
10694: checking for minix/config.h... no
10695: checking for POSIXized ISC... no
10696: checking whether cross-compiling... no
10697: checking for ANSI C header files... yes
10698: checking for string.h... yes
10699: checking for stdlib.h... yes
10700: checking for memory.h... yes
10701: checking for working const... yes
10702: checking for working alloca.h... no
10703: checking for alloca... yes
10704: checking for strerror... yes
10705: updating cache ./config.cache
10706: creating ./config.status
10707: creating Makefile
10708: ===> Building for bison-1.25
10709: 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
10710: 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
10711: 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
10712: 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
10713: 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 10714: 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 10715: 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
10716: 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
10717: 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
10718: 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
10719: 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
10720: 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
10721: 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
10722: 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
10723: 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
10724: 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
10725: 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
10726: 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
10727: 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
10728: 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
10729: 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
10730: 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
10731: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10732: rm -f bison.s1
1.75 rillig 10733: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10734: <p>Everything seems OK, so install the files:</p>
10735: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10736: >> Checksum OK for bison-1.25.tar.gz.
10737: ===> Installing for bison-1.25
10738: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10739: rm -f /usr/pkg/bin/bison
10740: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10741: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10742: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10743: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10744: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10745: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10746: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10747: ===> Registering installation for bison-1.25</pre>
10748: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10749: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10750: binary package, do this now:</p>
10751: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10752: >> Checksum OK for bison-1.25.tar.gz.
10753: ===> Building package for bison-1.25
10754: Creating package bison-1.25.tgz
10755: Registering depends:.
1.75 rillig 10756: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10757: <p>Now that you don't need the source and object files
10758: any more, clean up:</p>
10759: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10760: ===> Cleaning for bison-1.25</pre>
10761: </div>
10762: </div>
1.148 asau 10763: <div class="appendix">
10764: <div class="titlepage"><div><div><h1 class="title">
10765: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10766: <div class="toc">
10767: <p><b>Table of Contents</b></p>
1.195 wiz 10768: <dl class="toc">
1.75 rillig 10769: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10770: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10771: </dl>
10772: </div>
1.148 asau 10773: <div class="sect1">
1.75 rillig 10774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10775: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10776: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10777: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10778: => figlet221.tar.gz doesn't seem to exist on this system.
10779: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10780: => [172219 bytes]
10781: Connected to ftp.plig.net.
10782: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10783: 331 Guest login ok, send your complete e-mail address as password.
10784: 230-You are user #5 of 500 simultaneous users allowed.
10785: 230-
1.68 rillig 10786: 230- ___ _ _ _
10787: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10788: 230- | _| _| . |_| . | | | . |_| . | _| . |
10789: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10790: 230- |_| |_| |___| |___|
10791: 230-
10792: 230-** Welcome to ftp.plig.org **
10793: 230-
10794: 230-Please note that all transfers from this FTP site are logged. If you
10795: 230-do not like this, please disconnect now.
10796: 230-
1.120 snj 10797: 230-This archive is available via
1.1 grant 10798: 230-
10799: 230-HTTP: http://ftp.plig.org/
10800: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10801: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10802: 230-
10803: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10804: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10805: 230-
10806: 230-
10807: 230 Logged in anonymously.
10808: Remote system type is UNIX.
10809: Using binary mode to transfer files.
10810: 200 Type okay.
10811: 250 "/pub" is new cwd.
10812: 250-"/pub/figlet" is new cwd.
10813: 250-
10814: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10815: 250-
1.75 rillig 10816: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10817: 250-
10818: 250-The official FIGlet web page is:
1.75 rillig 10819: 250- http://www.figlet.org/
1.1 grant 10820: 250-
10821: 250-If you have questions, please mailto:info@figlet.org. If you want to
10822: 250-contribute a font or something else, you can email us.
1.68 rillig 10823: 250
1.1 grant 10824: 250 "/pub/figlet/program" is new cwd.
10825: 250 "/pub/figlet/program/unix" is new cwd.
10826: local: figlet221.tar.gz remote: figlet221.tar.gz
10827: 502 Unimplemented command.
10828: 227 Entering Passive Mode (195,40,6,41,246,104)
10829: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10830: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10831: 226 Transfer completed.
10832: 172219 bytes received in 00:02 (75.99 KB/s)
10833: 221 Goodbye.
10834: => Checksum OK for figlet221.tar.gz.
10835: ===> Extracting for figlet-2.2.1nb2
10836: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10837: ===> Patching for figlet-2.2.1nb2
10838: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10839: ===> Overriding tools for figlet-2.2.1nb2
10840: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10841: ===> Configuring for figlet-2.2.1nb2
10842: ===> Building for figlet-2.2.1nb2
10843: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10844: chmod a+x figlet
10845: gcc -O2 -o chkfont chkfont.c
10846: => Unwrapping files-to-be-installed.
1.14 xtraeme 10847: <code class="prompt">#</code>
1.75 rillig 10848: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10849: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10850: ===> Installing for figlet-2.2.1nb2
10851: install -d -o root -g wheel -m 755 /usr/pkg/bin
10852: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10853: mkdir -p /usr/pkg/share/figlet
10854: cp figlet /usr/pkg/bin
10855: cp chkfont /usr/pkg/bin
10856: chmod 555 figlist showfigfonts
10857: cp figlist /usr/pkg/bin
10858: cp showfigfonts /usr/pkg/bin
10859: cp fonts/*.flf /usr/pkg/share/figlet
10860: cp fonts/*.flc /usr/pkg/share/figlet
10861: cp figlet.6 /usr/pkg/man/man6
10862: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10863: <code class="prompt">#</code></pre>
10864: </div>
1.148 asau 10865: <div class="sect1">
1.75 rillig 10866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10867: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10868: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10869: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10870: ===> Packaging figlet-2.2.1nb2
10871: ===> Building binary package for figlet-2.2.1nb2
10872: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10873: Using SrcDir value of /usr/pkg
1.68 rillig 10874: Registering depends:.
1.75 rillig 10875: <code class="prompt">#</code></pre>
10876: </div>
10877: </div>
1.148 asau 10878: <div class="appendix">
10879: <div class="titlepage"><div><div><h1 class="title">
10880: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10881: <div class="toc">
10882: <p><b>Table of Contents</b></p>
1.195 wiz 10883: <dl class="toc">
1.128 wiz 10884: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10885: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10886: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10887: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10888: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10889: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10890: source packages</a></span></dt>
10891: </dl>
10892: </div>
10893: <p>As in other big projects, the directory layout of pkgsrc
10894: is quite complex for newbies. This chapter explains where you
10895: find things on the FTP server. The base directory on
1.110 hubertf 10896: <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 10897: On other servers it may be different, but inside this directory,
10898: everything should look the same, no matter on which server you
10899: are. This directory contains some subdirectories, which are
10900: explained below.</p>
1.148 asau 10901: <div class="sect1">
1.76 rillig 10902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10903: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10904: <p>The directory <code class="filename">distfiles</code> contains lots
10905: of archive files from all pkgsrc packages, which are mirrored
10906: here. The subdirectories are called after their package names
10907: and are used when the distributed files have names that don't
10908: explicitly contain a version number or are otherwise too generic
10909: (for example <code class="filename">release.tar.gz</code>).</p>
10910: </div>
1.148 asau 10911: <div class="sect1">
1.76 rillig 10912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10913: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10914: <p>This directory contains things that individual pkgsrc
10915: developers find worth publishing.</p>
10916: </div>
1.148 asau 10917: <div class="sect1">
1.76 rillig 10918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10919: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10920: <p>This directory contains binary packages for the various
10921: platforms that are supported by pkgsrc.
10922: 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 10923: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10924: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10925: operating system for which the packages have been built. The
1.110 hubertf 10926: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10927: command, so it may differ from the one you are used to
10928: hear.</p></li>
1.128 wiz 10929: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10930: architecture of the platform for which the packages have been
1.110 hubertf 10931: built. It also includes the <code class="varname">ABI</code> (Application
10932: Binary Interface) for platforms that have several of
10933: them.</p></li>
1.128 wiz 10934: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10935: the operating system. For version numbers that change often (for
10936: example NetBSD-current), the often-changing part should be
10937: replaced with an <code class="literal">x</code>, for example
10938: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10939: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10940: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10941: for a stable branch, or <code class="literal">head</code> for packages
10942: built from the HEAD branch. The latter should only be used when
10943: the packages are updated on a regular basis. Otherwise the date
10944: from checking out pkgsrc should be appended, for example
10945: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10946: </ul></div>
10947: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10948: can quickly click through the directories on the
10949: server and find the best binary packages for their machines. Since they
10950: usually know the operating system and the hardware architecture, OPSYS
10951: and ARCH are placed first. After these choices, they can select the
10952: best combination of OSVERSION and TAG together, since it is usually the
10953: case that packages stay compatible between different version of the
10954: operating system.</p>
10955: <p>In each of these directories, there is a
10956: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10957: <code class="filename">All</code> which contains all binary packages.
10958: Besides that, there are various category directories that
10959: contain symbolic links to the real binary packages.</p>
10960: </div>
1.148 asau 10961: <div class="sect1">
1.76 rillig 10962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10963: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10964: <p>Here are the reports from bulk builds, for those who want
10965: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10966: 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 10967: </div>
1.148 asau 10968: <div class="sect1">
1.108 rillig 10969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10970: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10971: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10972: source packages</h2></div></div></div>
1.128 wiz 10973: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10974: that is the files that define how to create binary packages from
10975: source archives.</p>
10976: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10977: snapshot of the CVS repository, which is updated regularly. The
10978: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10979: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10980: <p>In the directories for the quarterly branches, there is an
10981: additional file called
1.126 jakllsch 10982: <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 10983: which contains the state of pkgsrc when it was branched.</p>
10984: </div>
1.75 rillig 10985: </div>
1.148 asau 10986: <div class="appendix">
10987: <div class="titlepage"><div><div><h1 class="title">
10988: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 10989: <div class="toc">
10990: <p><b>Table of Contents</b></p>
1.195 wiz 10991: <dl class="toc">
1.79 rillig 10992: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10993: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10994: </dl>
10995: </div>
1.79 rillig 10996: <p>This section contains information on editing the pkgsrc
10997: guide itself.</p>
1.148 asau 10998: <div class="sect1">
1.75 rillig 10999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 11000: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11001: <p>The pkgsrc guide's source code is stored in
11002: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11003: are created from it:</p>
1.148 asau 11004: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 11005: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11006: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11007: <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>
11008: <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 11009: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 11010: <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 11011: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11012: </ul></div>
11013: </div>
1.148 asau 11014: <div class="sect1">
1.75 rillig 11015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11016: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11017: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 11018: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 11019: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 11020: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 11021: documentation) installed. These are automatically installed when
1.189 snj 11022: 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 11023: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 11024: right directory. All further steps will take place
11025: here.</p></li>
1.148 asau 11026: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 11027: <code class="filename">files/</code>.</p></li>
1.148 asau 11028: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 11029: guide for valid XML and to build the final output files. If you
11030: get any errors at this stage, you can just edit the files, as
11031: there are only symbolic links in the working directory, pointing
11032: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 11033: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 11034: commit)</strong></span></p></li>
1.148 asau 11035: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 11036: regenerate the output files with the proper RCS
11037: Ids.</p></li>
1.148 asau 11038: <li class="step">
1.110 hubertf 11039: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 11040: commit the files in both <code class="filename">pkgsrc/doc</code> and
11041: <code class="filename">htdocs</code>.</p>
1.148 asau 11042: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 11043: <h3 class="title">Note</h3>
11044: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 11045: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11046: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 11047: directory.</p>
11048: </div>
11049: </li>
1.79 rillig 11050: </ol></div>
1.75 rillig 11051: </div>
11052: </div>
11053: </div></body>
1.1 grant 11054: </html>
CVSweb <webmaster@jp.NetBSD.org>