Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.95
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
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.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 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.10 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.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 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.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.84 wiz 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.41 asau 35: <div><div class="abstract">
1.1 dsieger 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.94 wiz 48: <dl class="toc">
1.1 dsieger 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>
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>
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>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
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.51 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 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>
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.45 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.58 ryoon 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.1 dsieger 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>
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>
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.9 rillig 118: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 119: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 120: <dd><dl>
1.4 rillig 121: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 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.1 dsieger 124: </dl></dd>
1.4 rillig 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.1 dsieger 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.6 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.1 dsieger 135: <dd><dl>
1.71 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.66 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.6 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.23 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.6 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.84 wiz 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.23 wiz 160: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 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.1 dsieger 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.6 rillig 172: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 173: <dd><dl>
1.6 rillig 174: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 175: <dd><dl>
1.6 rillig 176: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 177: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 178: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 179: </dl></dd>
1.6 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.23 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.6 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.23 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.6 rillig 204: </dl></dd>
1.23 wiz 205: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 206: <dd><dl>
207: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 208: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 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.23 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.6 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.23 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.6 rillig 227: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 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.6 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.23 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.6 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.26 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.6 rillig 242: </dl></dd>
1.23 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.6 rillig 244: <dd><dl>
1.23 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.6 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.23 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.6 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.23 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.6 rillig 275: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 276: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 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.23 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.6 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.23 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.6 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.23 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.6 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.23 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.6 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.88 tnn 330: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 331: </dl></dd>
1.23 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.6 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.40 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.6 rillig 345: </dl></dd>
1.23 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.6 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.23 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.6 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.23 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.6 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.7 rillig 363: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 364: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 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.1 dsieger 373: emulation</a></span></dt>
1.6 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.1 dsieger 376: </dl></dd>
1.6 rillig 377: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 378: </dl></dd>
1.6 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.1 dsieger 381: <dd><dl>
1.6 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.33 wiz 385: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 386: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 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.6 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.1 dsieger 397: </dl></dd>
398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.6 rillig 401: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 402: <dd><dl>
1.6 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.1 dsieger 406: <dd><dl>
1.6 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.1 dsieger 409: </dl></dd>
1.6 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.1 dsieger 412: <dd><dl>
1.6 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.1 dsieger 415: </dl></dd>
1.6 rillig 416: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 417: <dd><dl>
1.23 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.1 dsieger 420: </dl></dd>
421: </dl></dd>
1.6 rillig 422: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 423: <dd><dl>
1.6 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.1 dsieger 427: <dd><dl>
1.6 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.1 dsieger 430: </dl></dd>
431: </dl></dd>
1.6 rillig 432: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 433: <dd><dl>
1.6 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.1 dsieger 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.23 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.1 dsieger 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>
454: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
455: <dd><dl>
1.23 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.1 dsieger 462: source packages</a></span></dt>
463: </dl></dd>
464: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
465: <dd><dl>
466: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
467: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
468: </dl></dd>
469: </dl>
470: </div>
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.6 rillig 476: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 477: </dt>
1.6 rillig 478: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 479: </dt>
480: </dl>
481: </div>
1.41 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.1 dsieger 485: <div class="toc">
486: <p><b>Table of Contents</b></p>
1.94 wiz 487: <dl class="toc">
1.1 dsieger 488: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
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>
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>
495: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
496: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
497: </dl>
498: </div>
1.41 asau 499: <div class="sect1">
1.1 dsieger 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>
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>
509: <p>pkgsrc currently contains several thousand packages,
510: including:</p>
1.41 asau 511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 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.1 dsieger 513: web server</p></li>
1.79 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.1 dsieger 515: web browser</p></li>
1.79 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.1 dsieger 517: Desktop Environment</p></li>
1.79 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.1 dsieger 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.41 asau 525: <div class="sect2">
1.1 dsieger 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.41 asau 531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 532: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 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.23 wiz 538: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 539: including binaries, libraries, man pages and other
540: documentation.</p></li>
1.23 wiz 541: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1 dsieger 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.23 wiz 545: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 546: consists of highly portable code. This allows the greatest speed of
1.25 spz 547: development when porting to a new platform. This portability also
1.1 dsieger 548: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
549: platforms</em></span>.</p></li>
1.23 wiz 550: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 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.23 wiz 554: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 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>
560: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 561: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 562: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 563: — That means, if a package contains bugs, it's better to find
1.1 dsieger 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.79 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.1 dsieger 567: of shell scripts), and post-installation checks (installed files,
568: references to shared libraries, script interpreters).</p></li>
1.23 wiz 569: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 570: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 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>
574: </div>
1.41 asau 575: <div class="sect2">
1.1 dsieger 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>
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>
585: <div class="table">
586: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
587: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
588: <colgroup>
589: <col>
590: <col>
1.92 sevan 591: <col>
1.1 dsieger 592: </colgroup>
593: <thead><tr>
594: <th>Platform</th>
595: <th>Date Support Added</th>
1.92 sevan 596: <th>Notes</th>
1.1 dsieger 597: </tr></thead>
598: <tbody>
599: <tr>
1.10 hubertf 600: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 601: <td align="center">Aug 1997</td>
1.92 sevan 602: <td class="auto-generated"> </td>
1.1 dsieger 603: </tr>
604: <tr>
1.10 hubertf 605: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 606: <td align="center">Mar 1999</td>
1.93 sevan 607: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 608: </tr>
609: <tr>
1.10 hubertf 610: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 611: <td align="center">Jun 1999</td>
1.93 sevan 612: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 613: </tr>
614: <tr>
615: <td>
1.10 hubertf 616: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
617: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 618: </td>
619: <td align="center">Oct 2001</td>
1.93 sevan 620: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1 dsieger 621: </tr>
622: <tr>
1.10 hubertf 623: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 624: <td align="center">Nov 2002</td>
1.93 sevan 625: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 626: </tr>
627: <tr>
1.10 hubertf 628: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 629: <td align="center">Nov 2002</td>
1.93 sevan 630: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 631: </tr>
632: <tr>
1.10 hubertf 633: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 634: <td align="center">Dec 2002</td>
1.92 sevan 635: <td>
1.93 sevan 636: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
637: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92 sevan 638: </td>
1.1 dsieger 639: </tr>
640: <tr>
641: <td>BSD/OS</td>
642: <td align="center">Dec 2003</td>
1.92 sevan 643: <td class="auto-generated"> </td>
1.1 dsieger 644: </tr>
645: <tr>
1.10 hubertf 646: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 647: <td align="center">Dec 2003</td>
1.93 sevan 648: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 649: </tr>
650: <tr>
651: <td>
1.10 hubertf 652: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 653: (Microsoft Windows Services for Unix)
654: </td>
655: <td align="center">Mar 2004</td>
1.93 sevan 656: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 657: </tr>
658: <tr>
1.10 hubertf 659: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 660: <td align="center">Oct 2004</td>
1.92 sevan 661: <td class="auto-generated"> </td>
1.1 dsieger 662: </tr>
663: <tr>
1.10 hubertf 664: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 665: <td align="center">Nov 2004</td>
1.93 sevan 666: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 667: </tr>
668: <tr>
1.10 hubertf 669: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 670: <td align="center">Apr 2007</td>
1.93 sevan 671: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 672: </tr>
1.23 wiz 673: <tr>
674: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
675: <td align="center">Sep 2010</td>
1.93 sevan 676: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 677: </tr>
1.45 obache 678: <tr>
679: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 680: <td align="center">Jan 2011</td>
1.92 sevan 681: <td class="auto-generated"> </td>
1.45 obache 682: </tr>
683: <tr>
684: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
685: <td align="center">Nov 2011</td>
1.93 sevan 686: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 687: </tr>
688: <tr>
689: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
690: <td align="center">Mar 2013</td>
1.93 sevan 691: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 692: </tr>
1.58 ryoon 693: <tr>
694: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
695: <td align="center">Jul 2013</td>
1.93 sevan 696: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58 ryoon 697: </tr>
1.1 dsieger 698: </tbody>
699: </table></div>
700: </div>
701: <br class="table-break">
702: </div>
703: </div>
1.41 asau 704: <div class="sect1">
1.1 dsieger 705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
706: <a name="overview"></a>1.2. Overview</h2></div></div></div>
707: <p>This document is divided into three parts. The first,
1.10 hubertf 708: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 709: describes how one can use one of the packages in the Package
710: Collection, either by installing a precompiled binary package,
711: or by building one's own copy using the NetBSD package system.
1.10 hubertf 712: 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.1 dsieger 713: package so it can be easily built by other NetBSD users without
714: knowing about the package's building details. The third part,
1.10 hubertf 715: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 716: is intended for those who want to understand how pkgsrc is
717: implemented.</p>
718: <p>This document is available in various formats:
1.10 hubertf 719: <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.1 dsieger 720: </div>
1.41 asau 721: <div class="sect1">
1.1 dsieger 722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
723: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 724: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
725: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 726: terminology used within this document.</p>
1.41 asau 727: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 728: <dt><span class="term">Package</span></dt>
729: <dd><p>A set of files and building instructions
730: that describe what's necessary
731: to build a certain piece of software using
732: pkgsrc. Packages are traditionally stored under
733: <code class="filename">/usr/pkgsrc</code>.</p></dd>
734: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 735: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 736: is part of the NetBSD operating system and can be bootstrapped
737: to run on non-NetBSD operating systems as well. It handles
738: building (compiling), installing, and removing of
739: packages.</p></dd>
740: <dt><span class="term">Distfile</span></dt>
741: <dd><p>This term describes the file or files that are
742: provided by the author of the piece of software to
743: distribute his work. All the changes necessary to build on
744: NetBSD are reflected in the corresponding package. Usually
745: the distfile is in the form of a compressed tar-archive,
746: but other types are possible, too. Distfiles are usually
747: stored below
748: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
749: <dt><span class="term">Port</span></dt>
750: <dd><p>This is the term used by FreeBSD and OpenBSD people
751: for what we call a package.
1.23 wiz 752: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 753: architecture.</p></dd>
754: <dt><span class="term">Precompiled/binary package</span></dt>
755: <dd>
756: <p>A set of binaries built with pkgsrc from a distfile
757: and stuffed together in a single <code class="filename">.tgz</code>
758: file so it can be installed on machines of the same
759: machine architecture without the need to
760: recompile. Packages are usually generated in
761: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 762: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 763: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 764: especially in the context of precompiled packages.</p>
765: </dd>
766: <dt><span class="term">Program</span></dt>
767: <dd><p>The piece of software to be installed which will be
768: constructed from all the files in the distfile by the
769: actions defined in the corresponding package.</p></dd>
770: </dl></div>
1.41 asau 771: <div class="sect2">
1.1 dsieger 772: <div class="titlepage"><div><div><h3 class="title">
773: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 774: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 775: <dt><span class="term">pkgsrc users</span></dt>
776: <dd>
777: <p>The
778: pkgsrc users are people who use the packages provided by pkgsrc.
779: Typically they are system administrators. The people using the
1.23 wiz 780: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
781: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 782: <p>There are two kinds of pkgsrc users: Some only want to
783: install pre-built binary packages. Others build the pkgsrc
784: packages from source, either for installing them directly or for
1.10 hubertf 785: 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.1 dsieger 786: documentation.</p>
787: </dd>
788: <dt><span class="term">package maintainers</span></dt>
789: <dd><p>A
1.10 hubertf 790: 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.1 dsieger 791: <dt><span class="term">infrastructure developers</span></dt>
792: <dd><p>These people are involved in all those files
793: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 794: 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.1 dsieger 795: too.</p></dd>
796: </dl></div>
797: </div>
798: </div>
1.41 asau 799: <div class="sect1">
1.1 dsieger 800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
801: <a name="typography"></a>1.4. Typography</h2></div></div></div>
802: <p>When giving examples for commands, shell prompts are used to
803: show if the command should/can be issued as root, or if
1.23 wiz 804: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 805: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
806: shell prompt, assuming they use the C-shell or tcsh.</p>
807: </div>
808: </div>
1.41 asau 809: <div class="part">
1.1 dsieger 810: <div class="titlepage"><div><div><h1 class="title">
811: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
812: <div class="toc">
813: <p><b>Table of Contents</b></p>
1.94 wiz 814: <dl class="toc">
1.1 dsieger 815: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
816: <dd><dl>
817: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
818: <dd><dl>
1.51 asau 819: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 820: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 821: </dl></dd>
822: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
823: <dd><dl>
824: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
825: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
826: </dl></dd>
827: </dl></dd>
828: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
829: <dd><dl>
830: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
831: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
832: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
833: <dd><dl>
1.45 obache 834: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
835: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
836: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 837: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
838: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
839: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
840: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
841: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
842: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
843: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 844: </dl></dd>
845: </dl></dd>
846: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
847: <dd><dl>
848: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
849: <dd><dl>
850: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
851: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
852: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
853: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
854: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
855: <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>
856: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
857: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
858: </dl></dd>
859: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
860: <dd><dl>
861: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
862: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
863: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
864: </dl></dd>
865: </dl></dd>
866: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
867: <dd><dl>
868: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
869: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 870: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 871: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 872: <dd><dl>
1.4 rillig 873: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 874: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
875: <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.1 dsieger 876: </dl></dd>
1.4 rillig 877: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
878: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 879: </dl></dd>
880: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
881: <dd><dl>
882: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
883: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 884: </dl></dd>
885: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
886: builds)</a></span></dt>
1.1 dsieger 887: <dd><dl>
1.71 wiz 888: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
889: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
890: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
891: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 892: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
893: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 894: </dl></dd>
895: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
896: <dd><dl>
1.23 wiz 897: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
898: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 899: </dl></dd>
900: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
901: <dd><dl>
902: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 903: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
904: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
905: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
906: <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>
907: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
908: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
909: <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>
910: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
911: <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.23 wiz 912: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 913: <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>
914: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
915: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
916: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
917: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
918: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
919: <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.1 dsieger 920: </dl></dd>
921: </dl>
922: </div>
1.41 asau 923: <div class="chapter">
1.1 dsieger 924: <div class="titlepage"><div><div><h2 class="title">
925: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
926: <div class="toc">
927: <p><b>Table of Contents</b></p>
1.94 wiz 928: <dl class="toc">
1.1 dsieger 929: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
930: <dd><dl>
1.51 asau 931: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 932: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 933: </dl></dd>
934: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
935: <dd><dl>
936: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
937: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
938: </dl></dd>
939: </dl>
940: </div>
941: <p>Before you download and extract the files, you need to decide
942: where you want to extract them. When using pkgsrc as root user, pkgsrc
943: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
944: free to install the sources and binary packages wherever you want in
945: your filesystem, provided that the pathname does not contain white-space
946: or other characters that are interpreted specially by the shell and some
947: other programs. A safe bet is to use only letters, digits, underscores
948: and dashes.</p>
1.41 asau 949: <div class="sect1">
1.1 dsieger 950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
951: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
952: <p>Before you download any pkgsrc files, you should decide
953: whether you want the <span class="emphasis"><em>current</em></span> branch or the
954: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
955: quarterly basis from the current branch and only gets modified
956: for security updates. The names of the stable branches are built
957: from the year and the quarter, for example
1.78 snj 958: <code class="literal">2014Q3</code>.</p>
1.1 dsieger 959: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 960: want to download pkgsrc. You can get it as a tar file or via CVS.
961: Both ways are described here.</p>
1.51 asau 962: <p>Note that tar archive contains CVS working copy.
963: Thus you can switch to using CVS at any later time.</p>
1.41 asau 964: <div class="sect2">
1.1 dsieger 965: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 966: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 967: <p>The primary download location for all pkgsrc files is
1.51 asau 968: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
969: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
970: (it points to the same location).
971: There are a number of subdirectories for different purposes,
972: 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>
973: <p>The tar archive for the current branch is in the directory
974: <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.1 dsieger 975: It is autogenerated daily.</p>
1.51 asau 976: <p>To save download time we provide bzip2- and
977: xz-compressed archives which are published at
978: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
979: and
980: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
981: respectively.
982: </p>
983: <p>You can fetch the same files using FTP.</p>
1.78 snj 984: <p>The tar file for the stable branch 2014Q3 is in the
985: 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.12 weinem 986: <p>To download a pkgsrc stable tarball, run:</p>
987: <pre class="screen">
1.59 jnemeth 988: <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.22 jakllsch 989: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 990: stable branch to be downloaded, for example,
1.78 snj 991: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
992: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 993: or your web browser.</p>
1.12 weinem 994: <p>Then, extract it with:</p>
1.78 snj 995: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 996: <p>This will create the directory <code class="filename">pkgsrc/</code>
997: in <code class="filename">/usr/</code> and all the package source will be
998: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
999: <p>To download pkgsrc-current, run:</p>
1000: <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.1 dsieger 1001: </div>
1.41 asau 1002: <div class="sect2">
1.1 dsieger 1003: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 1004: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
1005: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 1006: <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.23 wiz 1007: </pre>
1008: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.78 snj 1009: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.23 wiz 1010: <p>This will create the directory <code class="filename">pkgsrc/</code>
1011: in your <code class="filename">/usr/</code> directory and all the package source
1012: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1013: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1014: <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 dsieger 1015: </pre>
1.78 snj 1016: <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.23 wiz 1017: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 1018: <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.23 wiz 1019: </pre>
1020: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1021: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1022: or better globally in <code class="filename">/etc/profile</code>:</p>
1023: <pre class="programlisting">
1024: # set CVS remote shell command
1025: CVS_RSH=ssh
1026: export CVS_RSH
1027: </pre>
1028: <p>By default, CVS doesn't do things like most people would expect it to do.
1029: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1030: in your home directory and saving the following lines to it.
1031: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1032: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1033: <pre class="programlisting">
1034: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1035: cvs -q -z2
1.2 rillig 1036: checkout -P
1.4 rillig 1037: update -dP
1038: diff -upN
1.2 rillig 1039: rdiff -u
1.23 wiz 1040: release -d
1.2 rillig 1041: </pre>
1.1 dsieger 1042: </div>
1043: </div>
1.41 asau 1044: <div class="sect1">
1.1 dsieger 1045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1046: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1047: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1048: (which also works if you have first installed it via a tar
1049: file). It saves bandwidth and hard disk activity, compared to
1050: downloading the tar file again.</p>
1.41 asau 1051: <div class="sect2">
1.1 dsieger 1052: <div class="titlepage"><div><div><h3 class="title">
1053: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1054: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1055: <h3 class="title">Warning</h3>
1056: <p>When updating from a tar file, you first need to
1057: completely remove the old pkgsrc directory. Otherwise those
1058: files that have been removed from pkgsrc in the mean time will
1059: not be removed on your local disk, resulting in inconsistencies.
1060: When removing the old files, any changes that you have done to
1061: the pkgsrc files will be lost after updating. Therefore updating
1062: via CVS is strongly recommended.</p>
1063: </div>
1064: <p>Note that by default the distfiles and the binary packages
1065: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1066: before updating. You can also configure pkgsrc to store distfiles
1067: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1068: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1069: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1070: <p>To update pkgsrc from a tar file, download the tar file as
1071: explained above. Then, make sure that you have not made any
1072: changes to the files in the pkgsrc directory. Remove the pkgsrc
1073: directory and extract the new tar file. Done.</p>
1074: </div>
1.41 asau 1075: <div class="sect2">
1.1 dsieger 1076: <div class="titlepage"><div><div><h3 class="title">
1077: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1078: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1079: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1080: </pre>
1081: <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>
1082: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1083: </pre>
1.41 asau 1084: <div class="sect3">
1.1 dsieger 1085: <div class="titlepage"><div><div><h4 class="title">
1086: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1087: <p>When updating pkgsrc, the CVS program keeps track of the
1088: branch you selected. But if you, for whatever reason, want to
1089: switch from the stable branch to the current one, you can do it
1.23 wiz 1090: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1091: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1092: back to the stable branch, add the
1.78 snj 1093: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.1 dsieger 1094: </div>
1.41 asau 1095: <div class="sect3">
1.1 dsieger 1096: <div class="titlepage"><div><div><h4 class="title">
1097: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1098: <p>When you update pkgsrc, the CVS program will only touch
1099: those files that are registered in the CVS repository. That
1100: means that any packages that you created on your own will stay
1101: unmodified. If you change files that are managed by CVS, later
1102: updates will try to merge your changes with those that have been
1103: done by others. See the CVS manual, chapter
1.23 wiz 1104: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1105: </div>
1106: </div>
1107: </div>
1108: </div>
1.41 asau 1109: <div class="chapter">
1.1 dsieger 1110: <div class="titlepage"><div><div><h2 class="title">
1111: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1112: <div class="toc">
1113: <p><b>Table of Contents</b></p>
1.94 wiz 1114: <dl class="toc">
1.1 dsieger 1115: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1116: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1117: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1118: <dd><dl>
1.45 obache 1119: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1120: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1121: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 1122: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1123: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1124: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1125: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1126: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1127: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1128: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 1129: </dl></dd>
1130: </dl>
1131: </div>
1.41 asau 1132: <div class="sect1">
1.1 dsieger 1133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1134: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1135: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.1 dsieger 1136: </div>
1.41 asau 1137: <div class="sect1">
1.1 dsieger 1138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1139: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1140: <p>pkgsrc can be bootstrapped for use in two different modes:
1141: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1142: to privileged one all programs are installed under one particular user
1.43 asau 1143: and cannot utilise privileged operations (packages don't create
1144: special users and all special file permissions like setuid are ignored).
1145: </p>
1.1 dsieger 1146: <p>Installing the bootstrap kit from source should be as simple as:</p>
1147: <pre class="screen">
1.60 asau 1148: <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.1 dsieger 1149: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1150: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1151: </pre>
1.43 asau 1152: <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>
1153: <p>By default, in privileged mode pkgsrc uses
1154: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1155: where programs will be installed in,
1.1 dsieger 1156: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1157: directory where pkgsrc will do its internal bookkeeping,
1158: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1159: where packages install their persistent data.
1160: In unprivileged mode pkgsrc uses
1161: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1162: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1163: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1164: </p>
1165: <p>You can change default layout using command-line arguments.
1166: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1167: </p>
1.41 asau 1168: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1169: <h3 class="title">Note</h3>
1.10 hubertf 1170: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1171: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1172: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1173: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1174: </div>
1.43 asau 1175: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1176: <h3 class="title">Note</h3>
1177: <p>It is possible to bootstrap multiple instances of pkgsrc
1178: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1179: corresponding to the installation you're working with to build
1180: and install packages.
1181: </p>
1182: </div>
1.1 dsieger 1183: </div>
1.41 asau 1184: <div class="sect1">
1.1 dsieger 1185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1186: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1187: <p>Here are some platform-specific notes you should be aware of.</p>
1.41 asau 1188: <div class="sect2">
1.1 dsieger 1189: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1190: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1191: <p>Cygwin 1.7.x and later are supported.</p>
1192: <p>You need to install minimal base packages in `Base' category
1193: plus any of compiler, gcc, gcc4, and/or clang.
1194: For gcc and gcc4, C and C++ compiler will be installed by default,
1195: but you can install Fortran compiler additionally
1196: because it will be required to use libtool.
1197: If it is not installed (or too old), Fortran compiler will be
1198: installed with pkgsrc automatically.</p>
1199: <p>As noted in
1200: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1201: su(1) command has been in Cygwin distribution, but it has never worked.
1202: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1203: </p>
1204: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1205: then pick "Run as administrator".</p></li></ul></div>
1206: </div>
1207: <div class="sect2">
1208: <div class="titlepage"><div><div><h3 class="title">
1209: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.41 asau 1210: <p>Darwin 5.x and up are supported.</p>
1211: <p>Before you start, you need to download and install
1212: the Mac OS X Developer Tools from Apple's Developer Connection.
1213: This requires (free) membership. See
1.22 jakllsch 1214: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.41 asau 1215: for details. Also, make sure you install X11 (an optional
1216: package included with the Developer Tools) if you intend
1217: to build packages that use the X11 Window System.
1218: (If you don't want or need the full Xcode GUI,
1219: download and install Command Line Tools for Xcode.)</p>
1.1 dsieger 1220: </div>
1.41 asau 1221: <div class="sect2">
1.1 dsieger 1222: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1223: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.29 dholland 1224: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1 dsieger 1225: other versions may work.</p>
1226: <p>Care should be taken so that the tools that this kit installs do not conflict
1227: with the FreeBSD userland tools. There are several steps:</p>
1.23 wiz 1228: <div class="orderedlist"><ol class="orderedlist" type="1">
1229: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1 dsieger 1230: <code class="filename">/var/db/pkg</code>. It is therefore
1231: recommended that you choose a different location (e.g.
1232: <code class="filename">/usr/pkgdb</code>) by
1233: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1234: <li class="listitem">
1.1 dsieger 1235: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1236: good idea to move them out of the way to avoid confusion, e.g.</p>
1237: <pre class="screen">
1238: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1239: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1240: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1241: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1242: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1243: </pre>
1244: </li>
1.23 wiz 1245: <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.1 dsieger 1246: <code class="filename">/etc/mk.conf.example</code> file
1247: when you use the bootstrap script.</p></li>
1248: </ol></div>
1249: </div>
1.41 asau 1250: <div class="sect2">
1.1 dsieger 1251: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1252: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1253: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1254: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1255: <p> You should install ncurses (libncurses and libncurses-dev)
1256: packages.</p>
1257: </div>
1258: <div class="sect2">
1259: <div class="titlepage"><div><div><h3 class="title">
1260: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.1 dsieger 1261: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1262: providing a Unix-like environment with a tighter kernel integration than
1263: available with Cygwin. It is part of the Windows Services for Unix
1264: package, available for free for any licensed copy of Windows 2000, XP
1.10 hubertf 1265: (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.1 dsieger 1266: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1267: are not officially supported. (The main difference in 3.0/3.1 is lack
1268: of pthreads, but other parts of libc may also be lacking.)</p>
1.24 wiz 1269: <p>Services for Unix Applications (aka SUA) is an integrated
1270: component of Windows Server 2003 R2 (5.2), Windows Vista and
1271: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1272: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1273: 6.1 (64bit) subsystems have been tested. Other versions may
1274: work as well. The Interix 5.x subsystem has not yet been tested
1275: with pkgsrc.</p>
1.41 asau 1276: <div class="sect3">
1.1 dsieger 1277: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1278: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.1 dsieger 1279: <p>At an absolute minimum, the following packages must be installed from
1280: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.41 asau 1281: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1282: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1283: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1284: <li class="listitem"><p>Remote Connectivity</p></li>
1285: <li class="listitem"><p>Interix SDK</p></li>
1.1 dsieger 1286: </ul></div>
1287: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1288: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1289: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1290: pkgsrc (or from a binary package).</p>
1291: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1292: not need to be installed, but Remote Connectivity itself should be
1293: installed in order to have a working inetd.</p>
1294: <p>During installation you may be asked whether to enable setuid
1295: behavior for Interix programs, and whether to make pathnames default to
1296: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1297: enabled. (Without case-sensitivity, a large number of packages including
1298: perl will not build.)</p>
1299: <p>NOTE: Newer Windows service packs change the way binary execution
1300: works (via the Data Execution Prevention feature). In order to use
1301: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1302: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1303: must be installed. Hotfixes are available from Microsoft through a
1.14 jmcneill 1304: support contract; however, Debian Interix Port has made most Interix
1305: 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.1 dsieger 1306: <p>In addition to the hotfix noted above, it may be necessary to
1307: disable Data Execution Prevention entirely to make Interix functional.
1308: This may happen only with certain types of CPUs; the cause is not fully
1309: understood at this time. If gcc or other applications still segfault
1310: repeatedly after installing one of the hotfixes note above, the
1311: following option can be added to the appropriate "boot.ini" line on the
1312: Windows boot drive: /NoExecute=AlwaysOff
1313: (WARNING, this will disable DEP completely, which may be a security
1314: risk if applications are often run as a user in the Administrators
1315: group!)</p>
1316: </div>
1.41 asau 1317: <div class="sect3">
1.1 dsieger 1318: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1319: <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.1 dsieger 1320: <p>If SFU is already installed and you wish to alter these settings to work
1321: with pkgsrc, note the following things.</p>
1.41 asau 1322: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1323: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1 dsieger 1324: Windows Services for UNIX, then click Change. In the installer, choose
1325: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.23 wiz 1326: <li class="listitem">
1.1 dsieger 1327: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1328: change the following registry key:</p>
1329: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1330: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1331: </li>
1.23 wiz 1332: <li class="listitem">
1.1 dsieger 1333: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1334: following registry key:</p>
1335: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1336: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1337: </li>
1338: </ul></div>
1339: </div>
1.41 asau 1340: <div class="sect3">
1.1 dsieger 1341: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1342: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.1 dsieger 1343: <p>The package manager (either the pkgsrc "su" user, or the user
1344: running "pkg_add") must be a member of the local Administrators
1345: group. Such a user must also be used to run the bootstrap. This is
1346: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1347: <p>The package manager should use a umask of 002. "make install" will
1348: automatically complain if this is not the case. This ensures that
1349: directories written in /var/db/pkg are Administrators-group writeable.</p>
1350: <p>The popular Interix binary packages from http://www.interopsystems.com/
1351: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1352: NOT be used in conjunction with pkgsrc. If you choose to use them at
1353: the same time as the pkgsrc packages, ensure that you use the proper
1354: pkg_* tools for each type of binary package.</p>
1355: <p>The TERM setting used for DOS-type console windows (including those
1356: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1357: don't have a termcap/terminfo entry for it, but the following .termcap
1358: entry provides adequate emulation in most cases:</p>
1359: <pre class="programlisting">
1360: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1361: </pre>
1362: </div>
1.41 asau 1363: <div class="sect3">
1.1 dsieger 1364: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1365: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.1 dsieger 1366: <p>Though Interix suffices as a familiar and flexible substitute
1367: for a full Unix-like platform, it has some drawbacks that should
1368: be noted for those desiring to make the most of Interix.</p>
1.41 asau 1369: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1370: <li class="listitem">
1.1 dsieger 1371: <p><span class="strong"><strong>X11:</strong></span></p>
1372: <p>Interix comes with the standard set of X11R6 client libraries,
1373: and can run X11 based applications, but it does
1374: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.10 hubertf 1375: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1376: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1 dsieger 1377: (available in a trimmed version for Interix from Interop Systems as the
1.10 hubertf 1378: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1 dsieger 1379: and the free X11 server included with
1.10 hubertf 1380: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1 dsieger 1381: </li>
1.23 wiz 1382: <li class="listitem">
1.1 dsieger 1383: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1384: <p>Because Interix runs in a completely different NT subsystem from
1385: Win32 applications, it does not currently support various X11
1386: protocol extensions for acceleration (such as MIT-SHM or DGA).
1387: Most interactive applications to a local X server will run
1388: reasonably fast, but full motion video and other graphics
1389: intensive applications may require a faster-than-expected CPU.</p>
1390: </li>
1.23 wiz 1391: <li class="listitem">
1.1 dsieger 1392: <p><span class="strong"><strong>Audio:</strong></span></p>
1393: <p>Interix has no native support for audio output. For audio
1.10 hubertf 1394: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1 dsieger 1395: audio system on Interix. Unlike on most platforms, the
1.79 snj 1396: <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.10 hubertf 1397: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1 dsieger 1398: server component. To output audio via an Interix host, the
1.79 snj 1399: <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.1 dsieger 1400: must also be installed.</p>
1401: </li>
1.23 wiz 1402: <li class="listitem">
1.1 dsieger 1403: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1404: <p>Direct device access is not currently supported in Interix, so it
1405: is not currently possible to access CD/DVD drives, USB devices,
1406: or SCSI devices through non-filesystem means. Among other things,
1407: this makes it impossible to use Interix directly for CD/DVD
1408: burning.</p>
1409: </li>
1.23 wiz 1410: <li class="listitem">
1.1 dsieger 1411: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1412: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1413: drives are also not directly accessible in Interix. However,
1414: support is in work to make tape drive access possible by using
1415: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1416: esound server).</p>
1417: </li>
1418: </ul></div>
1419: </div>
1.41 asau 1420: <div class="sect3">
1.1 dsieger 1421: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1422: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.1 dsieger 1423: <p>It is not necessary, in general, to have a "root" user on the
1424: Windows system; any member of the local Administrators group will
1425: suffice. However, some packages currently assume that the user
1426: named "root" is the privileged user. To accommodate these, you
1427: may create such a user; make sure it is in the local group
1428: Administrators (or your language equivalent).</p>
1.10 hubertf 1429: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1 dsieger 1430: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1431: time being, install packages as the local Administrator (or
1432: your language equivalent), or run the following command after
1433: installing a package to work around the issue:</p>
1434: <pre class="screen">
1435: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1436: </pre>
1437: </div>
1438: </div>
1.41 asau 1439: <div class="sect2">
1.1 dsieger 1440: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1441: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.1 dsieger 1442: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1443: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1444: according to your preference. If you do not have a license for the MIPSpro
1.10 hubertf 1445: 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.1 dsieger 1446: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.79 snj 1447: 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.1 dsieger 1448: etc.</p>
1449: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1450: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1451: you start out using "abi=n32", that's what all your packages will be built
1452: with.</p>
1453: <p>Therefore, please make sure that you have no conflicting
1454: <code class="varname">CFLAGS</code> in your environment or the
1.10 hubertf 1455: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1456: try to link n32 object files with lib64 or vice versa. Check your
1457: <code class="filename">/etc/compiler.defaults</code>!</p>
1458: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1459: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1460: as it appears that IRIX linker occasionally runs into issues when trying to
1461: link over a network-mounted file system.</p>
1462: <p>The bootstrapping process should set all the right options for programs such
1463: as imake(1), but you may want to set some options depending on your local
1464: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1465: course, your compiler's man pages for details.</p>
1466: <p>If you are using SGI's MIPSPro compiler, please set
1467:
1468: </p>
1469: <pre class="programlisting">
1470: PKGSRC_COMPILER= mipspro
1471: </pre>
1472: <p>
1473:
1.10 hubertf 1474: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1475: are using gcc and may end up passing invalid flags to the compiler. Note that
1476: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1477: default.</p>
1478: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1479: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1480: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1481: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1482: '--preserve-path' flag.</p>
1483: </div>
1.41 asau 1484: <div class="sect2">
1.1 dsieger 1485: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1486: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.1 dsieger 1487: <p>Some versions of Linux (for example Debian GNU/Linux) need
1488: either libtermcap or libcurses (libncurses). Installing the
1489: distributions libncurses-dev package (or equivalent) should fix
1490: the problem.</p>
1491: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1492: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1493: i386 have been tested.</p>
1494: <p>To bootstrap using icc, assuming the default icc installation
1495: directory:</p>
1496: <pre class="programlisting">
1.31 wiz 1497: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1 dsieger 1498: </pre>
1.41 asau 1499: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1500: <h3 class="title">Note</h3>
1.31 wiz 1501: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1502: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1503: <p>For icc 10.1 neither of these appears to be necessary.</p>
1504: </div>
1505: <p>Use a value for ICCBASE that corresponds to the directory
1506: where icc is installed. After bootstrapping, set
1507: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30 wiz 1508: <pre class="programlisting">
1.31 wiz 1509: ICCBASE= /opt/intel/cc/10.1.008
1.1 dsieger 1510: </pre>
1.31 wiz 1511: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1512: <code class="filename">/opt/intel_cc_80</code>. This is the default
1513: install directory for icc 8.0. If you are using a more recent
1514: version, be sure to set the correct path explicitly.
1515: </p>
1.1 dsieger 1516: <p>pkgsrc uses the static linking method of the runtime libraries
1517: provided by icc, so binaries can be run on other systems which do not
1518: have the shared libraries installed.</p>
1519: <p>Libtool, however, extracts a list of libraries from the
1.79 snj 1520: <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.1 dsieger 1521: records it, throwing away the -Bstatic and -Bdynamic options
1522: interspersed between the libraries. This means that
1523: libtool-linked C++ shared libraries will have a runtime
1524: dependency on the icc libraries until this is fixed in
1525: libtool.</p>
1526: </div>
1.41 asau 1527: <div class="sect2">
1.1 dsieger 1528: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1529: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.57 bsiegert 1530: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1531: Older versions might also work. Releases before #10 are not
1532: supported.</p>
1533: <p>The package tools of the (older) native ports tree,
1534: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1535: have the same names as the ones used by pkgsrc. Care should be taken
1536: that the right tools are used. When installing packages from source,
1537: use the <code class="filename">bmake</code> command for pkgsrc and
1538: <code class="filename">mmake</code> for MirPorts.</p>
1539: <p>pkgsrc and MirPorts use the same location for the package
1540: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1541: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1542: tree is self-contained. This is also the default setting used in the
1543: binary package builds.</p>
1544: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1545: server. The bootstrap kit there already contains the
1546: <span class="command"><strong>pkgin</strong></span> package manager. See the
1547: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1548: page for more details.</p>
1549: </div>
1550: <div class="sect2">
1551: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1552: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.29 dholland 1553: <p>OpenBSD 5.1 has been tested and supported,
1554: other versions may work.</p>
1.1 dsieger 1555: <p>Care should be taken so that the tools that this kit installs do not conflict
1556: with the OpenBSD userland tools. There are several steps:</p>
1.23 wiz 1557: <div class="orderedlist"><ol class="orderedlist" type="1">
1558: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1 dsieger 1559: <code class="filename">/var/db/pkg</code>. It is therefore
1560: recommended that you choose a different location (e.g.
1561: <code class="filename">/usr/pkgdb</code>) by
1562: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1563: <li class="listitem">
1.1 dsieger 1564: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1565: good idea to move them out of the way to avoid confusion, e.g.</p>
1566: <pre class="screen">
1567: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1568: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1569: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1570: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1571: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1572: </pre>
1573: </li>
1.23 wiz 1574: <li class="listitem">
1.10 hubertf 1575: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1576: <code class="filename">/etc/mk.conf.example</code> file
1577: when you use the bootstrap script. OpenBSD's make program uses
1.10 hubertf 1578: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1579: as well. You can work around this by enclosing all the pkgsrc-specific parts
1580: of the file with:</p>
1581: <pre class="programlisting">
1582: .ifdef BSD_PKG_MK
1583: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1584: .else
1585: # OpenBSD stuff
1586: .endif
1587: </pre>
1588: </li>
1589: </ol></div>
1590: </div>
1.41 asau 1591: <div class="sect2">
1.1 dsieger 1592: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1593: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.35 wiz 1594: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1595: You will need a working C compiler. Both gcc 4.5.3 and
1.1 dsieger 1596: Sun WorkShop 5 have been tested.</p>
1597: <p>The following packages are required on Solaris 8 for the bootstrap
1598: process and to build packages.</p>
1.41 asau 1599: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1600: <li class="listitem"><p>SUNWsprot</p></li>
1601: <li class="listitem"><p>SUNWarc</p></li>
1602: <li class="listitem"><p>SUNWbtool</p></li>
1603: <li class="listitem"><p>SUNWtoo</p></li>
1604: <li class="listitem"><p>SUNWlibm</p></li>
1.1 dsieger 1605: </ul></div>
1606: <p>Please note that the use of GNU binutils on Solaris is
1607: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1608: <p>Whichever compiler you use, please ensure the compiler tools and
1609: your $prefix are in your <code class="varname">PATH</code>. This includes
1610: <code class="filename">/usr/ccs/{bin,lib}</code>
1611: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.41 asau 1612: <div class="sect3">
1.1 dsieger 1613: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1614: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.1 dsieger 1615: <p>It makes life much simpler if you only use the same gcc consistently
1616: for building all packages.</p>
1617: <p>It is recommended that an external gcc be used only for bootstrapping,
1618: then either build gcc from
1.79 snj 1619: <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.1 dsieger 1620: package, then remove gcc used during bootstrapping.</p>
1.10 hubertf 1621: <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.1 dsieger 1622: </div>
1.41 asau 1623: <div class="sect3">
1.1 dsieger 1624: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1625: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.1 dsieger 1626: <p>You will need at least the following packages installed (from WorkShop
1627: 5.0)</p>
1.41 asau 1628: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1629: <li class="listitem"><p>SPROcc
1.1 dsieger 1630: - Sun WorkShop Compiler C 5.0</p></li>
1.23 wiz 1631: <li class="listitem"><p>SPROcpl
1.1 dsieger 1632: - Sun WorkShop Compiler C++ 5.0</p></li>
1.23 wiz 1633: <li class="listitem"><p>SPROild
1.1 dsieger 1634: - Sun WorkShop Incremental Linker</p></li>
1.23 wiz 1635: <li class="listitem"><p>SPROlang
1.1 dsieger 1636: - Sun WorkShop Compilers common components</p></li>
1637: </ul></div>
1638: <p>You should set the following variables in your
1.10 hubertf 1639: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1640: <pre class="programlisting">
1641: CC= cc
1642: CXX= CC
1643: CPP= cc -E
1644: CXXCPP= CC -E
1645: </pre>
1.41 asau 1646: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1647: <h3 class="title">Note</h3>
1648: <p>The <code class="varname">CPP</code> setting might break some
1649: packages that use the C preprocessor for processing things other
1650: than C source code.</p>
1651: </div>
1652: </div>
1.41 asau 1653: <div class="sect3">
1.1 dsieger 1654: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1655: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.1 dsieger 1656: <p>To build 64-bit packages, you just need to have the
1.10 hubertf 1657: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1658: <pre class="programlisting">
1659: PKGSRC_COMPILER= sunpro
1660: ABI= 64
1661: </pre>
1.41 asau 1662: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1663: <h3 class="title">Note</h3>
1664: <p>This setting has been tested for the SPARC
1665: architecture. Intel and AMD machines need some more
1666: work.</p>
1667: </div>
1668: </div>
1.41 asau 1669: <div class="sect3">
1.1 dsieger 1670: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1671: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.10 hubertf 1672: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1 dsieger 1673: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1674: The workaround is to use another shell for the configure
1.79 snj 1675: 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.10 hubertf 1676: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1677: <pre class="programlisting">
1678: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1679: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1680: </pre>
1.79 snj 1681: <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.1 dsieger 1682: </div>
1683: </div>
1684: </div>
1685: </div>
1.41 asau 1686: <div class="chapter">
1.1 dsieger 1687: <div class="titlepage"><div><div><h2 class="title">
1688: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1689: <div class="toc">
1690: <p><b>Table of Contents</b></p>
1.94 wiz 1691: <dl class="toc">
1.1 dsieger 1692: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1693: <dd><dl>
1694: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1695: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1696: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1697: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1698: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1699: <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>
1700: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1701: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1702: </dl></dd>
1703: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1704: <dd><dl>
1705: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1706: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1707: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1708: </dl></dd>
1709: </dl>
1710: </div>
1711: <p>Basically, there are two ways of using pkgsrc. The first
1712: is to only install the package tools and to use binary packages
1.23 wiz 1713: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1714: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1715: of pkgsrc, too. Then you are able to build your own packages,
1716: and you can still use binary packages from someone else.</p>
1.41 asau 1717: <div class="sect1">
1.1 dsieger 1718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1719: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1720: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1721: server and its mirrors, there are collections of binary packages,
1722: ready to be installed. These binary packages have been built using the
1723: default settings for the directories, that is:</p>
1.41 asau 1724: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1725: <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>
1726: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1727: <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.9 rillig 1728: </ul></div>
1729: <p>If you cannot use these directories for whatever reasons (maybe
1730: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1731: 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.41 asau 1732: <div class="sect2">
1.1 dsieger 1733: <div class="titlepage"><div><div><h3 class="title">
1734: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1735: <p>To install binary packages, you first need to know from where
1736: to get them. The first place where you should look is on the main
1.10 hubertf 1737: 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.5 weinem 1738: <p>This directory contains binary packages for multiple
1739: platforms. First, select your operating system. (Ignore the
1740: directories with version numbers attached to it, they just exist for
1741: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1742: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1743: <p>In this directory, you often find a file called
1744: <code class="filename">bootstrap.tar.gz</code> which contains the package
1745: management tools. If the file is missing, it is likely that your
1746: operating system already provides those tools. Download the file and
1747: extract it in the <code class="filename">/</code> directory. It will create
1748: the directories <code class="filename">/usr/pkg</code> (containing the tools
1749: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1750: (the database of installed packages).</p>
1.1 dsieger 1751: </div>
1.41 asau 1752: <div class="sect2">
1.1 dsieger 1753: <div class="titlepage"><div><div><h3 class="title">
1754: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1755: <p>In the directory from the last section, there is a
1.85 wiz 1756: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1757: binary packages that are available for the platform, excluding those
1758: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1759: medium you are using).</p>
1.9 rillig 1760: <p>To install packages directly from an FTP or HTTP server, run
1761: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1762: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1763: <pre class="screen">
1764: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85 wiz 1765: <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.9 rillig 1766: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1767: </pre>
1768: <p>Instead of URLs, you can also use local paths, for example if
1769: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1770: repository. If you want to install packages from multiple sources,
1771: you can separate them by a semicolon in
1772: <code class="varname">PKG_PATH</code>.</p>
1773: <p>After these preparations, installing a package is very
1774: easy:</p>
1775: <pre class="screen">
1776: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1777: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1778: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1779: </pre>
1.1 dsieger 1780: <p>Note that any prerequisite packages needed to run the
1781: package in question will be installed, too, assuming they are
1782: present where you install from.</p>
1.23 wiz 1783: <p>Adding packages might install vulnerable packages.
1784: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1785: regularly, especially after installing new packages, and verify
1786: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1787: <p>After you've installed packages, be sure to have
1788: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1789: <code class="varname">PATH</code> so you can actually start the just
1790: installed program.</p>
1791: </div>
1.41 asau 1792: <div class="sect2">
1.1 dsieger 1793: <div class="titlepage"><div><div><h3 class="title">
1794: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1795: <p>To deinstall a package, it does not matter whether it was
1796: installed from source code or from a binary package. The
1.10 hubertf 1797: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1798: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1799: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1800: name can be given with or without version number. Wildcards can
1801: also be used to deinstall a set of packages, for example
1802: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1803: so that the shell does not expand them before
1804: <code class="literal">pkg_delete</code> sees them.</p>
1805: <p>The <code class="option">-r</code> option is very powerful: it
1806: removes all the packages that require the package in question
1807: and then removes the package itself. For example:
1808:
1809: </p>
1810: <pre class="screen">
1811: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1812: </pre>
1813: <p>
1814:
1815: will remove jpeg and all the packages that used it; this allows
1816: upgrading the jpeg package.</p>
1817: </div>
1.41 asau 1818: <div class="sect2">
1.1 dsieger 1819: <div class="titlepage"><div><div><h3 class="title">
1820: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1821: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1822: installed packages or binary package files.</p>
1823: </div>
1.41 asau 1824: <div class="sect2">
1.1 dsieger 1825: <div class="titlepage"><div><div><h3 class="title">
1826: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1827: <p>
1828: The NetBSD Security-Officer and Packages Groups maintain a list of
1829: known security vulnerabilities to packages which are (or have been)
1830: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1831: 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.1 dsieger 1832: </p>
1833: <p>
1.22 jakllsch 1834: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1835: this list can be downloaded
1836: automatically, and a security audit of all packages installed on a system
1837: can take place.
1838: </p>
1839: <p>
1.22 jakllsch 1840: There are two components to auditing. The first
1841: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1842: is for downloading
1.1 dsieger 1843: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1844: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1845: installed packages are vulnerable. If a package is vulnerable, you
1846: will see output similar to the following:
1847: </p>
1848: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1849: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1850: <p>
1.22 jakllsch 1851: You may wish to have the
1.10 hubertf 1852: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1853: file downloaded daily so that
1854: it remains current. This may be done by adding an appropriate entry
1.79 snj 1855: 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.22 jakllsch 1856: </p>
1857: <pre class="screen">
1858: # download vulnerabilities file
1859: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1860: </pre>
1861: <p>
1862: will update the vulnerability list every day at 3AM. You may wish to do
1863: this more often than once a day.
1864:
1865: In addition, you may wish to run the package audit from the daily
1866: security script. This may be accomplished by adding the following
1867: line to <code class="filename">/etc/security.local</code>:
1868: </p>
1869: <pre class="screen">
1870: /usr/sbin/pkg_admin audit
1871: </pre>
1872: <p>
1.1 dsieger 1873: </p>
1874: </div>
1.41 asau 1875: <div class="sect2">
1.1 dsieger 1876: <div class="titlepage"><div><div><h3 class="title">
1877: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1878: <p>
1.79 snj 1879: 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.23 wiz 1880: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1881: argument to check if your packages are up-to-date, e.g.
1882: </p>
1883: <pre class="screen">
1884: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1885: ...
1886: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1887: </pre>
1.10 hubertf 1888: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1889: package on your system and rebuild any dependencies.
1890: </p>
1891: </div>
1.41 asau 1892: <div class="sect2">
1.1 dsieger 1893: <div class="titlepage"><div><div><h3 class="title">
1894: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1895: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1896: administrative functions on the package system.</p>
1897: </div>
1.41 asau 1898: <div class="sect2">
1.1 dsieger 1899: <div class="titlepage"><div><div><h3 class="title">
1900: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1901: <p>Please pay very careful attention to the warnings
1.79 snj 1902: 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.1 dsieger 1903: inherent dangers of installing binary packages which you did
1904: not create yourself, and the security holes that can be
1905: introduced onto your system by indiscriminate adding of such
1906: files.</p>
1907: <p>The same warning of course applies to every package you
1908: install from source when you haven't completely read and
1909: understood the source code of the package, the compiler that
1910: is used to build the package and all the other tools that are
1911: involved.</p>
1912: </div>
1913: </div>
1.41 asau 1914: <div class="sect1">
1.1 dsieger 1915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1916: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1917: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1918: directory now contains a set of packages, organized into
1919: categories. You can browse the online index of packages, or run
1.10 hubertf 1920: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1921: directory to build local <code class="filename">README.html</code> files for
1.79 snj 1922: 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.1 dsieger 1923: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1924: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1925: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1926: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1927: different <code class="varname">LOCALBASE</code> definitions on the same
1928: system (inside a chroot is an exception). </p>
1929: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1930: 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.1 dsieger 1931: instructions how to create your own packages.</p>
1.41 asau 1932: <div class="sect2">
1.1 dsieger 1933: <div class="titlepage"><div><div><h3 class="title">
1934: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1935: <p>To build packages from source, you need a working C
1936: compiler. On NetBSD, you need to install the
1.23 wiz 1937: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1938: sets. If you want to build X11-related packages, the
1.23 wiz 1939: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1940: sets are required, too.</p>
1941: </div>
1.41 asau 1942: <div class="sect2">
1.1 dsieger 1943: <div class="titlepage"><div><div><h3 class="title">
1944: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1945: <p>The first step for building a package is downloading the
1946: distfiles (i.e. the unmodified source). If they have not yet been
1947: downloaded, pkgsrc will fetch them automatically.</p>
1948: <p>If you have all files that you need in the
1949: <code class="filename">distfiles</code> directory,
1950: you don't need to connect. If the distfiles are on CD-ROM, you can
1951: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1952: </p>
1953: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1954: <p>
1.10 hubertf 1955: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1956: <p>By default a list of distribution sites will be randomly
1957: intermixed to prevent huge load on servers which holding popular
1958: packages (for example, SourceForge.net mirrors). Thus, every
1959: time when you need to fetch yet another distfile all the mirrors
1960: will be tried in new (random) order. You can turn this feature
1961: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1962: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1963: <p>You can overwrite some of the major distribution sites to
1964: fit to sites that are close to your own. By setting one or two
1965: variables you can modify the order in which the master sites are
1966: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1967: delimited list of domain suffixes.
1968: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1969: contains a whitespace delimited list of regular expressions. It
1970: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1971: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1972: some examples. This may save some of your bandwidth and
1973: time.</p>
1974: <p>You can change these settings either in your shell's environment, or,
1975: if you want to keep the settings, by editing the
1.10 hubertf 1976: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1977: and adding the definitions there.</p>
1978: <p>
1979: If a package depends on many other packages (such as
1.79 snj 1980: <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.1 dsieger 1981: alternate between periods of
1982: downloading source, and compiling. To ensure you have all the source
1983: downloaded initially you can run the command:
1984: </p>
1985: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1986: <p>
1987: which will output and run a set of shell commands to fetch the
1988: necessary files into the <code class="filename">distfiles</code> directory. You can
1989: also choose to download the files manually.
1990: </p>
1991: </div>
1.41 asau 1992: <div class="sect2">
1.1 dsieger 1993: <div class="titlepage"><div><div><h3 class="title">
1994: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1995: <p>
1996: Once the software has downloaded, any patches will be applied, then it
1997: will be compiled for you. This may take some time depending on your
1998: computer, and how many other packages the software depends on and their
1999: compile time.
2000: </p>
1.41 asau 2001: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 2002: <h3 class="title">Note</h3>
2003: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 2004: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 2005: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 2006: </div>
2007: <p>For example, type</p>
2008: <pre class="screen">
2009: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2010: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2011: </pre>
2012: <p>at the shell prompt to build the various components of the
2013: package.</p>
2014: <p>The next stage is to actually install the newly compiled
2015: program onto your system. Do this by entering:
2016:
2017: </p>
2018: <pre class="screen">
2019: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2020: </pre>
2021: <p>
2022:
2023: while you are still in the directory for whatever package you
2024: are installing.</p>
2025: <p>Installing the package on your system may require you to
2026: be root. However, pkgsrc has a
2027: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2028: to only become root for the actual installation step.</p>
2029: <p>That's it, the software should now be installed and setup for use.
2030: You can now enter:
2031:
2032: </p>
2033: <pre class="screen">
2034: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2035: </pre>
2036: <p>
2037:
2038: to remove the compiled files in the work directory, as you shouldn't need
2039: them any more. If other packages were also added to your system
2040: (dependencies) to allow your program to compile, you can tidy these up
2041: also with the command:</p>
2042: <pre class="screen">
2043: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2044: </pre>
2045: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 2046: 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.1 dsieger 2047: <p>The program is installed under the default root of the
2048: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2049: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2050: variable in your environment, and it will use that value as the
2051: root of your packages tree. So, to use
2052: <code class="filename">/usr/local</code>, set
2053: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2054: Please note that you should use a directory which is dedicated to
2055: packages and not shared with other programs (i.e., do not try and
2056: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2057: to add any of your own files or directories (such as
2058: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2059: <code class="filename">pkgsrc/</code>) below the
2060: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2061: conflicts between programs and other files installed by the
2062: package system and whatever else may have been installed
2063: there.</p>
1.10 hubertf 2064: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2065: alter some configuration options at build time. Have a look at
2066: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2067: of what will be set there by default. Environment variables such
2068: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 2069: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2070: set them each time you want to use pkgsrc.</p>
1.23 wiz 2071: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2072: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 2073: or being installed. This may be for debugging purposes, or out of
2074: simple curiosity. A number of utility values have been added to
2075: help with this.</p>
1.23 wiz 2076: <div class="orderedlist"><ol class="orderedlist" type="1">
2077: <li class="listitem">
1.79 snj 2078: <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.1 dsieger 2079: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2080: information will be displayed. For example,</p>
2081: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2082: <p>will show all the commands that are invoked, up to and
1.23 wiz 2083: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 2084: </li>
1.23 wiz 2085: <li class="listitem">
1.79 snj 2086: <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.1 dsieger 2087: definition, then the <code class="varname">VARNAME</code> definition
2088: should be used, in conjunction with the show-var
1.79 snj 2089: 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.1 dsieger 2090: variable <code class="varname">LOCALBASE</code>:</p>
2091: <pre class="screen">
2092: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2093: /usr/pkg
2094: <code class="prompt">%</code>
2095: </pre>
2096: </li>
2097: </ol></div>
2098: <p>If you want to install a binary package that you've either
2099: created yourself (see next section), that you put into
2100: pkgsrc/packages manually or that is located on a remote FTP
2101: server, you can use the "bin-install" target. This target will
1.79 snj 2102: 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.10 hubertf 2103: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 2104: sites searched is kept in the variable
2105: <code class="varname">BINPKG_SITES</code>, which defaults to
1.79 snj 2106: 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.1 dsieger 2107: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2108: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2109: details.</p>
2110: <p>A final word of warning: If you set up a system that has a
2111: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2112: set that before any packages are installed, as you cannot use
2113: several directories for the same purpose. Doing so will result in
2114: pkgsrc not being able to properly detect your installed packages,
2115: and fail miserably. Note also that precompiled binary packages are
2116: usually built with the default <code class="varname">LOCALBASE</code> of
2117: <code class="filename">/usr/pkg</code>, and that you should
2118: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2119: <code class="varname">LOCALBASE</code>.</p>
2120: </div>
2121: </div>
2122: </div>
1.41 asau 2123: <div class="chapter">
1.1 dsieger 2124: <div class="titlepage"><div><div><h2 class="title">
2125: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2126: <div class="toc">
2127: <p><b>Table of Contents</b></p>
1.94 wiz 2128: <dl class="toc">
1.1 dsieger 2129: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2130: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 2131: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 2132: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2133: <dd><dl>
1.4 rillig 2134: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 2135: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2136: <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.1 dsieger 2137: </dl></dd>
1.4 rillig 2138: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2139: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2140: </dl>
2141: </div>
1.4 rillig 2142: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2143: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2144: that file depends on the installation. On NetBSD, when you use
1.79 snj 2145: <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.1 dsieger 2146: <code class="filename">/etc/</code>. In all other cases the default location is
2147: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2148: bootstrap program to install the binary packages.</p>
2149: <p>During the bootstrap, an example configuration file is created. To
2150: use that, you have to create the directory
2151: <code class="filename">${PREFIX}/etc</code> and copy the example file
2152: there.</p>
2153: <p>The format of the configuration file is that of the usual
2154: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2155: is done by setting variables in this file. Note that you can define all
2156: kinds of variables, and no special error checking (for example for
2157: spelling mistakes) takes place, so you have to try it out to see if it
2158: works.</p>
1.41 asau 2159: <div class="sect1">
1.1 dsieger 2160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2161: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2162: <p>In this section, you can find some variables that apply to all
2163: pkgsrc packages. A complete list of the variables that can be
2164: configured by the user is available in
2165: <code class="filename">mk/defaults/mk.conf</code>, together with some
2166: comments that describe each variable's intent.</p>
1.41 asau 2167: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2168: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 2169: packages will be installed. The default is
2170: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2171: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 2172: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2173: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 2174: installed. The default is
2175: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 2176: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 2177: X11 is installed on the system. The default is
1.84 wiz 2178: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 2179: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 2180: downloaded copies of the original source distributions used
2181: for building pkgsrc packages. The default is
2182: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 2183: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 2184: database about installed packages is stored. The default is
2185: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 2186: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 2187: If set, override the packages'
2188: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 2189: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 2190: Backup location(s) for distribution files and patch files
2191: if not found locally or in
2192: <code class="filename">${MASTER_SITES}</code> or
2193: <code class="filename">${PATCH_SITES}</code> respectively.
2194: The defaults are
1.25 spz 2195: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 2196: and
2197: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 2198: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 2199: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2200: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 2201: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2202: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2203: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 2204: List of acceptable licenses. License names are case-sensitive.
2205: Whenever you try to build a package whose license is not in this
2206: list, you will get an error message. If the license condition is
2207: simple enough, the error message will include specific
2208: instructions on how to change this variable.</p></li>
1.1 dsieger 2209: </ul></div>
2210: </div>
1.41 asau 2211: <div class="sect1">
1.1 dsieger 2212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2213: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2214: <p>XXX
2215: </p>
1.41 asau 2216: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2217: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 2218: directory for the binary packages. The default is
2219: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 2220: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 2221: The top level directory where, if defined, the separate
2222: working directories will get created, and symbolically
2223: linked to from <code class="filename">${WRKDIR}</code> (see below).
2224: This is useful for building packages on several
2225: architectures, then <code class="filename">${PKGSRCDIR}</code>
2226: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2227: is local to every architecture. (It should be noted that
2228: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 2229: — it is an internal definition which refers to the
1.1 dsieger 2230: root of the pkgsrc tree. It is possible to have many
2231: pkgsrc tree instances.)</p></li>
1.23 wiz 2232: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 2233: Directory for local patches that aren't part of pkgsrc.
1.10 hubertf 2234: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2235: information.</p></li>
1.23 wiz 2236: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 2237: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2238: BSD-style Makefile. If this is not set,
2239: <code class="varname">MAKECONF</code> is set to
2240: <code class="filename">/dev/null</code> to avoid picking up
2241: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 2242: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 2243: By default, dependencies are only installed, and no binary
2244: package is created for them. You can set this variable to
1.66 asau 2245: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 2246: packages after installing dependencies. Please note that the
1.84 wiz 2247: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 2248: <code class="literal">yes</code> to preserve binary packages when
2249: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 2250: </ul></div>
2251: </div>
1.41 asau 2252: <div class="sect1">
1.1 dsieger 2253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 2254: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24 wiz 2255: <p>Most packages support installation into a
1.4 rillig 2256: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2257: to be built, before the actual filesystem is touched. DESTDIR
2258: support exists in two variations:</p>
1.41 asau 2259: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2260: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 2261: installation and packaging is still run as root.</p></li>
2262: <li class="listitem"><p>Full DESTDIR support can run the complete
2263: build, installation and packaging as normal user. Root
2264: privileges are only needed to add packages.</p></li>
2265: </ul></div>
2266: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2267: you can set
2268: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2269: so it's preferable to convert a package to DESTDIR instead.</p>
1.4 rillig 2270: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2271: clean</code></strong> needs to be run as root.</p>
1.17 imil 2272: <p>Considering the <code class="filename">foo/bar</code> package,
2273: DESTDIR full support can be tested using the following commands
2274:
2275: </p>
2276: <pre class="programlisting">
2277: <code class="prompt">$</code> id
2278: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2279: <code class="prompt">$</code> mkdir $HOME/packages
2280: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2281: </pre>
2282: <p>
2283:
2284: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2285: should be needed
2286:
2287: </p>
2288: <pre class="programlisting">
1.66 asau 2289: <code class="prompt">$</code> make stage-install
1.17 imil 2290: </pre>
2291: <p>
2292:
2293: Create a package without root privileges
2294:
2295: </p>
2296: <pre class="programlisting">
1.66 asau 2297: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 2298: </pre>
2299: <p>
2300:
2301: For the following command, you must be able to gain root
1.79 snj 2302: 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.17 imil 2303:
2304: </p>
2305: <pre class="programlisting">
1.66 asau 2306: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 2307: </pre>
2308: <p>
2309:
2310: Then, as a simple user
2311:
2312: </p>
2313: <pre class="programlisting">
2314: <code class="prompt">$</code> make clean
2315: </pre>
2316: <p>
2317:
2318: </p>
1.4 rillig 2319: </div>
1.41 asau 2320: <div class="sect1">
1.4 rillig 2321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2322: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 2323: <div class="sect2">
1.1 dsieger 2324: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2325: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2326: <p>By default, pkgsrc will use GCC to build packages. This may be
2327: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 2328: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2329: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2330: <dd>
2331: <p>This is a list of values specifying the chain of
2332: compilers to invoke when building packages. Valid values
2333: are:</p>
1.41 asau 2334: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 2335: <li class="listitem"><p><code class="varname">ccc</code>:
2336: Compaq C Compilers (Tru64)</p></li>
2337: <li class="listitem"><p><code class="varname">ccache</code>:
2338: compiler cache (chainable)</p></li>
2339: <li class="listitem"><p><code class="varname">clang</code>:
2340: Clang C and Objective-C compiler</p></li>
1.23 wiz 2341: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 2342: distributed C/C++ (chainable)</p></li>
1.66 asau 2343: <li class="listitem"><p><code class="varname">f2c</code>:
2344: Fortran 77 to C compiler (chainable)</p></li>
2345: <li class="listitem"><p><code class="varname">icc</code>:
2346: Intel C++ Compiler (Linux)</p></li>
2347: <li class="listitem"><p><code class="varname">ido</code>:
2348: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 2349: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 2350: GNU C/C++ Compiler</p></li>
1.66 asau 2351: <li class="listitem"><p><code class="varname">hp</code>:
2352: HP-UX C/aC++ compilers</p></li>
1.23 wiz 2353: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2354: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 2355: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 2356: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 2357: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 2358: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 2359: <li class="listitem"><p><code class="varname">xlc</code>:
2360: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 2361: </ul></div>
2362: <p>The default is
1.23 wiz 2363: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 2364: <code class="varname">ccache</code> and/or
2365: <code class="varname">distcc</code> with an appropriate
2366: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 2367: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 2368: variable should always be terminated with a value for
2369: a real compiler. Note that only one real compiler
1.23 wiz 2370: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 2371: is not allowed).</p>
2372: </dd>
2373: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2374: <dd><p>This specifies the minimum version of GCC to use
2375: when building packages. If the system GCC doesn't
2376: satisfy this requirement, then pkgsrc will build and
2377: install one of the GCC packages to use instead.</p></dd>
2378: </dl></div>
2379: </div>
1.41 asau 2380: <div class="sect2">
1.1 dsieger 2381: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2382: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2383: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2384: please make sure to use the <code class="literal">+=</code> operator
2385: instead of the <code class="literal">=</code> operator:</p>
2386: <pre class="programlisting">
2387: CFLAGS+= -your -flags
2388: </pre>
2389: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2390: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2391: need to add their own flags. You may want to take a look
1.79 snj 2392: 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.23 wiz 2393: package if you're interested in optimization specifically
2394: for the current CPU. </p>
1.1 dsieger 2395: </div>
1.41 asau 2396: <div class="sect2">
1.1 dsieger 2397: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2398: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2399: <p>If you want to pass flags to the linker, both in the configure
2400: step and the build step, you can do this in two ways. Either set
2401: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2402: between the two is that <code class="varname">LIBS</code> will be appended to
2403: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2404: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2405: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2406: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2407: <code class="varname">CFLAGS</code>, if you do not wish to override these
2408: settings, use the <code class="literal">+=</code> operator:</p>
2409: <pre class="programlisting">
2410: LDFLAGS+= -your -linkerflags
2411: </pre>
2412: </div>
2413: </div>
1.41 asau 2414: <div class="sect1">
1.1 dsieger 2415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2416: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 2417: <p>
1.1 dsieger 2418: </p>
1.41 asau 2419: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2420: <li class="listitem">
1.1 dsieger 2421: <p><code class="varname">PKG_DEVELOPER</code>:
2422: Run some sanity checks that package developers want:
2423: </p>
1.41 asau 2424: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2425: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 2426: fuzz</p></li>
1.23 wiz 2427: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 2428: binaries will find their shared libs.</p></li>
2429: </ul></div>
2430: <p>
2431: </p>
2432: </li>
1.23 wiz 2433: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 2434: of debugging output which is displayed whilst making and
2435: installing the package. The default value for this is 0,
2436: which will not display the commands as they are executed
2437: (normal, default, quiet operation); the value 1 will display
2438: all shell commands before their invocation, and the value 2
2439: will display both the shell commands before their invocation,
1.10 hubertf 2440: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 2441: -x</strong></span> will be displayed.</p></li>
2442: </ul></div>
2443: <p>
2444: </p>
2445: </div>
1.41 asau 2446: <div class="sect1">
1.1 dsieger 2447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2448: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2449: <p>Some packages have build time options, usually to select
2450: between different dependencies, enable optional support for big
2451: dependencies or enable experimental features.</p>
2452: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2453: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2454: show-options</strong></span>, for example:</p>
2455: <pre class="programlisting">
2456: The following options are supported by this package:
2457: ssl Enable SSL support.
2458: Exactly one of the following gecko options is required:
2459: firefox Use firefox as gecko rendering engine.
2460: mozilla Use mozilla as gecko rendering engine.
2461: At most one of the following database options may be selected:
2462: mysql Enable support for MySQL database.
2463: pgsql Enable support for PostgreSQL database.
2464:
2465: These options are enabled by default: firefox
2466: These options are currently enabled: mozilla ssl
2467: </pre>
2468: <p>The following variables can be defined in
1.10 hubertf 2469: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2470: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2471: which can be used to select or disable options for all packages
2472: that support them, and
2473: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2474: which can be used to select or disable options specifically for
2475: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2476: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2477: are disabled. A few examples:</p>
2478: <pre class="screen">
1.10 hubertf 2479: <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.1 dsieger 2480: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2481: PKG_OPTIONS.kdebase= debug -sasl
2482: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2483: <p>It is important to note that options that were specifically
1.18 snj 2484: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2485: you do not wish to include the option. If you are unsure you can view
2486: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2487: <p>The following settings are consulted in the order given, and
2488: the last setting that selects or disables an option is
2489: used:</p>
1.23 wiz 2490: <div class="orderedlist"><ol class="orderedlist" type="1">
2491: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2492: maintainer</p></li>
1.23 wiz 2493: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2494: variables (see below)</p></li>
1.23 wiz 2495: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2496: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2497: </ol></div>
2498: <p>For groups of mutually exclusive options, the last option
2499: selected is used, all others are automatically disabled. If an
2500: option of the group is explicitly disabled, the previously
2501: selected option, if any, is used. It is an error if no option
2502: from a required group of options is selected, and building the
2503: package will fail.</p>
2504: <p>Before the options framework was introduced, build options
2505: were selected by setting a variable (often named
2506: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2507: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2508: transition to the options framework for the user, these legacy
2509: variables are converted to the appropriate options setting
2510: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2511: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2512: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2513: directly. Support for the legacy variables will be removed
2514: eventually.</p>
2515: </div>
2516: </div>
1.41 asau 2517: <div class="chapter">
1.1 dsieger 2518: <div class="titlepage"><div><div><h2 class="title">
2519: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2520: <div class="toc">
2521: <p><b>Table of Contents</b></p>
1.94 wiz 2522: <dl class="toc">
1.1 dsieger 2523: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2524: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2525: </dl>
2526: </div>
1.41 asau 2527: <div class="sect1">
1.1 dsieger 2528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2529: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2530: <p>Once you have built and installed a package, you can create
2531: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.79 snj 2532: 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.1 dsieger 2533: the same package on a group of hosts and wasting CPU time. It also
2534: provides a simple means for others to install your package, should
2535: you distribute it.</p>
2536: <p>To create a binary package, change into the appropriate
1.10 hubertf 2537: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2538: package</strong></span>:</p>
2539: <pre class="screen">
2540: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2541: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2542: </pre>
2543: <p>This will build and install your package (if not already done),
2544: and then build a binary package from what was installed. You can
1.10 hubertf 2545: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2546: it. Binary packages are created by default in
2547: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2548: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.79 snj 2549: 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.10 hubertf 2550: <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.1 dsieger 2551: such a binary package.</p>
2552: </div>
1.41 asau 2553: <div class="sect1">
1.1 dsieger 2554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2555: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2556: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.6 rillig 2557: </div>
2558: </div>
1.41 asau 2559: <div class="chapter">
1.6 rillig 2560: <div class="titlepage"><div><div><h2 class="title">
2561: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2562: builds)</h2></div></div></div>
2563: <div class="toc">
2564: <p><b>Table of Contents</b></p>
1.94 wiz 2565: <dl class="toc">
1.71 wiz 2566: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2567: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2568: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2569: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2570: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2571: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2572: </dl>
2573: </div>
1.71 wiz 2574: <p>For a number of reasons you may want to build binary packages
2575: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2576: For instance, when you have multiple machines that should run the same software,
2577: it is wasted time if they all build their packages themselves from source.
2578: Or you may want to build a list of packages you want and check them before
2579: deploying onto production system.
2580: There is a way of getting a set of binary packages:
1.66 asau 2581: The bulk build system, or pbulk ("p" stands for "parallel).
2582: This chapter describes how to set it up so that the packages
1.6 rillig 2583: are most likely to be usable later.</p>
1.41 asau 2584: <div class="sect1">
1.6 rillig 2585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2586: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2587: <p>First of all, you have to decide whether you build all packages
2588: or a limited set of them. Full bulk builds usually consume a lot more resources,
2589: both space and time, than builds for some practical sets of packages.
2590: There exists a number of particularly heavy packages that are not actually
2591: interesting to a wide audience.
2592:
2593: For a limited bulk builds you need to make a list of packages you want to build.
2594: Note, that all their dependencies will be built, so you don't need to track them manually.
2595: </p>
2596: <p>During bulk builds various packages are installed and deinstalled
2597: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2598: so make sure that you don't need any package during the builds.
2599: Essentially, you should provide fresh system, either a chroot environment
2600: or something even more restrictive, depending on what the operating system provides,
2601: or dedicate the whole physical machine.
2602: As a useful side effect this makes sure that bulk builds cannot
2603: break anything in your system. There have been numerous cases where
1.6 rillig 2604: certain packages tried to install files outside the
2605: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2606: <code class="filename">/etc</code>.
2607: </p>
1.6 rillig 2608: </div>
1.41 asau 2609: <div class="sect1">
1.6 rillig 2610: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2611: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2612: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2613: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2614: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2615: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2616: </ul></div>
1.41 asau 2617: <div class="sect2">
1.15 rillig 2618: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2619: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.68 asau 2620: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2621: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2622: Configure network access to fetch distribution files.
2623: Create user with name "pbulk".</p>
2624: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2625: <pre class="screen">
1.72 wiz 2626: <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>
2627: <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>
2628: <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.68 asau 2629: </pre>
2630: <p>Or any other way that fits (e.g., curl, wget).</p>
2631: <p>Deploy and configure pbulk tools, e.g.:</p>
2632: <pre class="screen">
2633: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2634: <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>
2635: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2636: </pre>
2637: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2638: <h3 class="title">Note</h3>
2639: <p><code class="filename">mk.conf.frag</code> is a fragment of
2640: <code class="filename">mk.conf</code> that contains settings you want to
2641: apply to packages you build. For instance,</p>
2642: <pre class="programlisting">
2643: PKG_DEVELOPER= yes # perform more checks
2644: X11_TYPE= modular # use pkgsrc X11
2645: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2646: </pre>
2647: </div>
2648: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2649: with your list of packages one per line without empty lines or comments. E.g.:</p>
2650: <pre class="programlisting">
2651: www/firefox
2652: mail/thunderbird
2653: misc/libreoffice4
2654: </pre>
1.69 asau 2655: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2656: and make final amendments, if wanted.</p>
1.68 asau 2657: <p>Start it:</p>
2658: <pre class="screen">
2659: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2660: </pre>
2661: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2662: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2663: </p>
2664: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2665: <h3 class="title">Note</h3>
2666: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2667: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2668: The script is kept small enough for better understanding.</p>
2669: </div>
2670: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2671: <h3 class="title">Note</h3>
2672: <p>The <code class="filename">pbulk.sh</code> script supports running
2673: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2674: </div>
1.6 rillig 2675: </div>
2676: </div>
1.41 asau 2677: <div class="sect1">
1.6 rillig 2678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2679: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2680: <p>A complete bulk build requires lots of disk space. Some of the
2681: disk space can be read-only, some other must be writable. Some can be on
2682: remote filesystems (such as NFS) and some should be local. Some can be
2683: temporary filesystems, others must survive a sudden reboot.</p>
2684: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2685: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2686: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2687: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2688: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2689: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2690: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2691: </ul></div>
2692: </div>
2693: <div class="sect1">
2694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2695: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2696: <p>After your pkgsrc bulk-build has completed, you may wish to
2697: create a CD-ROM set of the resulting binary packages to assist
2698: in installing packages on other machines. The
1.79 snj 2699: <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.1 dsieger 2700: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2701: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2702: way that keeps all the dependencies for a given package on the same
2703: CD as that package.</p>
1.41 asau 2704: <div class="sect2">
1.1 dsieger 2705: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2706: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2707: <p>Complete documentation for cdpack is found in the cdpack(1)
2708: man page. The following short example assumes that the binary
2709: packages are left in
2710: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2711: sufficient disk space exists in <code class="filename">/u2</code> to
2712: hold the ISO 9660 images.</p>
2713: <pre class="screen">
2714: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2715: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2716: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2717: </pre>
2718: <p>If you wish to include a common set of files
2719: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2720: etc.) on each CD in the collection, then you need to create a
2721: directory which contains these files. e.g.</p>
2722: <pre class="screen">
2723: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2724: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2725: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2726: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2727: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2728: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2729: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2730: </pre>
2731: <p>Now create the images:</p>
2732: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2733: <p>Each image will contain <code class="filename">README</code>,
2734: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2735: in their root directories.</p>
2736: </div>
2737: </div>
2738: </div>
1.41 asau 2739: <div class="chapter">
1.1 dsieger 2740: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2741: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2742: <div class="toc">
2743: <p><b>Table of Contents</b></p>
1.94 wiz 2744: <dl class="toc">
1.23 wiz 2745: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2746: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 2747: </dl>
2748: </div>
2749: <p>The files that are installed by pkgsrc are organized in a way that
2750: is similar to what you find in the <code class="filename">/usr</code> directory
2751: of the base system. But some details are different. This is because
2752: pkgsrc initially came from FreeBSD and had adopted its file system
2753: hierarchy. Later it was largely influenced by NetBSD. But no matter
2754: which operating system you are using pkgsrc with, you can expect the
2755: same layout for pkgsrc.</p>
2756: <p>There are mainly four root directories for pkgsrc, which are all
2757: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2758: When pkgsrc has been installed as root, the default locations
2759: are:</p>
2760: <pre class="programlisting">
2761: LOCALBASE= /usr/pkg
2762: PKG_SYSCONFBASE= /usr/pkg/etc
2763: VARBASE= /var
2764: PKG_DBDIR= /var/db/pkg
2765: </pre>
2766: <p>In unprivileged mode (when pkgsrc has been installed as any other
2767: user), the default locations are:</p>
2768: <pre class="programlisting">
2769: LOCALBASE= ${HOME}/pkg
2770: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2771: VARBASE= ${HOME}/pkg/var
2772: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2773: </pre>
2774: <p>What these four directories are for, and what they look like is
2775: explained below.</p>
1.41 asau 2776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2777: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2778: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2779: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2780: the well-known subdirectories like <code class="filename">bin</code>,
2781: <code class="filename">include</code>, <code class="filename">lib</code>,
2782: <code class="filename">share</code> and
2783: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2784: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2785: <code class="filename">/var</code> in the base system. Some programs (especially
2786: games, network daemons) need write access to it during normal
2787: operation.</p></li>
1.23 wiz 2788: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2789: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2790: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 2791: itself.</p></li>
2792: </ul></div>
1.41 asau 2793: <div class="sect1">
1.1 dsieger 2794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2795: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2796: </h2></div></div></div>
2797: <p>The following directories exist in a typical pkgsrc installation
2798: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2799: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2800: <dt><span class="term"><code class="filename">bin</code></span></dt>
2801: <dd><p>Contains executable programs that are intended to be
2802: directly used by the end user.</p></dd>
2803: <dt><span class="term"><code class="filename">emul</code></span></dt>
2804: <dd><p>Contains files for the emulation layers of various other
2805: operating systems, especially for
2806: NetBSD.</p></dd>
2807: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2808: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2809: <dd><p>Contains
2810: the configuration files.</p></dd>
2811: <dt><span class="term"><code class="filename">include</code></span></dt>
2812: <dd><p>Contains headers for the C and C++ programming
2813: languages.</p></dd>
2814: <dt><span class="term"><code class="filename">info</code></span></dt>
2815: <dd><p>Contains GNU info files of various
2816: packages.</p></dd>
2817: <dt><span class="term"><code class="filename">lib</code></span></dt>
2818: <dd><p>Contains shared and static
2819: libraries.</p></dd>
2820: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2821: <dd><p>Contains data files that don't change after
2822: installation. Other data files belong into
2823: <code class="filename">${VARBASE}</code>.</p></dd>
2824: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2825: <dd><p>Contains programs that are not intended to be used by
2826: end users, such as helper programs or network
2827: daemons.</p></dd>
2828: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2829: <dd><p>Contains programs that are intended to be executed as
2830: CGI scripts by a web server.</p></dd>
2831: <dt><span class="term"><code class="filename">man</code> (the usual value of
2832: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2833: <dd><p>Contains brief
2834: documentation in form of manual pages.</p></dd>
2835: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2836: <dd><p>Contains programs that are intended to be used only by
2837: the super-user.</p></dd>
2838: <dt><span class="term"><code class="filename">share</code></span></dt>
2839: <dd><p>Contains platform-independent data files that don't
2840: change after installation.</p></dd>
2841: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2842: <dd><p>Contains documentation files provided by the
2843: packages.</p></dd>
2844: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2845: <dd><p>Contains example files provided by the packages. Among
2846: others, the original configuration files are saved here and copied to
2847: <code class="filename">${PKG_SYSCONFDIR}</code> during
2848: installation.</p></dd>
2849: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2850: <dd><p>Contains the original files for rc.d
2851: scripts.</p></dd>
2852: <dt><span class="term"><code class="filename">var</code> (the usual location of
2853: <code class="filename">${VARBASE}</code>)</span></dt>
2854: <dd><p>Contains files
2855: that may be modified after
2856: installation.</p></dd>
2857: </dl></div>
2858: </div>
1.41 asau 2859: <div class="sect1">
1.1 dsieger 2860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2861: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2862: </h2></div></div></div>
1.41 asau 2863: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2864: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2865: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2866: <dd><p>Contains
2867: information about the currently installed
2868: packages.</p></dd>
2869: <dt><span class="term"><code class="filename">games</code></span></dt>
2870: <dd><p>Contains highscore
2871: files.</p></dd>
2872: <dt><span class="term"><code class="filename">log</code></span></dt>
2873: <dd><p>Contains log files.</p></dd>
2874: <dt><span class="term"><code class="filename">run</code></span></dt>
2875: <dd><p>Contains informational files about daemons that are
2876: currently running.</p></dd>
2877: </dl></div>
2878: </div>
2879: </div>
1.41 asau 2880: <div class="chapter">
1.1 dsieger 2881: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2882: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2883: <div class="toc">
2884: <p><b>Table of Contents</b></p>
1.94 wiz 2885: <dl class="toc">
1.6 rillig 2886: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84 wiz 2887: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2888: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2889: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2890: <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>
2891: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2892: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2893: <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>
2894: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2895: <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.23 wiz 2896: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2897: <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>
2898: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2899: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2900: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2901: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2902: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2903: <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.1 dsieger 2904: </dl>
2905: </div>
2906: <p>This section contains hints, tips & tricks on special things in
2907: pkgsrc that we didn't find a better place for in the previous chapters, and
2908: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2909: <div class="sect1">
1.1 dsieger 2910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2911: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2912: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2913: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2914: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 2915: This is a general purpose list for most issues regarding
2916: pkgsrc, regardless of platform, e.g. soliciting user help
2917: for pkgsrc configuration, unexpected build failures, using
2918: particular packages, upgrading pkgsrc installations,
2919: questions regarding the pkgsrc release branches, etc. General announcements or
2920: proposals for changes that impact the pkgsrc user community,
2921: e.g. major infrastructure changes, new features, package
2922: removals, etc., may also be posted.</p></li>
1.23 wiz 2923: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2924: A list where the results of pkgsrc bulk builds are sent and
2925: discussed.</p></li>
1.23 wiz 2926: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2927: This list is for those who are interested in getting a
2928: commit message for every change committed to pkgsrc. It is
2929: also available in digest form, meaning one daily message
2930: containing all commit messages for changes to the package
2931: source tree in that 24 hour period.</p></li>
2932: </ul></div>
2933: <p>To subscribe, do:</p>
2934: <pre class="programlisting">
2935: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2936: </pre>
2937: <p>Archives for all these mailing lists are available from
1.10 hubertf 2938: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2939: </div>
1.41 asau 2940: <div class="sect1">
1.1 dsieger 2941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2942: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2943: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2944: a number of useful utilities for both users and developers of pkgsrc. This
2945: section attempts only to make the reader aware of the utilities and when
2946: they might be useful, and not to duplicate the documentation that comes
2947: with each package.</p>
2948: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.79 snj 2949: <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.1 dsieger 2950: Symlinks for use by buildlink.</p></li></ul></div>
2951: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2953: <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.1 dsieger 2954: Calculates various kinds of checksums (including SHA1).</p></li>
1.79 snj 2955: <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.1 dsieger 2956: Compatibility library for pkgsrc tools.</p></li>
1.79 snj 2957: <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.1 dsieger 2958: non-BSD systems due to lack of native mtree.</p></li>
1.79 snj 2959: <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.1 dsieger 2960: Up-to-date replacement for
2961: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2962: systems where pkg_install is not present.</p></li>
2963: </ul></div>
2964: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2966: <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.1 dsieger 2967: Create a binary package from an
1.10 hubertf 2968: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2969: save the old package.</p></li>
1.79 snj 2970: <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.1 dsieger 2971: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2972: from multiple locations. It currently supports the following
2973: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.79 snj 2974: <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.16 jnemeth 2975: the best compiler flags to optimise code for your current
1.23 wiz 2976: CPU and compiler. </p></li>
1.1 dsieger 2977: </ul></div>
2978: <p>Utilities for keeping track of installed packages, being up to date,
2979: etc:</p>
1.41 asau 2980: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2981: <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.65 wiz 2982: update tool similar to apt(1). Download, install, and upgrade
2983: binary packages easily.</p></li>
1.79 snj 2984: <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.1 dsieger 2985: packages whose installed versions do not match the latest pkgsrc
2986: entries.</p></li>
1.79 snj 2987: <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.1 dsieger 2988: dependency graphs of packages, to aid in choosing a strategy for
2989: updating.</p></li>
1.79 snj 2990: <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
2991: 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>
2992: <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.12 weinem 2993: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.79 snj 2994: <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.1 dsieger 2995: does various checks on the complete pkgsrc system.</p></li>
1.79 snj 2996: <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.1 dsieger 2997: packages you have installed.</p></li>
2998: </ul></div>
2999: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 3000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 3001: <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.1 dsieger 3002: making and maintaining patches for a package (includes pkgdiff,
3003: pkgvi, mkpatches, etc.).</p></li>
1.79 snj 3004: <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.1 dsieger 3005: converting to pkgsrc.</p></li>
3006: </ul></div>
3007: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3008: utilities)</p>
1.41 asau 3009: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 3010: <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.1 dsieger 3011: packages in a chrooted area.</p></li>
1.79 snj 3012: <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.1 dsieger 3013: kernel version for chrooted cross builds.</p></li>
3014: </ul></div>
3015: </div>
1.41 asau 3016: <div class="sect1">
1.1 dsieger 3017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3018: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3019: <p>If you want to use pkgsrc as non-root user, you can set some
3020: variables to make pkgsrc work under these conditions. At the very least,
1.23 wiz 3021: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.1 dsieger 3022: will turn on unprivileged mode and set multiple related variables to allow
3023: installation of packages as non-root.</p>
3024: <p>In case the defaults are not enough, you may want to tune some other
3025: variables used. For example, if the automatic user/group detection leads
3026: to incorrect values (or not the ones you would like to use), you can change
3027: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3028: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3029: <p>As regards bootstrapping, please note that the
1.10 hubertf 3030: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23 wiz 3031: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.1 dsieger 3032: use multiple default directories under <code class="filename">~/pkg</code> as the
3033: installation targets. These directories can be overridden by the
1.23 wiz 3034: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.1 dsieger 3035: that allow finer tuning of the tree layout.</p>
3036: </div>
1.41 asau 3037: <div class="sect1">
1.1 dsieger 3038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3039: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3040: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3041: enable this feature by adding the option
3042: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 3043: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3044: distfile is found, pkgsrc will try to resume it.</p>
3045: <p>You can also
1.61 wiz 3046: use a different program than the platform default program by changing the
1.16 jnemeth 3047: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3048: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3049: by using the value manual. A value of custom disables the system defaults
3050: and dependency tracking for the fetch program. In that case you have to
3051: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3052: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3053: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 3054: <p>For example, if you want to use
1.16 jnemeth 3055: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 3056: like:</p>
3057: <pre class="programlisting">
1.16 jnemeth 3058: FETCH_USING= wget
1.1 dsieger 3059: </pre>
3060: </div>
1.41 asau 3061: <div class="sect1">
1.1 dsieger 3062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3063: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 3064: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3065: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3066: you will have to add the following line into
1.10 hubertf 3067: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3068: <pre class="programlisting">
1.4 rillig 3069: X11_TYPE=modular
1.1 dsieger 3070: </pre>
1.41 asau 3071: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 3072: <h3 class="title">Note</h3>
1.4 rillig 3073: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3074: </p>
1.1 dsieger 3075: </div>
3076: </div>
1.41 asau 3077: <div class="sect1">
1.1 dsieger 3078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3079: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3080: <p>If you are sitting behind a firewall which does not allow direct
3081: connections to Internet hosts (i.e. non-NAT), you may specify the
3082: relevant proxy hosts. This is done using an environment variable in the
3083: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 3084: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3085: port 80 as the proxy port number. So the proxy environment variables
3086: are:</p>
3087: <pre class="programlisting">
3088: ftp_proxy=ftp://orpheus.amdahl.com:80/
3089: http_proxy=http://orpheus.amdahl.com:80/
3090: </pre>
3091: </div>
1.41 asau 3092: <div class="sect1">
1.1 dsieger 3093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3094: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 3095: <p>Some fetch tools are not prepared to support HTTPS by default
3096: (for example, the one in NetBSD 6.0), or the one installed by the
3097: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3098: dependency graph).</p>
3099: <p>Usually you won't notice, because distribution files are
3100: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3101: be often enough if you are following pkgsrc-current. In that case, set
3102: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3103: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3104: with HTTPS support by default. Of course, these tools need to be
3105: installed before you can use them this way.</p>
3106: </div>
3107: <div class="sect1">
3108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3109: <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.1 dsieger 3110: <p>This depends on which utility is used to retrieve distfiles. From
3111: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3112: the first available command from the following list:</p>
1.41 asau 3113: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3114: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3115: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3116: </ul></div>
3117: <p>On a default NetBSD installation, this will be
3118: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3119: connections first, and falls back to active connections if the server
3120: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3121: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3122: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3123: <p>Having that option present will prevent
3124: <code class="filename">/usr/bin/ftp</code> from falling back to active
3125: transfers.</p>
3126: </div>
1.41 asau 3127: <div class="sect1">
1.1 dsieger 3128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3129: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3130: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3131: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3132: 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.1 dsieger 3133: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3134: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3135: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3136: resulting list to your machine at work/school and use it there. If you
1.79 snj 3137: 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.1 dsieger 3138: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3139: URL:</p>
3140: <p>At home:</p>
3141: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3142: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3143: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3144: <p>At work:</p>
3145: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3146: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3147: home.</p>
3148: <p>If you have a machine running NetBSD, and you want to get
3149: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3150: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3151: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3152: directly by running:</p>
3153: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3154: <p>If you even decide to ignore
3155: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3156: by running:</p>
3157: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3158: </div>
1.41 asau 3159: <div class="sect1">
1.1 dsieger 3160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3161: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 3162: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.79 snj 3163: <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.1 dsieger 3164: package, you get the error from make that it doesn't know how to make
3165: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3166: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3167: the NetBSD base distribution on your machine. It is recommended to do
3168: that to format man pages.</p>
1.79 snj 3169: <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.1 dsieger 3170: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3171: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3172: </div>
1.41 asau 3173: <div class="sect1">
1.1 dsieger 3174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3175: <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.1 dsieger 3176: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3177: when you installed your NetBSD machine. Please get and install it, by
3178: extracting it in <code class="filename">/</code>:</p>
3179: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3180: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3181: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3182: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3183: -r</strong></span>).</p>
3184: </div>
1.41 asau 3185: <div class="sect1">
1.1 dsieger 3186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3187: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3188: <p>When installing packages as non-root user and using the just-in-time
1.79 snj 3189: <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.1 dsieger 3190: password for each required package installed. To avoid this, the sudo
3191: package can be used, which does password caching over a limited time. To
3192: use it, install sudo (either as binary package or from
1.79 snj 3193: <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.10 hubertf 3194: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3195: <span class="emphasis"><em>after</em></span> the definition of the
3196: <code class="varname">LOCALBASE</code> variable:</p>
3197: <pre class="programlisting">
3198: .if exists(${LOCALBASE}/bin/sudo)
3199: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3200: .endif
3201: </pre>
3202: </div>
1.41 asau 3203: <div class="sect1">
1.1 dsieger 3204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3205: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3206: <p>As the system administrator, you can choose where configuration files
3207: are installed. The default settings make all these files go into
3208: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3209: be suboptimal depending on your expectations (e.g., a read-only,
3210: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3211: configuration of the provided packages).</p>
3212: <p>In order to change the defaults, you can modify the
3213: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3214: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3215: directory; some common examples include <code class="filename">/etc</code> or
3216: <code class="filename">/etc/pkg</code>.</p>
3217: <p>Furthermore, you can change this value on a per-package basis by
3218: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3219: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3220: package you would like to modify, that is, the contents of
3221: <code class="varname">PKGBASE</code>.</p>
3222: <p>Note that after changing these settings, you must rebuild and
3223: reinstall any affected packages.</p>
3224: </div>
1.41 asau 3225: <div class="sect1">
1.1 dsieger 3226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3227: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3228: <p>Please be aware that there can often be bugs in third-party software,
3229: and some of these bugs can leave a machine vulnerable to exploitation by
3230: attackers. In an effort to lessen the exposure, the NetBSD packages team
3231: maintains a database of known-exploits to packages which have at one time
3232: been included in pkgsrc. The database can be downloaded automatically, and
3233: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3234: do this, refer to the following two tools (installed as part of the
1.79 snj 3235: <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.23 wiz 3236: <div class="orderedlist"><ol class="orderedlist" type="1">
3237: <li class="listitem">
1.20 snj 3238: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3239: download a list of the security vulnerabilities information. This list
1.25 spz 3240: is kept up to date by the pkgsrc security team, and is distributed
3241: from the NetBSD ftp server:</p>
3242: <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.1 dsieger 3243: </li>
1.23 wiz 3244: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3245: current machine, checking each known vulnerability. If a
1.1 dsieger 3246: vulnerable package is installed, it will be shown by output to stdout,
3247: including a description of the type of vulnerability, and a URL
3248: containing more information.</p></li>
3249: </ol></div>
1.14 jmcneill 3250: <p>Use of these tools is strongly recommended! After
1.23 wiz 3251: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 3252: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 3253: pkg_install</code></strong>.</p>
1.1 dsieger 3254: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 3255: 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.1 dsieger 3256: check.</p>
3257: </div>
1.41 asau 3258: <div class="sect1">
1.1 dsieger 3259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3260: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3261: <p>When you add your own preferences to the
3262: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3263: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3264: environment variables to the <code class="filename">./configure</code>
1.79 snj 3265: 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.1 dsieger 3266: <code class="varname">CFLAGS</code> from the environment variable by
3267: overriding them in the <code class="filename">Makefile</code>s of their
3268: package.</p>
3269: <p>Currently there is no solution to this problem. If you
3270: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3271: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3272: directory and then inspect any <code class="filename">Makefile</code> and
3273: <code class="filename">Makefile.in</code> for whether they define
3274: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3275: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3276: programmers write so bad code that it only works for the
3277: specific combination of <code class="varname">CFLAGS</code> they have
3278: chosen.</p>
3279: </div>
1.41 asau 3280: <div class="sect1">
1.1 dsieger 3281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3282: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3283: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3284: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3285: case that occurs often is that people only update pkgsrc in
3286: parts, because of performance reasons. Since pkgsrc is one large
3287: system, not a collection of many small systems, there are
3288: sometimes changes that only work when the whole pkgsrc tree is
3289: updated.</p></li>
1.41 asau 3290: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3291: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3292: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3293: files.</p></li>
1.41 asau 3294: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3295: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3296: verify this.</p></li>
1.41 asau 3297: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3298: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3299: </ol></div>
3300: </div>
1.41 asau 3301: <div class="sect1">
1.1 dsieger 3302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3303: <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.1 dsieger 3304: <p>You have modified a file from pkgsrc, and someone else has
3305: modified that same file afterwards in the CVS repository. Both changes
3306: are in the same region of the file, so when you updated pkgsrc, the
3307: <code class="literal">cvs</code> command marked the conflicting changes in the
3308: file. Because of these markers, the file is no longer a valid
3309: <code class="filename">Makefile</code>.</p>
3310: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3311: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3312: -dP</strong></span> in that directory to download the current version.</p>
3313: </div>
3314: </div>
3315: </div>
1.41 asau 3316: <div class="part">
1.1 dsieger 3317: <div class="titlepage"><div><div><h1 class="title">
3318: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3319: <div class="partintro">
1.1 dsieger 3320: <div></div>
3321: <p>This part of the book deals with creating and
1.23 wiz 3322: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3323: guide on creating a new package. The remaining chapters are more
3324: like a reference manual for pkgsrc.</p>
3325: <div class="toc">
3326: <p><b>Table of Contents</b></p>
1.94 wiz 3327: <dl class="toc">
1.6 rillig 3328: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3329: <dd><dl>
1.6 rillig 3330: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3331: <dd><dl>
1.6 rillig 3332: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3333: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3334: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3335: </dl></dd>
1.6 rillig 3336: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3337: <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>
3338: </dl></dd>
3339: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3340: <dd><dl>
1.23 wiz 3341: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3342: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3343: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3344: <dd><dl>
3345: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3346: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3347: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3348: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3349: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3350: </dl></dd>
3351: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3352: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3353: <dd><dl>
3354: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3355: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3356: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3357: </dl></dd>
1.23 wiz 3358: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3359: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3360: </dl></dd>
1.23 wiz 3361: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3362: <dd><dl>
3363: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 3364: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 3365: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3366: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3367: <dd><dl>
3368: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3369: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3370: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3371: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3372: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3373: </dl></dd>
3374: </dl></dd>
3375: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3376: <dd><dl>
3377: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 3378: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3379: <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.6 rillig 3380: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3381: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 3382: <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.6 rillig 3383: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 3384: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
3385: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3386: </dl></dd>
3387: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3388: <dd><dl>
3389: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 3390: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3391: <dd><dl>
3392: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 3393: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3394: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3395: and
3396: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3397: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3398: </dl></dd>
1.23 wiz 3399: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 3400: <dd><dl>
1.23 wiz 3401: <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.6 rillig 3402: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3403: </dl></dd>
3404: </dl></dd>
3405: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3406: <dd><dl>
3407: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3408: <dd><dl>
3409: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3410: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3411: </dl></dd>
3412: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3413: <dd><dl>
1.23 wiz 3414: <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.6 rillig 3415: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3416: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3417: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3418: </dl></dd>
3419: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3420: <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>
3421: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3422: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3423: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3424: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3425: <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>
3426: </dl></dd>
3427: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3428: <dd><dl>
3429: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 3430: <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.6 rillig 3431: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3432: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3433: </dl></dd>
3434: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3435: <dd><dl>
3436: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3437: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3438: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3439: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 3440: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3441: <dd><dl>
3442: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3443: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3444: </dl></dd>
1.23 wiz 3445: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3446: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3447: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3448: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3449: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3450: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3451: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3452: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3453: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3454: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 3455: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3456: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3457: </dl></dd>
3458: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3459: <dd><dl>
3460: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3461: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3462: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3463: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3464: </dl></dd>
3465: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3466: <dd><dl>
3467: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3468: <dd><dl>
3469: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 3470: <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.6 rillig 3471: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3472: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3473: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3474: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3475: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3476: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3477: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3478: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3479: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3480: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3481: </dl></dd>
1.23 wiz 3482: <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.6 rillig 3483: <dd><dl>
3484: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3485: <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.88 tnn 3486: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 3487: </dl></dd>
1.23 wiz 3488: <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.6 rillig 3489: <dd><dl>
3490: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3491: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3492: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3493: </dl></dd>
3494: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3495: <dd><dl>
3496: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3497: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3498: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 3499: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3500: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 3501: </dl></dd>
1.23 wiz 3502: <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.6 rillig 3503: <dd><dl>
3504: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3505: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 3506: <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.6 rillig 3507: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3508: </dl></dd>
1.23 wiz 3509: <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.6 rillig 3510: <dd><dl>
3511: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3512: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3513: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3514: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3515: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3516: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3517: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3518: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3519: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 3520: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 3521: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3522: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3523: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3524: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3525: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3526: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3527: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3528: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3529: emulation</a></span></dt>
1.6 rillig 3530: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3531: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3532: </dl></dd>
1.6 rillig 3533: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3534: </dl></dd>
1.6 rillig 3535: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3536: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3537: <dd><dl>
1.6 rillig 3538: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3539: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3540: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 3541: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 3542: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 3543: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3544: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 3545: </dl></dd>
3546: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3547: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3548: <dd><dl>
3549: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3550: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3551: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3552: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3553: </dl></dd>
3554: </dl>
3555: </div>
3556: </div>
1.41 asau 3557: <div class="chapter">
1.1 dsieger 3558: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3559: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3560: <div class="toc">
3561: <p><b>Table of Contents</b></p>
1.94 wiz 3562: <dl class="toc">
1.6 rillig 3563: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3564: <dd><dl>
1.6 rillig 3565: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3566: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3567: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3568: </dl></dd>
1.6 rillig 3569: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3570: <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.1 dsieger 3571: </dl>
3572: </div>
3573: <p>When you find a package that is not yet in pkgsrc, you
3574: most likely have a URL from where you can download the source
3575: code. Starting with this URL, creating a package involves only a
3576: few steps.</p>
1.23 wiz 3577: <div class="procedure"><ol class="procedure" type="1">
1.79 snj 3578: <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.41 asau 3579: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3580: category in which you want to place your package. You can also create a
3581: directory of your own (maybe called <code class="filename">local</code>). In that
3582: category directory, create another directory for your package and change
3583: into it.</p></li>
1.41 asau 3584: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3585: you for a URL. Enter the URL of the distribution file (in most cases a
3586: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3587: of your package are created automatically. The distribution file is
3588: extracted automatically to fill in some details in the
3589: <code class="filename">Makefile</code> that would otherwise have to be done
3590: manually.</p></li>
1.41 asau 3591: <li class="step">
1.1 dsieger 3592: <p>Examine the extracted files to determine the dependencies of
3593: your package. Ideally, this is mentioned in some
3594: <code class="filename">README</code> file, but things may differ. For each of
3595: these dependencies, look where it exists in pkgsrc, and if there is a
3596: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3597: line to your package <code class="filename">Makefile</code> which includes that
3598: file just before the last line. If the
1.25 spz 3599: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3600: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3601: <p>If you just need binaries from a package, add a
1.1 dsieger 3602: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3603: version of the dependency and where it can be found in pkgsrc. This line
3604: should be placed in the third paragraph. If the dependency is only
3605: needed for building the package, but not when using it, use
3606: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3607: Your package may then look like this:</p>
3608: <pre class="programlisting">
3609: [...]
3610:
1.66 asau 3611: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3612: DEPENDS+= screen-[0-9]*:../../misc/screen
3613: DEPENDS+= screen>=4.0:../../misc/screen
3614:
3615: [...]
3616:
3617: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3618: .include "../../devel/glib2/buildlink3.mk"
3619: .include "../../mk/bsd.pkg.mk"
3620: </pre>
3621: </li>
1.41 asau 3622: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3623: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.10 hubertf 3624: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3625: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3626: -e</strong></span>, which outputs additional
3627: explanations.</p></li>
1.41 asau 3628: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3629: 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.1 dsieger 3630: over there, you can hopefully continue here.</p></li>
1.41 asau 3631: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3632: directory from the extracted files. Besides these files, a lot of cache
3633: files and other system information has been saved in the working
3634: directory, which may become wrong after you edited the
3635: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3636: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3637: 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.41 asau 3638: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3639: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3640: everything works.</p></li>
1.41 asau 3641: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3642: contains a list of the files that are installed by the package, is
1.10 hubertf 3643: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3644: >PLIST</strong></span> to generate a probably correct list. Check
3645: the file using your preferred text editor to see if the list of
3646: files looks plausible.</p></li>
1.41 asau 3647: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3648: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3649: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3650: has been registered in the database of installed files, but with an
1.10 hubertf 3651: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3652: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3653: registered with the list of files from
3654: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3655: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3656: package from the set of installed files.</p></li>
3657: </ol></div>
1.41 asau 3658: <div class="sect1">
1.1 dsieger 3659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3660: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3661: <div class="sect2">
1.1 dsieger 3662: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3663: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3664: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3665: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3666: </div>
1.41 asau 3667: <div class="sect2">
1.1 dsieger 3668: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 3669: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3670: <p>KDE3 applications should always include
1.1 dsieger 3671: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 asau 3672: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3673: </div>
1.41 asau 3674: <div class="sect2">
1.17 imil 3675: <div class="titlepage"><div><div><h3 class="title">
3676: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3677: <p>Python modules and programs packages are easily created using a
3678: set of predefined variables.</p>
3679: <p>
1.63 wiz 3680: If some Python versions are not supported by the software, set the
3681: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3682: that are not supported, e.g.
1.17 imil 3683: </p>
3684: <pre class="programlisting">
1.93 sevan 3685: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3686: </pre>
3687: <p>
3688: If the packaged software is a Python module, include
1.23 wiz 3689: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.17 imil 3690: In this case, the package directory should be called
1.23 wiz 3691: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3692: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3693: </p>
3694: <pre class="programlisting">
3695: DISTNAME= foopymodule-1.2.10
3696: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3697: </pre>
1.63 wiz 3698: <p>If it is an application, include
3699: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3700: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3701: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3702: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3703: For example:
1.17 imil 3704: </p>
3705: <pre class="programlisting">
1.35 wiz 3706: REPLACE_PYTHON= *.py
1.17 imil 3707: </pre>
1.63 wiz 3708: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3709: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3710: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3711: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3712: so pkgsrc will use this framework.
3713: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3714: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3715: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3716: to the name of the script.</p>
3717: <p>Otherwise, if the packaged software is egg-aware, you only need
3718: to include
3719: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3720: <p>Some Python modules have separate distributions for Python-2.x
3721: and Python-3.x support. In pkgsrc this is handled by the
3722: <code class="filename">versioned_dependencies.mk</code> file. Set
3723: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3724: packages that should be depended upon and include
3725: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3726: then the pkgsrc infrastructure will depend on the appropriate package
3727: version. For example:
3728: </p>
3729: <pre class="programlisting">
3730: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3731: </pre>
3732: <p>
3733: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3734: of supported packages.</p>
1.17 imil 3735: </div>
1.1 dsieger 3736: </div>
1.41 asau 3737: <div class="sect1">
1.1 dsieger 3738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3739: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3740: <div class="sect2">
1.1 dsieger 3741: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3742: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3743: <div class="sect3">
1.1 dsieger 3744: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3745: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3746: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3747: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3748: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3749: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3750: <pre class="programlisting">
3751: <code class="prompt">$</code> mkdir www/nvu
3752: <code class="prompt">$</code> cd www/nvu
3753: </pre>
3754: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3755: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3756: <pre class="programlisting">
3757: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3758: </pre>
3759: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3760: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3761: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3762: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3763: <code class="varname">COMMENT</code> fields. Then the package
3764: <code class="filename">Makefile</code> looked like that:</p>
3765: <pre class="programlisting">
3766: # $NetBSD$
3767: #
3768:
3769: DISTNAME= nvu-1.0-sources
3770: PKGNAME= nvu-1.0
3771: CATEGORIES= www
3772: MASTER_SITES= http://cvs.nvu.com/download/
3773: EXTRACT_SUFX= .tar.bz2
3774:
3775: MAINTAINER= rillig@NetBSD.org
3776: HOMEPAGE= http://cvs.nvu.com/
3777: COMMENT= Web Authoring System
3778:
3779: # url2pkg-marker (please do not remove this line.)
3780: .include "../../mk/bsd.pkg.mk"
3781: </pre>
3782: <p>Then, I quit the editor and watched pkgsrc downloading a large
3783: source archive:</p>
3784: <pre class="programlisting">
3785: url2pkg> Running "make makesum" ...
3786: => Required installed package digest>=20010302: digest-20060826 found
3787: => Fetching nvu-1.0-sources.tar.bz2
3788: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3789: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3790: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3791: url2pkg> Running "make extract" ...
3792: => Required installed package digest>=20010302: digest-20060826 found
3793: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3794: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3795: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3796: ===> Installing dependencies for nvu-1.0
3797: ===> Overriding tools for nvu-1.0
3798: ===> Extracting for nvu-1.0
3799: url2pkg> Adjusting the Makefile.
3800:
3801: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3802:
3803: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3804: </pre>
3805: </div>
1.41 asau 3806: <div class="sect3">
1.1 dsieger 3807: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3808: <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.1 dsieger 3809: <p>Now that the package has been extracted, let's see what's inside
3810: it. The package has a <code class="filename">README.txt</code>, but that only
3811: says something about mozilla, so it's probably useless for seeing what
3812: dependencies this package has. But since there is a GNU configure script
3813: in the package, let's hope that it will complain about everything it
3814: needs.</p>
3815: <pre class="programlisting">
3816: <code class="prompt">$</code> bmake
3817: => Required installed package digest>=20010302: digest-20060826 found
3818: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3819: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3820: ===> Patching for nvu-1.0
3821: ===> Creating toolchain wrappers for nvu-1.0
3822: ===> Configuring for nvu-1.0
3823: [...]
3824: configure: error: Perl 5.004 or higher is required.
3825: [...]
3826: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3827: [...]
3828: </pre>
3829: <p>That worked quite well. So I opened the package Makefile in my
3830: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3831: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3832: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3833: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3834: from scratch.</p>
3835: <pre class="programlisting">
3836: <code class="prompt">$</code> bmake clean
3837: ===> Cleaning for nvu-1.0
3838: <code class="prompt">$</code> bmake
3839: [...]
3840: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3841: GNU Make. You will not be able to build Mozilla without GNU Make.
3842: [...]
3843: </pre>
1.23 wiz 3844: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3845: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3846: <pre class="programlisting">
3847: [...]
3848: checking for GTK - version >= 1.2.0... no
3849: *** Could not run GTK test program, checking why...
3850: [...]
3851: </pre>
3852: <p>Now to the other dependencies. The first question is: Where is the
3853: GTK package hidden in pkgsrc?</p>
3854: <pre class="programlisting">
3855: <code class="prompt">$</code> echo ../../*/gtk*
3856: [many packages ...]
3857: <code class="prompt">$</code> echo ../../*/gtk
3858: ../../x11/gtk
3859: <code class="prompt">$</code> echo ../../*/gtk2
3860: ../../x11/gtk2
3861: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3862: ../../x11/gtk2/buildlink3.mk
3863: </pre>
3864: <p>The first try was definitely too broad. The second one had exactly
3865: one result, which is very good. But there is one pitfall with GNOME
3866: packages. Before GNOME 2 had been released, there were already many
3867: GNOME 1 packages in pkgsrc. To be able to continue to use these
3868: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3869: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3870: whether this was the case here, and indeed it was.</p>
3871: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3872: file, adding the dependency is very easy. I just inserted an
3873: <code class="literal">.include</code> line before the last line of the package
3874: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3875: <pre class="programlisting">
3876: [...]
3877: .include "../../x11/gtk2/buildlink3.mk"
3878: .include "../../mk/bsd.pkg.mk
3879: </pre>
1.10 hubertf 3880: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3881: was:</p>
3882: <pre class="programlisting">
3883: [...]
3884: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3885: checking for GTK - version >= 1.2.0... no
3886: *** Could not run GTK test program, checking why...
3887: *** The test program failed to compile or link. See the file config.log for the
3888: *** exact error that occured. This usually means GTK was incorrectly installed
3889: *** or that you have moved GTK since it was installed. In the latter case, you
3890: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3891: configure: error: Test for GTK failed.
3892: [...]
3893: </pre>
1.23 wiz 3894: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3895: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3896: told me that this package really wanted to have the GNOME 1 version of
3897: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3898: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3899: So I changed the <code class="literal">x11/gtk2</code> to
3900: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3901: and tried again.</p>
3902: <pre class="programlisting">
3903: [...]
1.59 jnemeth 3904: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3905: In file included from xpidl.c:42:
3906: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3907: In file included from xpidl.c:42:
3908: xpidl.h:132: error: parse error before "IDL_ns"
3909: [...]
3910: </pre>
3911: <p>The package still does not find all of its dependencies. Now the
3912: question is: Which package provides the
3913: <code class="filename">libIDL/IDL.h</code> header file?</p>
3914: <pre class="programlisting">
3915: <code class="prompt">$</code> echo ../../*/*idl*
3916: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3917: <code class="prompt">$</code> echo ../../*/*IDL*
3918: ../../net/libIDL
3919: </pre>
3920: <p>Let's take the one from the second try. So I included the
3921: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3922: again. But the error didn't change. After digging through some of the
3923: code, I concluded that the build process of the package was broken and
3924: couldn't have ever worked, but since the Mozilla source tree is quite
3925: large, I didn't want to fix it. So I added the following to the package
3926: <code class="filename">Makefile</code> and tried again:</p>
3927: <pre class="programlisting">
3928: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3929: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3930: </pre>
3931: <p>The latter line is needed because the package expects the library
3932: <code class="filename">libIDL.so</code>, but only
3933: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3934: wrapper to rewrite that on the fly.</p>
3935: <p>The next problem was related to a recent change of the FreeType
1.79 snj 3936: 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.1 dsieger 3937: which patch files were relevant for this issue and copied them to the
3938: <code class="filename">patches</code> directory. Then I retried, fixed the
3939: patches so that they applied cleanly and retried again. This time,
3940: everything worked.</p>
3941: </div>
1.41 asau 3942: <div class="sect3">
1.1 dsieger 3943: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3944: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3945: <pre class="programlisting">
3946: <code class="prompt">$</code> bmake CHECK_FILES=no install
3947: [...]
3948: <code class="prompt">$</code> bmake print-PLIST >PLIST
3949: <code class="prompt">$</code> bmake deinstall
3950: <code class="prompt">$</code> bmake install
3951: </pre>
3952: </div>
3953: </div>
3954: </div>
3955: </div>
1.41 asau 3956: <div class="chapter">
1.1 dsieger 3957: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3958: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3959: <div class="toc">
3960: <p><b>Table of Contents</b></p>
1.94 wiz 3961: <dl class="toc">
1.23 wiz 3962: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3963: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3964: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3965: <dd><dl>
3966: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3967: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3968: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3969: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3970: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3971: </dl></dd>
3972: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3973: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3974: <dd><dl>
3975: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3976: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3977: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3978: </dl></dd>
1.23 wiz 3979: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3980: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3981: </dl>
3982: </div>
3983: <p>Whenever you're preparing a package, there are a number of
3984: files involved which are described in the following
3985: sections.</p>
1.41 asau 3986: <div class="sect1">
1.1 dsieger 3987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3988: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3989: </h2></div></div></div>
3990: <p>Building, installation and creation of a binary package are all
3991: controlled by the package's <code class="filename">Makefile</code>.
3992: The <code class="filename">Makefile</code> describes various things about
3993: a package, for example from where to get it, how to configure,
3994: build, and install it.</p>
3995: <p>A package <code class="filename">Makefile</code> contains several
3996: sections that describe the package.</p>
3997: <p>In the first section there are the following variables, which
3998: should appear exactly in the order given here. The order and
3999: grouping of the variables is mostly historical and has no further
4000: meaning.</p>
1.41 asau 4001: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4002: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 4003: distribution file to be downloaded from the package's
4004: website.</p></li>
1.23 wiz 4005: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 4006: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 4007: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 4008: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
4009: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 4010: directory name together with the version number. It must match the
4011: regular expression
4012: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4013: starts with a letter or digit, and contains only letters, digits,
4014: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 4015: <li class="listitem">
1.1 dsieger 4016: <p><code class="varname">CATEGORIES</code> is a list of categories
4017: which the package fits in. You can choose any of the top-level
4018: directories of pkgsrc for it.</p>
4019: <p>Currently the following values are available for
4020: <code class="varname">CATEGORIES</code>. If more than
4021: one is used, they need to be separated by spaces:</p>
4022: <pre class="programlisting">
4023: archivers cross geography meta-pkgs security
4024: audio databases graphics misc shells
4025: benchmarks devel ham multimedia sysutils
4026: biology editors inputmethod net textproc
4027: cad emulators lang news time
4028: chat finance mail parallel wm
4029: comms fonts math pkgtools www
4030: converters games mbone print x11
4031: </pre>
4032: </li>
1.23 wiz 4033: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 4034: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4035: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4036: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 4037: <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.1 dsieger 4038: </ul></div>
4039: <p>The second section contains information about separately
4040: downloaded patches, if any.
4041: </p>
1.41 asau 4042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 4043: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 4044: Name(s) of additional files that contain distribution patches.
4045: There is no default. pkgsrc will look for them at
4046: <code class="varname">PATCH_SITES</code>.
4047: They will automatically be uncompressed before patching if
4048: the names end with <code class="filename">.gz</code> or
4049: <code class="filename">.Z</code>.</p></li>
1.23 wiz 4050: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 4051: Primary location(s) for distribution patch files (see
1.80 wiz 4052: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
4053: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
4054: 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
4055: help find the correct files to patch. It defaults to
4056: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 4057: </ul></div>
4058: <p>The third section contains the following variables.
4059: </p>
1.41 asau 4060: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4061: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 4062: address of the person who feels responsible for this package,
4063: and who is most likely to look at problems or questions regarding
1.79 snj 4064: 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.14 jmcneill 4065: Other developers may contact the <code class="varname">MAINTAINER</code>
4066: before making changes to the package, but are not required to
4067: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4068: to yourself. If you really can't maintain the package for future
4069: updates, set it to
1.10 hubertf 4070: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 4071: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 4072: of <code class="varname">MAINTAINER</code> when you do not want other
4073: developers to update or change the package without contacting
4074: you first. A package Makefile should contain one of
4075: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4076: not both. </p></li>
1.23 wiz 4077: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 4078: find more information about the package.</p></li>
1.23 wiz 4079: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 4080: description of the package (should not include the package
4081: name).</p></li>
4082: </ul></div>
4083: <p>Other variables that affect the build:
4084: </p>
1.41 asau 4085: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4086: <p><code class="varname">WRKSRC</code>: The directory where the
4087: interesting distribution files of the package are found. The
4088: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4089: works for most packages.</p>
4090: <p>If a package doesn't create a subdirectory for itself
4091: (most GNU software does, for instance), but extracts itself in
4092: the current directory, you should set
4093: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4094: <p>If a package doesn't create a subdirectory with the
4095: name of <code class="varname">DISTNAME</code> but some different name,
4096: set <code class="varname">WRKSRC</code> to point to the proper name in
4097: <code class="filename">${WRKDIR}</code>, for example
4098: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.79 snj 4099: <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.1 dsieger 4100: <p>The name of the working directory created by pkgsrc is
4101: taken from the <code class="varname">WRKDIR_BASENAME</code>
4102: variable. By default, its value is
4103: <code class="filename">work</code>. If you want to use the same
4104: pkgsrc tree for building different kinds of binary packages,
4105: you can change the variable according to your needs. Two
4106: other variables handle common cases of setting
4107: <code class="varname">WRKDIR_BASENAME</code> individually. If
4108: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 4109: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4110: the host's name is attached to the directory name. If
4111: <code class="varname">OBJMACHINE</code> is defined, the platform name
4112: is attached, which might look like
4113: <code class="filename">work.i386</code> or
4114: <code class="filename">work.sparc</code>.</p>
4115: </li></ul></div>
4116: <p>Please pay attention to the following gotchas:</p>
1.41 asau 4117: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4118: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 4119: installed in compressed form by the package. For packages using
4120: BSD-style makefiles which honor MANZ, there is
4121: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 4122: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4123: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 4124: below).</p></li>
1.23 wiz 4125: <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.1 dsieger 4126: </ul></div>
4127: </div>
1.41 asau 4128: <div class="sect1">
1.1 dsieger 4129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4130: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4131: </h2></div></div></div>
4132: <p>The <code class="filename">distinfo</code> file contains the message
4133: digest, or checksum, of each distfile needed for the package. This
4134: ensures that the distfiles retrieved from the Internet have not been
4135: corrupted during transfer or altered by a malign force to introduce
4136: a security hole. Due to recent rumor about weaknesses of digest
4137: algorithms, all distfiles are protected using both SHA1 and RMD160
4138: message digests, as well as the file size.</p>
4139: <p>The <code class="filename">distinfo</code> file also contains the
4140: checksums for all the patches found in the
1.10 hubertf 4141: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.1 dsieger 4142: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10 hubertf 4143: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 4144: command.</p>
4145: <p>Some packages have different sets of distfiles depending on
1.79 snj 4146: 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.1 dsieger 4147: <code class="filename">distinfo</code> file and care should be taken when
4148: upgrading such a package to ensure distfile information is not
4149: lost.</p>
4150: </div>
1.41 asau 4151: <div class="sect1">
1.1 dsieger 4152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4153: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4154: <p>Many packages still don't work out-of-the box on the various
4155: platforms that are supported by pkgsrc. Therefore, a number of custom
4156: patch files are needed to make the package work. These patch files are
4157: found in the <code class="filename">patches/</code> directory.</p>
4158: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4159: applied to the files in <code class="varname">WRKSRC</code> directory after
1.10 hubertf 4160: 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.24 wiz 4161: order</a>.</p>
1.41 asau 4162: <div class="sect2">
1.1 dsieger 4163: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4164: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4165: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 4166: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 4167: problems. (To force patches to apply with fuzz you can set
4168: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4169: should contain only changes for a single file, and no file should be
4170: patched by more than one patch file. This helps to keep future
4171: modifications simple.</p>
4172: <p>Each patch file is structured as follows: In the first line,
4173: there is the RCS Id of the patch itself. The second line should be
4174: empty for aesthetic reasons. After that, there should be a comment for
4175: each change that the patch does. There are a number of standard
4176: cases:</p>
1.41 asau 4177: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4178: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 4179: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 4180: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 4181: platform and other environment (for example, the compiler) that the
4182: patch is needed for.</p></li>
4183: </ul></div>
1.24 wiz 4184: <p>In all, the patch should be commented so that any
1.1 dsieger 4185: developer who knows the code of the application can make some use of
4186: the patch. Special care should be taken for the upstream developers,
4187: since we generally want that they accept our patches, so we have less
4188: work in the future.</p>
4189: </div>
1.41 asau 4190: <div class="sect2">
1.1 dsieger 4191: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4192: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4193: <p>One important thing to mention is to pay attention that no RCS
4194: IDs get stored in the patch files, as these will cause problems when
4195: later checked into the NetBSD CVS tree. Use the
1.79 snj 4196: <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.1 dsieger 4197: problems.</p>
4198: <p>For even more automation, we recommend using
1.10 hubertf 4199: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4200: whole set of patches. You just have to backup files before you
4201: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4202: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4203: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4204: you upgrade a package this way, you can easily compare the new
4205: set of patches with the previously existing one with
1.24 wiz 4206: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4207: are replaced by new files, so carefully check if you want to take all
4208: the changes.</p>
1.1 dsieger 4209: <p>When you have finished a package, remember to generate
1.10 hubertf 4210: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 4211: 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.1 dsieger 4212: <p>When adding a patch that corrects a problem in the
4213: distfile (rather than e.g. enforcing pkgsrc's view of where
4214: man pages should go), send the patch as a bug report to the
4215: maintainer. This benefits non-pkgsrc users of the package,
4216: and usually makes it possible to remove the patch in future
4217: version.</p>
1.2 rillig 4218: <p>The file names of the patch files are usually of the form
1.24 wiz 4219: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4220: Many packages still use the previous convention
4221: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4222: but new patches should be of the form containing the filename.
1.79 snj 4223: <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.24 wiz 4224: automatically.</p>
1.1 dsieger 4225: </div>
1.41 asau 4226: <div class="sect2">
1.1 dsieger 4227: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4228: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4229: <p>If you want to share patches between multiple packages
4230: in pkgsrc, e.g. because they use the same distfiles, set
4231: <code class="varname">PATCHDIR</code> to the path where the patch files
4232: can be found, e.g.:</p>
4233: <pre class="programlisting">
4234: PATCHDIR= ${.CURDIR}/../xemacs/patches
4235: </pre>
4236: <p>Patch files that are distributed by the author or other
4237: maintainers can be listed in
4238: <code class="varname">PATCHFILES</code>.</p>
4239: <p>If it is desired to store any patches that should not be
4240: committed into pkgsrc, they can be kept outside the pkgsrc
4241: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4242: directory tree there is expected to have the same
1.23 wiz 4243: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 4244: patches are expected to be stored inside these dirs (also
4245: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4246: example, if you want to keep a private patch for
4247: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4248: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4249: files in the named directory are expected to be patch files,
4250: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4251: applied</em></span>.</p>
4252: </div>
1.41 asau 4253: <div class="sect2">
1.1 dsieger 4254: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4255: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4256: <p>When fixing a portability issue in the code do not use
4257: preprocessor magic to check for the current operating system nor
4258: platform. Doing so hurts portability to other platforms because
4259: the OS-specific details are not abstracted appropriately.</p>
4260: <p>The general rule to follow is: instead of checking for the
4261: operating system the application is being built on, check for the
4262: specific <span class="emphasis"><em>features</em></span> you need. For example,
4263: instead of assuming that kqueue is available under NetBSD and
4264: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 4265: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4266: yes, this generally involves patching the
1.10 hubertf 4267: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4268: that prevents some OSes from adopting interfaces from other OSes
4269: (e.g. Linux implementing kqueue), something that the above checks
4270: cannot take into account.</p>
4271: <p>Of course, checking for features generally involves more
4272: work on the developer's side, but the resulting changes are
4273: cleaner and there are chances they will work on many other
4274: platforms. Not to mention that there are higher chances of being
4275: later integrated into the mainstream sources. Remember:
4276: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4277: <p>Some typical examples:</p>
4278: <div class="table">
1.6 rillig 4279: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4280: <div class="table-contents"><table summary="Patching examples" border="1">
4281: <colgroup>
4282: <col>
4283: <col>
4284: <col>
4285: </colgroup>
4286: <thead><tr>
4287: <th>Where</th>
4288: <th>Incorrect</th>
4289: <th>Correct</th>
4290: </tr></thead>
4291: <tbody>
4292: <tr>
4293: <td>configure script</td>
4294: <td>
4295: <pre class="programlisting">
4296: case ${target_os} in
4297: netbsd*) have_kvm=yes ;;
4298: *) have_kvm=no ;;
4299: esac
4300: </pre>
4301: </td>
4302: <td>
4303: <pre class="programlisting">
4304: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4305: </pre>
4306: </td>
4307: </tr>
4308: <tr>
4309: <td>C source file</td>
4310: <td>
4311: <pre class="programlisting">
4312: #if defined(__NetBSD__)
4313: # include <sys/event.h>
4314: #endif
4315: </pre>
4316: </td>
4317: <td>
4318: <pre class="programlisting">
4319: #if defined(HAVE_SYS_EVENT_H)
4320: # include <sys/event.h>
4321: #endif
4322: </pre>
4323: </td>
4324: </tr>
4325: <tr>
4326: <td>C source file</td>
4327: <td>
4328: <pre class="programlisting">
4329: int
4330: monitor_file(...)
4331: {
4332: #if defined(__NetBSD__)
4333: int fd = kqueue();
4334: ...
4335: #else
4336: ...
4337: #endif
4338: }
4339: </pre>
4340: </td>
4341: <td>
4342: <pre class="programlisting">
4343: int
4344: monitor_file(...)
4345: {
4346: #if defined(HAVE_KQUEUE)
4347: int fd = kqueue();
4348: ...
4349: #else
4350: ...
4351: #endif
4352: }
4353: </pre>
4354: </td>
4355: </tr>
4356: </tbody>
4357: </table></div>
4358: </div>
4359: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 4360: 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
4361: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 4362: 2</a>). It summarizes multiple details on how to make
4363: software easier to package; all the suggestions in it were
4364: collected from our experience in pkgsrc work, so they are possibly
4365: helpful when creating patches too.</p>
4366: </div>
1.41 asau 4367: <div class="sect2">
1.1 dsieger 4368: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4369: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4370: <p>Always, always, <span class="strong"><strong>always</strong></span>
4371: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4372: improvements you do to a package to the mainstream developers.
4373: This is the only way to get their attention on portability issues
4374: and to ensure that future versions can be built out-of-the box on
4375: NetBSD. Furthermore, any user that gets newer distfiles will get
4376: the fixes straight from the packaged code.</p>
4377: <p>This generally involves cleaning up the patches
4378: (because sometimes the patches that are
1.40 wiz 4379: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 4380: appropriate trackers for the projects and working with the
4381: mainstream authors to accept your changes. It is
4382: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4383: the packages in pkgsrc are kept simple and thus further changes
4384: can be done without much hassle.</p>
1.24 wiz 4385: <p>When you have done this, please add a URL to the upstream
4386: bug report to the patch comment.</p>
1.1 dsieger 4387: <p>Support the idea of free software!</p>
4388: </div>
4389: </div>
1.41 asau 4390: <div class="sect1">
1.1 dsieger 4391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4392: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 4393: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4394: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4395: <dd><p>A multi-line description of the piece of software. This should include
4396: any credits where they are due. Please bear in mind that others do not
4397: share your sense of humour (or spelling idiosyncrasies), and that others
4398: will read everything that you write here.</p></dd>
4399: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4400: <dd><p>This file governs the files that are installed on your
4401: system: all the binaries, manual pages, etc. There are other
4402: directives which may be entered in this file, to control the
4403: creation and deletion of directories, and the location of
1.10 hubertf 4404: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 4405: information.</p></dd>
4406: </dl></div>
4407: </div>
1.41 asau 4408: <div class="sect1">
1.1 dsieger 4409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4410: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 4411: <div class="sect2">
1.1 dsieger 4412: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4413: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4414: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4415: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4416: <dd>
1.79 snj 4417: <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.1 dsieger 4418: First time after package extraction and before files are
4419: moved in place, the second time after the files to install
4420: are moved in place. This can be used to do any custom
4421: procedures not possible with @exec commands in
1.79 snj 4422: <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
4423: <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.28 wiz 4424: Please note that you can modify variables in it easily by using
4425: <code class="varname">FILES_SUBST</code> in the package's
4426: <code class="filename">Makefile</code>:</p>
4427: <pre class="programlisting">
4428: FILES_SUBST+= SOMEVAR="somevalue"
4429: </pre>
4430: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4431: <code class="filename">INSTALL</code>. By default, substitution is
4432: performed for <code class="varname">PREFIX</code>,
4433: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4434: <code class="varname">VARBASE</code>, and a few others, type
4435: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4436: complete list.</p>
4437: </dd>
1.1 dsieger 4438: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4439: <dd><p>This script is executed before and after any files are removed. It is
4440: this script's responsibility to clean up any additional messy details
4441: around the package's installation, since all pkg_delete knows is how to
4442: delete the files created in the original distribution.
1.79 snj 4443: 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>
4444: 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.28 wiz 4445: The same methods to replace variables can be used as for
4446: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4447: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4448: <dd>
4449: <p>This file is displayed after installation of the package.
4450: Useful for things like legal notices on almost-free
4451: software and hints for updating config files after
4452: installing modules for apache, PHP etc.
4453: Please note that you can modify variables in it easily by using
4454: <code class="varname">MESSAGE_SUBST</code> in the package's
4455: <code class="filename">Makefile</code>:</p>
4456: <pre class="programlisting">
4457: MESSAGE_SUBST+= SOMEVAR="somevalue"
4458: </pre>
1.23 wiz 4459: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4460: <code class="filename">MESSAGE</code>. By default, substitution is
4461: performed for <code class="varname">PKGNAME</code>,
4462: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4463: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4464: <code class="varname">X11BASE</code>,
4465: <code class="varname">PKG_SYSCONFDIR</code>,
4466: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4467: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4468: <p>You can display a different or additional files by
4469: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4470: default is <code class="filename">MESSAGE</code>, if the file
4471: exists.</p>
4472: </dd>
4473: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 4474: <dd>
4475: <p>This file is used by the alternatives framework.
4476: It creates, configures, and destroys generic wrappers used to
4477: run programs with similar interfaces.
4478: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4479: for more information.</p>
4480: <p>Each line of the file contains two filenames, first
4481: the wrapper and then the alternative provided by the package.
4482: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4483: </dd>
1.1 dsieger 4484: </dl></div>
4485: </div>
1.41 asau 4486: <div class="sect2">
1.1 dsieger 4487: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4488: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4489: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4490: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4491: <dd><p>This file contains arbitrary things that could
4492: also go into a <code class="filename">Makefile</code>, but its purpose is
4493: to be used by more than one package. This file should only be
4494: used when the packages that will use the file are known in
4495: advance. For other purposes it is often better to write a
4496: <code class="filename">*.mk</code> file and give it a good name that
4497: describes what it does.</p></dd>
4498: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4499: <dd><p>This file contains the dependency information
1.10 hubertf 4500: 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.1 dsieger 4501: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4502: <dd><p>This file contains workarounds for compiler bugs
4503: and similar things. It is included automatically by the pkgsrc
4504: infrastructure, so you don't need an extra
4505: <code class="literal">.include</code> line for
4506: it.</p></dd>
4507: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4508: <dd><p>This file contains the code for the
1.10 hubertf 4509: 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.1 dsieger 4510: selected by the user. If a package has only one or two options,
4511: it is equally acceptable to put the code directly into the
4512: <code class="filename">Makefile</code>.</p></dd>
4513: </dl></div>
4514: </div>
1.41 asau 4515: <div class="sect2">
1.1 dsieger 4516: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4517: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4518: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4519: <dt><span class="term"><code class="filename">README*</code></span></dt>
4520: <dd><p>These files do not take place in the creation of
4521: a package and thus are purely informative to the package
4522: developer.</p></dd>
4523: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4524: <dd><p>This file contains things that need to be done
4525: to make the package even
4526: better.</p></dd>
4527: </dl></div>
4528: </div>
4529: </div>
1.41 asau 4530: <div class="sect1">
1.1 dsieger 4531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4532: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4533: </h2></div></div></div>
1.10 hubertf 4534: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4535: unpacked into the directory denoted by
4536: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4537: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4538: directory is also used to keep various timestamp files.
4539: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4540: The default is <code class="filename">${.CURDIR}/work</code>
4541: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4542: if <code class="varname">OBJMACHINE</code> is set.</p>
4543: </div>
1.41 asau 4544: <div class="sect1">
1.1 dsieger 4545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4546: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4547: </h2></div></div></div>
4548: <p>If you have any files that you wish to be placed in the package prior
4549: to configuration or building, you could place these files here and use
1.10 hubertf 4550: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4551: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4552: this. Alternatively, you could simply diff the file against
4553: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4554: the creation of this file.</p>
4555: <p>If you want to share files in this way with other
4556: packages, set the <code class="varname">FILESDIR</code> variable to point
4557: to the other package's <code class="filename">files</code> directory,
4558: e.g.:</p>
4559: <pre class="programlisting">
4560: FILESDIR=${.CURDIR}/../xemacs/files
4561: </pre>
4562: </div>
4563: </div>
1.41 asau 4564: <div class="chapter">
1.1 dsieger 4565: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4566: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4567: <div class="toc">
4568: <p><b>Table of Contents</b></p>
1.94 wiz 4569: <dl class="toc">
1.6 rillig 4570: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4571: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4572: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4573: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4574: <dd><dl>
4575: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4576: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4577: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4578: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4579: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.1 dsieger 4580: </dl></dd>
4581: </dl>
4582: </div>
4583: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4584: each of which forms a well-defined part of the pkgsrc system. Using
1.79 snj 4585: 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.1 dsieger 4586: like pkgsrc requires some discipline to keep the code correct and
4587: understandable.</p>
4588: <p>The basic ingredients for <code class="filename">Makefile</code>
4589: programming are variables (which are actually macros) and shell
4590: commands. Among these shell commands may even be more complex ones
1.79 snj 4591: 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.1 dsieger 4592: as intended it is necessary to quote all variables correctly when they
4593: are used.</p>
4594: <p>This chapter describes some patterns, that appear quite often in
4595: <code class="filename">Makefile</code>s, including the pitfalls that come along
4596: with them.</p>
1.41 asau 4597: <div class="sect1">
1.1 dsieger 4598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4599: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4600: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4601: <p>When you are creating a file as a
4602: target of a rule, always write the data to a temporary file first
4603: and finally rename that file. Otherwise there might occur an error
4604: in the middle of generating the file, and when the user runs
1.79 snj 4605: <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.1 dsieger 4606: regenerated properly. Example:</p>
4607: <pre class="programlisting">
4608: wrong:
4609: @echo "line 1" > ${.TARGET}
4610: @echo "line 2" >> ${.TARGET}
4611: @false
4612:
4613: correct:
4614: @echo "line 1" > ${.TARGET}.tmp
4615: @echo "line 2" >> ${.TARGET}.tmp
4616: @false
4617: @mv ${.TARGET}.tmp ${.TARGET}
4618: </pre>
1.10 hubertf 4619: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4620: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4621: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4622: correct</strong></span> gives an error message twice, as expected.</p>
1.79 snj 4623: <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.1 dsieger 4624: <code class="literal">${.TARGET}</code> in case of error, but this only
4625: happens when it is interrupted, for example by pressing
4626: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.79 snj 4627: 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.1 dsieger 4628: </li></ul></div>
4629: </div>
1.41 asau 4630: <div class="sect1">
1.1 dsieger 4631: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4632: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4633: <p><code class="filename">Makefile</code> variables contain strings that
4634: can be processed using the five operators ``='', ``+='', ``?='',
1.79 snj 4635: ``:='', 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.1 dsieger 4636: page.</p>
4637: <p>When a variable's value is parsed from a
4638: <code class="filename">Makefile</code>, the hash character ``#'' and the
4639: backslash character ``\'' are handled specially. If a backslash is
4640: followed by a newline, any whitespace immediately in front of the
4641: backslash, the backslash, the newline, and any whitespace
4642: immediately behind the newline are replaced with a single space. A
4643: backslash character and an immediately following hash character are
4644: replaced with a single hash character. Otherwise, the backslash is
4645: passed as is. In a variable assignment, any hash character that is
4646: not preceded by a backslash starts a comment that continues upto the
4647: end of the logical line.</p>
4648: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4649: the only way to create a variable consisting of a single backslash
4650: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4651: <p>So far for defining variables. The other thing you can do with
4652: variables is evaluating them. A variable is evaluated when it is
4653: part of the right side of the ``:='' or the ``!='' operator, or
4654: directly before executing a shell command which the variable is part
1.79 snj 4655: 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.1 dsieger 4656: is, variables are not evaluated until there's no other way. The
4657: ``modifiers'' mentioned in the man page also evaluate the
4658: variable.</p>
4659: <p>Some of the modifiers split the string into words and then
4660: operate on the words, others operate on the string as a whole. When
4661: a string is split into words, it is split as you would expect
1.79 snj 4662: 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.14 jmcneill 4663: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.1 dsieger 4664: loop does not follow the shell quoting rules but splits at sequences
4665: of whitespace.</p>
4666: <p>There are several types of variables that should be handled
4667: differently. Strings and two types of lists.</p>
1.41 asau 4668: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4669: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4670: characters. Nevertheless, you should restrict yourself to only
4671: using printable characters. Examples are
4672: <code class="varname">PREFIX</code> and
4673: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4674: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4675: are never exported to any shell command. Their elements are
4676: separated by whitespace. Therefore, the elements themselves cannot
4677: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4678: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4679: Examples are <code class="varname">DEPENDS</code> and
4680: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4681: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4682: may be exported to a shell command. Their elements can contain any
4683: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4684: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4685: <code class="varname">DISTFILES</code> and
4686: <code class="varname">MASTER_SITES</code>.</p></li>
4687: </ul></div>
1.41 asau 4688: <div class="sect2">
1.1 dsieger 4689: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4690: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4691: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4692: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4693: are reserved for use by the pkgsrc infrastructure. They shall
4694: not be used by package
4695: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4696: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4697: lowercase variable names for the iteration
4698: variables.</p></li>
1.23 wiz 4699: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4700: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4701: <code class="varname">DISTFILES</code>.</p></li>
4702: </ul></div>
4703: </div>
4704: </div>
1.41 asau 4705: <div class="sect1">
1.1 dsieger 4706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4707: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 4708: <p>This section presents you with some code snippets you should
4709: use in your own code. If you don't find anything appropriate here,
4710: you should test your code and add it here.</p>
1.41 asau 4711: <div class="sect2">
1.1 dsieger 4712: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4713: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 4714: <pre class="programlisting">
4715: STRING= foo * bar `date`
4716: INT_LIST= # empty
4717: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4718: EXT_LIST= # empty
4719: ANOTHER_EXT_LIST= a=b c=d
4720:
4721: INT_LIST+= ${STRING} # 1
4722: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4723: EXT_LIST+= ${STRING:Q} # 3
4724: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
4725: </pre>
4726: <p>When you add a string to an external list (example 3), it
4727: must be quoted. In all other cases, you must not add a quoting
4728: level. You must not merge internal and external lists, unless you
4729: are sure that all entries are correctly interpreted in both
4730: lists.</p>
4731: </div>
1.41 asau 4732: <div class="sect2">
1.1 dsieger 4733: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4734: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.1 dsieger 4735: <pre class="programlisting">
4736: EXT_LIST= # empty
4737: .for i in ${INT_LIST}
4738: EXT_LIST+= ${i:Q}""
4739: .endfor
4740: </pre>
4741: <p>This code converts the internal list
4742: <code class="varname">INT_LIST</code> into the external list
4743: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4744: are unquoted they must be quoted here. The reason for appending
4745: <code class="varname">""</code> is explained below.</p>
4746: </div>
1.41 asau 4747: <div class="sect2">
1.1 dsieger 4748: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4749: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 4750: <p>Sometimes you may want to print an arbitrary string. There
4751: are many ways to get it wrong and only few that can handle every
4752: nastiness.</p>
4753: <pre class="programlisting">
4754: STRING= foo bar < > * `date` $$HOME ' "
4755: EXT_LIST= string=${STRING:Q} x=second\ item
4756:
4757: all:
4758: echo ${STRING} # 1
4759: echo "${STRING}" # 2
4760: echo "${STRING:Q}" # 3
4761: echo ${STRING:Q} # 4
4762: echo x${STRING:Q} | sed 1s,.,, # 5
4763: printf "%s\\n" ${STRING:Q}"" # 6
4764: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
4765: </pre>
4766: <p>Example 1 leads to a syntax error in the shell, as the
4767: characters are just copied.</p>
4768: <p>Example 2 leads to a syntax error too, and if you leave out
4769: the last " character from <code class="varname">${STRING}</code>,
1.79 snj 4770: <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.1 dsieger 4771: variable would be evaluated, too.</p>
4772: <p>Example 3 outputs each space character preceded by a
4773: backslash (or not), depending on the implementation of the
1.79 snj 4774: <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.1 dsieger 4775: <p>Example 4 handles correctly every string that does not start
4776: with a dash. In that case, the result depends on the
1.79 snj 4777: 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.1 dsieger 4778: guarantee that your input does not start with a dash, this form is
4779: appropriate.</p>
4780: <p>Example 5 handles even the case of a leading dash
4781: correctly.</p>
4782: <p>Example 6 also works with every string and is the
4783: light-weight solution, since it does not involve a pipe, which has
4784: its own problems.</p>
4785: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4786: because the quoting has already been done when adding elements to
4787: the list.</p>
4788: <p>As internal lists shall not be passed to the shell, there is
4789: no example for it.</p>
4790: </div>
1.41 asau 4791: <div class="sect2">
1.1 dsieger 4792: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4793: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 4794: <p>There are many possible sources of wrongly quoted variables.
4795: This section lists some of the commonly known ones.</p>
1.41 asau 4796: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4797: <li class="listitem">
1.1 dsieger 4798: <p>Whenever you use the value of a list, think
4799: about what happens to leading or trailing whitespace. If the
4800: list is a well-formed shell expression, you can apply the
4801: <code class="varname">:M*</code> modifier to strip leading and trailing
4802: whitespace from each word. The <code class="varname">:M</code> operator
4803: first splits its argument according to the rules of the shell,
4804: and then creates a new list consisting of all words that match
4805: the shell glob expression <code class="varname">*</code>, that is: all.
4806: One class of situations where this is needed is when adding a
4807: variable like <code class="varname">CPPFLAGS</code> to
4808: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4809: invokes other configure scripts, it strips the leading and
4810: trailing whitespace from the variable and then passes it to the
4811: other configure scripts. But these configure scripts expect the
4812: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4813: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4814: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4815: here is how we do it:</p>
4816: <pre class="programlisting">
4817: CPPFLAGS= # empty
4818: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4819: CPPFLAGS+= ${MY_CPPFLAGS}
4820:
4821: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4822:
4823: all:
4824: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4825: echo x${CONFIGURE_ARGS}x # properly trimmed
4826: </pre>
4827: </li>
1.23 wiz 4828: <li class="listitem"><p>The example above contains one bug: The
1.1 dsieger 4829: <code class="varname">${PREFIX}</code> is a properly quoted shell
4830: expression, but there is the C compiler after it, which also
4831: expects a properly quoted string (this time in C syntax). The
4832: version above is therefore only correct if
4833: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4834: or double quotes. If you want to allow these, you have to add
4835: another layer of quoting to each variable that is used as a C
4836: string literal. You cannot use the <code class="varname">:Q</code>
4837: operator for it, as this operator only works for the
4838: shell.</p></li>
1.23 wiz 4839: <li class="listitem">
1.1 dsieger 4840: <p>Whenever a variable can be empty, the
4841: <code class="varname">:Q</code> operator can have surprising results. Here
4842: are two completely different cases which can be solved with the
4843: same trick.</p>
4844: <pre class="programlisting">
4845: EMPTY= # empty
4846: empty_test:
4847: for i in a ${EMPTY:Q} c; do \
4848: echo "$$i"; \
4849: done
4850:
4851: for_test:
4852: .for i in a:\ a:\test.txt
4853: echo ${i:Q}
4854: echo "foo"
4855: .endfor
4856: </pre>
4857: <p>The first example will only print two of the three lines
4858: we might have expected. This is because
4859: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4860: the shell cannot see. The workaround is to write
4861: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4862: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4863: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4864: <p>The second example will only print three lines instead of
4865: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4866: This is because the backslash of the value
4867: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.79 snj 4868: <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
4869: <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.1 dsieger 4870: <code class="varname">${i:Q}""</code>.</p>
4871: </li>
4872: </ul></div>
4873: </div>
1.41 asau 4874: <div class="sect2">
1.1 dsieger 4875: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4876: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 4877: <p>The pkgsrc bmake program does not handle the following
4878: assignment correctly. In case <code class="varname">_othervar_</code>
4879: contains a ``-'' character, one of the closing braces is included
4880: in <code class="varname">${VAR}</code> after this code executes.</p>
4881: <pre class="programlisting">
4882: VAR:= ${VAR:N${_othervar_:C/-//}}
4883: </pre>
4884: <p>For a more complex code snippet and a workaround, see the
1.79 snj 4885: 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.1 dsieger 4886: <code class="varname">bug1</code>.</p>
4887: </div>
4888: </div>
4889: </div>
1.41 asau 4890: <div class="chapter">
1.1 dsieger 4891: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4892: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4893: <div class="toc">
4894: <p><b>Table of Contents</b></p>
1.94 wiz 4895: <dl class="toc">
1.6 rillig 4896: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4897: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4898: <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.6 rillig 4899: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4900: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4901: <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.6 rillig 4902: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4903: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4904: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4905: </dl>
4906: </div>
4907: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4908: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4909: the package (relative to the <code class="filename">${PREFIX}</code>
4910: directory it's been installed in) plus some additional statements
1.79 snj 4911: - 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.1 dsieger 4912: This chapter addresses some issues that need attention when
4913: dealing with the <code class="filename">PLIST</code> file (or files, see
4914: below!).</p>
1.41 asau 4915: <div class="sect1">
1.1 dsieger 4916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4917: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4918: <p>Be sure to add a RCS ID line as the first thing in any
4919: <code class="filename">PLIST</code> file you write:</p>
4920: <pre class="programlisting">
4921: @comment $NetBSD$
4922: </pre>
4923: </div>
1.41 asau 4924: <div class="sect1">
1.1 dsieger 4925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4926: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4927: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4928: to output a PLIST that matches any new files since the package
1.10 hubertf 4929: 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.1 dsieger 4930: more information on this target.</p>
4931: </div>
1.41 asau 4932: <div class="sect1">
1.1 dsieger 4933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4934: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4935: </h2></div></div></div>
4936: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4937: of AWK patterns and actions that are used to filter the output of
4938: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4939: scripting you like to it, but be careful with quoting.</p>
4940: <p>For example, to get all files inside the
4941: <code class="filename">libdata/foo</code> directory removed from the
4942: resulting PLIST:</p>
4943: <pre class="programlisting">
4944: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
4945: </pre>
4946: </div>
1.41 asau 4947: <div class="sect1">
1.1 dsieger 4948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4949: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4950: <p>A number of variables are substituted automatically in
4951: PLISTs when a package is installed on a system. This includes the
4952: following variables:</p>
1.41 asau 4953: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4954: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4955: <dd>
4956: <p>Some packages like emacs and perl embed information
4957: about which architecture they were built on into the
4958: pathnames where they install their files. To handle this
4959: case, PLIST will be preprocessed before actually used, and
4960: the symbol
1.23 wiz 4961: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4962: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4963: same is done if the string
4964: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4965: PLIST somewhere - use this on packages that have GNU
4966: autoconf-created configure scripts.</p>
1.41 asau 4967: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4968: <h3 class="title">Legacy note</h3>
4969: <p>There used to be a symbol
1.23 wiz 4970: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4971: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4972: -m</strong></span>, but that's no longer supported and has
4973: been removed.</p>
4974: </div>
4975: </dd>
4976: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4977: <dd>
4978: <p>Some packages want to embed the OS name and version
4979: into some paths. To do this, use these variables in the
4980: <code class="filename">PLIST</code>:
4981: </p>
1.41 asau 4982: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4983: <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>
4984: <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>
4985: <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.1 dsieger 4986: </ul></div>
4987: </dd>
4988: </dl></div>
1.88 tnn 4989: <p>For a list of values which are replaced by
4990: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4991: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4992: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4993: <p>If you want to change other variables not listed above, you
4994: can add variables and their expansions to this variable in the
1.10 hubertf 4995: 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.1 dsieger 4996: <pre class="programlisting">
4997: PLIST_SUBST+= SOMEVAR="somevalue"
4998: </pre>
1.23 wiz 4999: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 5000: in the <code class="filename">PLIST</code> with
1.23 wiz 5001: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 5002: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
5003: the common case of conditionally including some
5004: <code class="filename">PLIST</code> entries. It can be done by adding
5005: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
5006: setting the corresponding <code class="varname">PLIST.foo</code> variable
5007: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 5008: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 5009: in the <code class="filename">PLIST</code> with either
1.23 wiz 5010: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5011: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 5012: For example, in <code class="filename">Makefile</code>:</p>
5013: <pre class="programlisting">
5014: PLIST_VARS+= foo
5015: .if <em class="replaceable"><code>condition</code></em>
5016: PLIST.foo= yes
5017: .else
5018: </pre>
5019: <p>And then in <code class="filename">PLIST</code>:</p>
5020: <pre class="programlisting">
5021: @comment $NetBSD$
5022: bin/bar
5023: man/man1/bar.1
5024: ${PLIST.foo}bin/foo
5025: ${PLIST.foo}man/man1/foo.1
5026: ${PLIST.foo}share/bar/foo.data
5027: </pre>
1.1 dsieger 5028: </div>
1.41 asau 5029: <div class="sect1">
1.1 dsieger 5030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5031: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5032: <p>Man pages should be installed in compressed form if
5033: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5034: and uncompressed otherwise. To handle this in the
1.23 wiz 5035: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 5036: appended/removed automatically for man pages according to
5037: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5038: or not, see above for details. This modification of the
5039: <code class="filename">PLIST</code> file is done on a copy of it, not
5040: <code class="filename">PLIST</code> itself.</p>
5041: </div>
1.41 asau 5042: <div class="sect1">
1.1 dsieger 5043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5044: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5045: </h2></div></div></div>
5046: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5047: in generating the binary package, set the variable
5048: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.79 snj 5049: 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.1 dsieger 5050: important. The default for <code class="varname">PLIST_SRC</code> is
5051: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5052: </div>
1.41 asau 5053: <div class="sect1">
1.1 dsieger 5054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5055: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5056: <p>Some packages decide to install a different set of files based on
5057: the operating system being used. These differences can be
5058: automatically handled by using the following files:</p>
1.41 asau 5059: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5060: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5061: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5062: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5063: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5064: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 5065: </ul></div>
5066: </div>
1.41 asau 5067: <div class="sect1">
1.1 dsieger 5068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 5069: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
5070: <p>Some packages decide to generate hard-to-guess file names
5071: during installation that are hard to wire down.</p>
5072: <p>In such cases, you can set the
5073: <code class="varname">GENERATE_PLIST</code> variable to shell code
5074: terminated (with a semicolon) that will output PLIST entries which
5075: will be appended to the PLIST</p>
5076: <p>You can find one example in editors/xemacs:</p>
5077: <pre class="programlisting">
5078: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
5079: </pre>
5080: <p>which will append something like
5081: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
5082: <code class="filename">PLIST</code>.
5083: </p>
5084: </div>
5085: <div class="sect1">
5086: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5087: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 5088: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 5089: multiple (and unrelated) packages install files. These
1.22 jakllsch 5090: directories were problematic because you had to add special
5091: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 5092: centralized package handle them.</p>
1.22 jakllsch 5093: <p>In pkgsrc, it is now easy: Each package should create
5094: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5095: will remove any directories left empty after uninstalling a
5096: package.</p>
5097: <p>If a package needs an empty directory to work, create
5098: the directory during installation as usual, and also add an
5099: entry to the PLIST:
5100: </p>
1.1 dsieger 5101: <pre class="programlisting">
1.22 jakllsch 5102: @pkgdir path/to/empty/directory
1.1 dsieger 5103: </pre>
1.22 jakllsch 5104: <p>
1.86 wiz 5105: or take a look at <code class="varname">MAKE_DIRS</code> and
5106: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 5107: </p>
1.1 dsieger 5108: </div>
5109: </div>
1.41 asau 5110: <div class="chapter">
1.1 dsieger 5111: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5112: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5113: <div class="toc">
5114: <p><b>Table of Contents</b></p>
1.94 wiz 5115: <dl class="toc">
1.6 rillig 5116: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 5117: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5118: <dd><dl>
1.6 rillig 5119: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 5120: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5121: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5122: and
5123: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5124: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5125: </dl></dd>
1.23 wiz 5126: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1 dsieger 5127: <dd><dl>
1.23 wiz 5128: <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.6 rillig 5129: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1 dsieger 5130: </dl></dd>
5131: </dl>
5132: </div>
5133: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5134: are seen by a package's configure and build processes. This is implemented
5135: in a two step process:</p>
1.23 wiz 5136: <div class="orderedlist"><ol class="orderedlist" type="1">
5137: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 5138: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5139: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 5140: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 5141: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5142: <code class="option">-L${LOCALBASE}/lib</code> into references to
5143: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5144: native compiler on some operating systems look like GCC, so that
5145: packages that expect GCC won't require modifications to build with
5146: those native compilers.</p></li>
5147: </ol></div>
5148: <p>This normalizes the environment in which a package is built so that the
5149: package may be built consistently despite what other software may be
5150: installed. Please note that the normal system header and library paths,
5151: e.g. <code class="filename">/usr/include</code>,
5152: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5153: designed to insulate the package build from non-system-supplied
5154: software.</p>
1.41 asau 5155: <div class="sect1">
1.1 dsieger 5156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5157: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5158: <p>The process of converting packages to use the buildlink3
1.23 wiz 5159: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 5160: The things to keep in mind are:</p>
1.23 wiz 5161: <div class="orderedlist"><ol class="orderedlist" type="1">
5162: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 5163: instead of the actual toolchain. Some packages are tricky,
5164: and the only way to know for sure is the check
5165: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5166: wrappers are being invoked.</p></li>
1.23 wiz 5167: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 5168: the package Makefile, e.g. Java VMs, standalone shells,
5169: etc., because the code to symlink files into
5170: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 5171: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 5172: </p></li>
1.23 wiz 5173: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 5174: <code class="filename">buildlink3.mk</code> files that you list in a
5175: package's Makefile are added as dependencies for that package.
5176: </p></li>
5177: </ol></div>
5178: <p>If a dependency on a particular package is required for its libraries and
5179: headers, then we replace:</p>
5180: <pre class="programlisting">
5181: DEPENDS+= foo>=1.1.0:../../category/foo
5182: </pre>
5183: <p>with</p>
5184: <pre class="programlisting">
5185: .include "../../category/foo/buildlink3.mk"
5186: </pre>
5187: <p>The buildlink3.mk files usually define the required dependencies.
5188: If you need a newer version of the dependency when using buildlink3.mk
5189: files, then you can define it in your Makefile; for example:</p>
5190: <pre class="programlisting">
5191: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5192: .include "../../category/foo/buildlink3.mk"
5193: </pre>
5194: <p>There are several <code class="filename">buildlink3.mk</code>
5195: files in <code class="filename">pkgsrc/mk</code>
5196: that handle special package issues:</p>
1.41 asau 5197: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5198: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 5199: the native or a pkgsrc Berkeley DB implementation based on
5200: the values of <code class="varname">BDB_ACCEPTED</code> and
5201: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 5202: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 5203: comes with neither Curses nor NCurses, this will take care
1.79 snj 5204: 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.23 wiz 5205: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 5206: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5207: adding a dependency on Heimdal or MIT-krb5 for packages that
5208: require a Kerberos 5 implementation.</p></li>
1.23 wiz 5209: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 5210: system-provided Motif installation or adds a dependency on
1.79 snj 5211: <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.23 wiz 5212: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 5213: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5214: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 5215: which Motif version will be used.</p></li>
1.55 ryoon 5216: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 5217: system-provided GNU readline or editline (libedit) installation,
1.79 snj 5218: 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>,
5219: <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.55 ryoon 5220: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5221: If your package really needs GNU readline library, its Makefile
5222: should include <code class="filename">devel/readline/buildlink3.mk</code>
5223: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 5224: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 5225: variables that may be used by packages that use the
5226: Open Sound System (OSS) API.</p></li>
1.23 wiz 5227: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 5228: any of the Postgres versions in the variable
5229: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5230: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 5231: the file for more information.</p></li>
1.23 wiz 5232: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 5233: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.79 snj 5234: 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.23 wiz 5235: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 5236: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5237: library.</p></li>
5238: </ul></div>
5239: <p>The comments in those <code class="filename">buildlink3.mk</code>
5240: files provide a more complete
5241: description of how to use them properly.</p>
5242: </div>
1.41 asau 5243: <div class="sect1">
1.1 dsieger 5244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5245: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5246: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5247: included by Makefiles to indicate the need to compile and link
5248: against header files and libraries provided by the package. A
5249: <code class="filename">buildlink3.mk</code> file should always provide
5250: enough information to add the correct type of dependency
5251: relationship and include any other
5252: <code class="filename">buildlink3.mk</code> files that it needs to find
5253: headers and libraries that it needs in turn.</p>
5254: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.79 snj 5255: 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.1 dsieger 5256: package is highly recommended. For most packages, the following
5257: command will generate a good starting point for
5258: <code class="filename">buildlink3.mk</code> files:</p>
5259: <pre class="screen">
5260: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5261: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5262: </pre>
1.41 asau 5263: <div class="sect2">
1.1 dsieger 5264: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5265: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5266: <p>The following real-life example
5267: <code class="filename">buildlink3.mk</code> is taken
5268: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5269: <pre class="programlisting">
1.18 snj 5270: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5271:
1.18 snj 5272: BUILDLINK_TREE+= tiff
1.1 dsieger 5273:
1.18 snj 5274: .if !defined(TIFF_BUILDLINK3_MK)
5275: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5276:
1.18 snj 5277: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5278: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5279: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5280:
5281: .include "../../devel/zlib/buildlink3.mk"
5282: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 5283: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5284:
1.18 snj 5285: BUILDLINK_TREE+= -tiff
1.1 dsieger 5286: </pre>
5287: <p>The header and footer manipulate
1.18 snj 5288: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 5289: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 5290: the dependency tree.</p>
5291: <p>The main section is protected from multiple inclusion
1.1 dsieger 5292: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5293: added. Several important variables are set in the section:</p>
1.41 asau 5294: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5295: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5296: is the actual dependency recorded in the installed
5297: package; this should always be set using
1.10 hubertf 5298: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5299: we're appending to any pre-existing list of values. This
5300: variable should be set to the first version of the
1.26 wiz 5301: package that had an backwards-incompatible API change.
1.1 dsieger 5302: </p></li>
1.23 wiz 5303: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5304: is the location of the <em class="replaceable"><code>pkg</code></em>
5305: pkgsrc directory.</p></li>
1.23 wiz 5306: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5307: (not shown above) controls whether we use
5308: <code class="varname">BUILD_DEPENDS</code> or
5309: <code class="varname">DEPENDS</code> to add the dependency on
5310: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5311: selected by setting
5312: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5313: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 5314: used.</p></li>
1.23 wiz 5315: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5316: and
5317: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5318: (not shown above) are lists of subdirectories of
5319: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5320: to add to the header and library search paths. These
1.23 wiz 5321: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 5322: respectively.</p></li>
1.23 wiz 5323: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5324: (not shown above) is the list of preprocessor flags to add
5325: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 5326: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 5327: should be avoided and instead be handled using
5328: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5329: above.</p></li>
5330: </ul></div>
5331: <p>The following variables are all optionally defined within
5332: this second section (protected against multiple inclusion) and
5333: control which package files are symlinked into
5334: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5335: transformed during the symlinking:</p>
1.41 asau 5336: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5337: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5338: (not shown above) is a shell glob pattern relative to
5339: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5340: to be symlinked into
5341: <code class="filename">${BUILDLINK_DIR}</code>,
5342: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 5343: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5344: (not shown above) is a shell pipeline that
5345: outputs to stdout a list of files relative to
5346: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5347: The resulting files are to be symlinked
5348: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5349: this takes the <code class="filename">+CONTENTS</code> of a
5350: <em class="replaceable"><code>pkg</code></em> and filters it through
5351: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 5352: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5353: (not shown above) is a filter command that filters
5354: <code class="filename">+CONTENTS</code> input into a list of files
5355: relative to
5356: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 5357: on stdout. By default,
1.1 dsieger 5358: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5359: outputs the contents of the <code class="filename">include</code>
5360: and <code class="filename">lib</code> directories in the package
1.84 wiz 5361: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 5362: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5363: (not shown above) is a list of sed arguments used to
5364: transform the name of the source filename into a
1.10 hubertf 5365: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5366: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5367: </ul></div>
1.18 snj 5368: <p>This section can additionally include any
1.1 dsieger 5369: <code class="filename">buildlink3.mk</code> needed for
5370: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5371: Including these <code class="filename">buildlink3.mk</code> files
5372: means that the headers and libraries for these
5373: dependencies are also symlinked into
5374: <code class="filename">${BUILDLINK_DIR}</code>
5375: whenever the <em class="replaceable"><code>pkg</code></em>
5376: <code class="filename">buildlink3.mk</code>
1.18 snj 5377: file is included. Dependencies are only added for directly
5378: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 5379: <p>When providing a <code class="filename">buildlink3.mk</code> and
5380: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 5381: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 5382: header files are automatically exposed when the package is
5383: use.</p>
5384: <p>In particular, if only an executable
5385: (<code class="filename">bin/foo</code>) is linked against a library, that
5386: library does not need to be propagated in the
5387: <code class="filename">buildlink3.mk</code> file.</p>
5388: <p>The following steps should help you decide if a
5389: <code class="filename">buildlink3.mk</code> file needs to be included:
5390: </p>
5391: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5392: <li class="listitem"><p>Look at the installed header files: What
5393: headers do they include? The packages providing these files
5394: must be buildlinked.</p></li>
1.49 wiz 5395: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5396: libraries and look against what other libraries they link.
5397: Some of the packages providing these probably need to be
5398: buildlinked; however, it's not automatic, since e.g. GTK on
5399: some systems pulls in the X libraries, so they will show up in
5400: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 5401: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 5402: used as a hint.</p></li>
1.47 wiz 5403: </ul></div>
5404: <p>
5405: </p>
1.1 dsieger 5406: </div>
1.41 asau 5407: <div class="sect2">
1.1 dsieger 5408: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 5409: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 5410: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5411: and
5412: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5413: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5414: <p>These two variables differ in that one describes source
5415: compatibility (API) and the other binary compatibility (ABI).
5416: The difference is that a change in the API breaks compilation of
5417: programs while changes in the ABI stop compiled programs from
5418: running.</p>
5419: <p>Changes to the
1.27 wiz 5420: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5421: variable in a <code class="filename">buildlink3.mk</code> file happen
5422: very rarely. One possible reason is that all packages depending
5423: on this already need a newer version. In case it is bumped see
5424: the description below.</p>
5425: <p>The most common example of an ABI change is that the major
5426: version of a shared library is increased. In this case,
5427: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5428: should be adjusted to require at least the new package version.
5429: Then the packages that depend on this package need their
5430: <code class="varname">PKGREVISION</code>s increased and, if they have
5431: <code class="filename">buildlink3.mk</code> files, their
5432: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5433: adjusted, too. This is needed so pkgsrc will require the correct
5434: package dependency and not settle for an older one when building
5435: the source.</p>
1.10 hubertf 5436: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.26 wiz 5437: more information about dependencies on other packages,
5438: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 5439: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5440: <p>Please take careful consideration before adjusting
5441: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5442: or
5443: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5444: as we don't want to cause unneeded package deletions and
5445: rebuilds. In many cases, new versions of packages work just
5446: fine with older dependencies.</p>
5447: <p>Also it is not needed to set
1.26 wiz 5448: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5449: when it is identical to
1.1 dsieger 5450: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5451: </div>
5452: </div>
1.41 asau 5453: <div class="sect1">
1.1 dsieger 5454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5455: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5456: <p>Some packages in pkgsrc install headers and libraries that
5457: coincide with headers and libraries present in the base system.
5458: Aside from a <code class="filename">buildlink3.mk</code> file, these
5459: packages should also include a <code class="filename">builtin.mk</code>
5460: file that includes the necessary checks to decide whether using
5461: the built-in software or the pkgsrc software is
5462: appropriate.</p>
5463: <p>The only requirements of a builtin.mk file for
5464: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 5465: <div class="orderedlist"><ol class="orderedlist" type="1">
5466: <li class="listitem"><p>It should set
1.1 dsieger 5467: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5468: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 5469: after it is included.</p></li>
1.23 wiz 5470: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 5471: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5472: which is already set before the
5473: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 5474: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 5475: is <span class="emphasis"><em>very</em></span> important and takes careful
5476: attention to <code class="filename">Makefile</code> coding.</p></li>
5477: </ol></div>
1.41 asau 5478: <div class="sect2">
1.1 dsieger 5479: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5480: <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.1 dsieger 5481: <p>The following is the recommended template for builtin.mk
5482: files:</p>
5483: <pre class="programlisting">
5484: .if !defined(IS_BUILTIN.foo)
5485: #
5486: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5487: # genuinely exists in the system or not.
5488: #
5489: IS_BUILTIN.foo?= no
5490:
5491: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5492: # version can be determined.
5493: #
5494: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5495: BUILTIN_PKG.foo?= foo-1.0
5496: . endif
5497: .endif # IS_BUILTIN.foo
5498:
5499: .if !defined(USE_BUILTIN.foo)
5500: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5501: . if defined(BUILTIN_PKG.foo)
5502: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5503: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5504: USE_BUILTIN.foo!= \
5505: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5506: && ${ECHO} "yes" || ${ECHO} "no"
5507: . endif
5508: . endfor
5509: . endif
5510: .endif # USE_BUILTIN.foo
5511:
5512: CHECK_BUILTIN.foo?= no
5513: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5514: #
5515: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5516: # "yes" or "no".
5517: #
5518: .endif # CHECK_BUILTIN.foo
5519: </pre>
5520: <p>The first section sets
5521: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5522: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5523: in the base system. This should not be a base system software
5524: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5525: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5526: included as part of the base system. This variable is only
5527: used internally within the <code class="filename">builtin.mk</code>
5528: file.</p>
5529: <p>The second section sets
5530: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5531: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5532: system if it exists (if
5533: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5534: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5535: within the <code class="filename">builtin.mk</code> file.</p>
5536: <p>The third section sets
5537: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5538: and is <span class="emphasis"><em>required</em></span> in all
5539: <code class="filename">builtin.mk</code> files. The code in this
5540: section must make the determination whether the built-in
5541: software is adequate to satisfy the dependencies listed in
5542: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5543: This is typically done by comparing
5544: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5545: against each of the dependencies in
5546: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5547: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5548: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5549: end of the <code class="filename">builtin.mk</code> file. Note that
5550: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5551: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5552: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5553: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5554: that the built-in version of the software is similar enough to
5555: be used as a replacement.</p>
5556: <p>The last section is guarded by
5557: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5558: and includes code that uses the value of
5559: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5560: set in the previous section. This typically includes, e.g.,
5561: adding additional dependency restrictions and listing additional
5562: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5563: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5564: </div>
1.41 asau 5565: <div class="sect2">
1.1 dsieger 5566: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5567: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5568: <p>When building packages, it's possible to choose whether to set
5569: a global preference for using either the built-in (native)
5570: version or the pkgsrc version of software to satisfy a
5571: dependency. This is controlled by setting
5572: <code class="varname">PREFER_PKGSRC</code> and
5573: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5574: 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.1 dsieger 5575: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5576: use the pkgsrc versions of software, while
5577: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5578: built-in versions. Preferences are determined by the most
5579: specific instance of the package in either
5580: <code class="varname">PREFER_PKGSRC</code> or
5581: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5582: in neither or in both variables, then
5583: <code class="varname">PREFER_PKGSRC</code> has precedence over
5584: <code class="varname">PREFER_NATIVE</code>. For example, to require
5585: using pkgsrc versions of software for all but the most basic
5586: bits on a NetBSD system, you can set:</p>
5587: <pre class="programlisting">
5588: PREFER_PKGSRC= yes
5589: PREFER_NATIVE= getopt skey tcp_wrappers
5590: </pre>
5591: <p>A package <span class="emphasis"><em>must</em></span> have a
5592: <code class="filename">builtin.mk</code>
5593: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5594: otherwise it is simply ignored in that list.</p>
5595: </div>
5596: </div>
5597: </div>
1.41 asau 5598: <div class="chapter">
1.1 dsieger 5599: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5600: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5601: <div class="toc">
5602: <p><b>Table of Contents</b></p>
1.94 wiz 5603: <dl class="toc">
1.6 rillig 5604: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1 dsieger 5605: <dd><dl>
1.6 rillig 5606: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5607: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5608: </dl></dd>
1.6 rillig 5609: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5610: <dd><dl>
1.23 wiz 5611: <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.6 rillig 5612: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5613: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5614: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5615: </dl></dd>
5616: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5617: <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>
5618: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5619: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5620: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5621: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5622: <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.1 dsieger 5623: </dl>
5624: </div>
5625: <p>This chapter describes the framework known as
5626: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5627: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5628: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5629: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5630: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5631: provided that packages are correctly designed.</p></li>
1.23 wiz 5632: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5633: <li class="listitem"><p>Registration of system users and groups.</p></li>
5634: <li class="listitem"><p>Registration of system shells.</p></li>
5635: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5636: </ul></div>
5637: <p>The following sections inspect each of the above points in detail.</p>
5638: <p>You may be thinking that many of the things described here could be
5639: easily done with simple code in the package's post-installation target
5640: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5641: as the code in them is only executed when building from source. Machines
5642: using binary packages could not benefit from it at all (as the code itself
5643: could be unavailable). Therefore, the only way to achieve any of the items
5644: described above is by means of the installation scripts, which are
5645: automatically generated by pkginstall.</p>
1.41 asau 5646: <div class="sect1">
1.1 dsieger 5647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5648: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5649: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5650: of files and directories that belong to a package. The names used in it
5651: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5652: which means that it cannot register files outside this directory (absolute
5653: path names are not allowed). Despite this restriction, some packages need
5654: to install files outside this location; e.g., under
5655: <code class="filename">${VARBASE}</code> or
5656: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5657: is to create such files during installation time by using
5658: installation scripts.</p>
5659: <p>The generic installation scripts are shell scripts that can
5660: contain arbitrary code. The list of scripts to execute is taken from
5661: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5662: <code class="filename">INSTALL</code>. A similar variable exists for package
5663: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5664: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5665: commands, so they have the potential to create and manage files
5666: anywhere in the file system.</p>
5667: <p>Using these general installation files is not recommended, but
5668: may be needed in some special cases. One reason for avoiding them is
5669: that the user has to trust the packager that there is no unwanted or
5670: simply erroneous code included in the installation script. Also,
5671: previously there were many similar scripts for the same functionality,
5672: and fixing a common error involved finding and changing all of
5673: them.</p>
5674: <p>The pkginstall framework offers another, standardized way. It
5675: provides generic scripts to abstract the manipulation of such files
5676: and directories based on variables set in the package's
5677: <code class="filename">Makefile</code>. The rest of this section describes
5678: these variables.</p>
1.41 asau 5679: <div class="sect2">
1.1 dsieger 5680: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5681: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5682: <p>The following variables can be set to request the creation of
5683: directories anywhere in the file system:</p>
1.41 asau 5684: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5685: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5686: contain a list of directories that should be created and should attempt
5687: to be destroyed by the installation scripts. The difference between
5688: the two is that the latter prompts the administrator to remove any
5689: directories that may be left after deinstallation (because they were
5690: not empty), while the former does not.</p></li>
1.23 wiz 5691: <li class="listitem">
1.1 dsieger 5692: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5693: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5694: which directories should be created and should attempt to be destroyed
5695: by the installation scripts. Each tuple holds the following values,
5696: separated by spaces: the directory name, its owner, its group and its
5697: numerical mode. For example:</p>
5698: <pre class="programlisting">
5699: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5700: </pre>
5701: <p>The difference between the two is exactly the same as their
5702: non-<code class="varname">PERMS</code> counterparts.</p>
5703: </li>
5704: </ul></div>
5705: </div>
1.41 asau 5706: <div class="sect2">
1.1 dsieger 5707: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5708: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5709: <p>Creating non-empty files outside the installation prefix is tricky
5710: because the <code class="filename">PLIST</code> forces all files to be inside it.
5711: To overcome this problem, the only solution is to extract the file in the
5712: known place (i.e., inside the installation prefix) and copy it to the
5713: appropriate location during installation (done by the installation scripts
5714: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5715: file</em></span> in the following paragraphs, which describe the variables
5716: that can be used to automatically and consistently handle files outside the
5717: installation prefix:</p>
1.41 asau 5718: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5719: <li class="listitem">
1.1 dsieger 5720: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5721: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5722: During installation time, the master file is copied to the target one
5723: if and only if the latter does not exist. Upon deinstallation, the
5724: target file is removed provided that it was not modified by the
5725: installation.</p>
5726: <p>The difference between the two is that the latter prompts the
5727: administrator to remove any files that may be left after
5728: deinstallation (because they were not empty), while the former does
5729: not.</p>
5730: </li>
1.23 wiz 5731: <li class="listitem">
1.1 dsieger 5732: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5733: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5734: files as well as their target locations. For each of them, it also
5735: specifies their owner, their group and their numeric permissions, in
5736: this order. For example:</p>
5737: <pre class="programlisting">
1.30 wiz 5738: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 dsieger 5739: </pre>
5740: <p>The difference between the two is exactly the same as their
5741: non-<code class="varname">PERMS</code> counterparts.</p>
5742: </li>
5743: </ul></div>
5744: </div>
5745: </div>
1.41 asau 5746: <div class="sect1">
1.1 dsieger 5747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5748: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5749: <p>Configuration files are special in the sense that they are installed
5750: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5751: need special treatment during installation (most of which is automated by
5752: pkginstall). The main concept you must bear in mind is that files marked
5753: as configuration files are automatically copied to the right place (somewhere
5754: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5755: and only if</em></span> they didn't exist before. Similarly, they will not
5756: be removed if they have local modifications. This ensures that
5757: administrators never lose any custom changes they may have made.</p>
1.41 asau 5758: <div class="sect2">
1.1 dsieger 5759: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5760: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1 dsieger 5761: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5762: specifies where configuration files shall be installed. Its contents are
5763: set based upon the following variables:</p>
1.41 asau 5764: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5765: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5766: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5767: be overridden by the user to point to his preferred location (e.g.,
5768: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5769: Packages must not use it directly.</p></li>
1.23 wiz 5770: <li class="listitem">
1.1 dsieger 5771: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5772: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5773: for the package being built shall be installed. The definition of this
5774: variable only makes sense in the package's
5775: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5776: <p>As an example, consider the Apache package,
1.79 snj 5777: <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.1 dsieger 5778: configuration files under the
5779: <code class="filename">httpd/</code> subdirectory of
5780: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5781: Makefile.</p>
5782: </li>
1.23 wiz 5783: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5784: variable that holds this package's configuration directory (if
5785: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5786: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5787: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5788: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5789: directory where the configuration files for the package identified by
5790: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5791: </ul></div>
5792: <p>Based on the above variables, pkginstall determines the value of
5793: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5794: variable that can be used within a package to refer to its configuration
5795: directory. The algorithm used to set its value is basically the
5796: following:</p>
1.23 wiz 5797: <div class="orderedlist"><ol class="orderedlist" type="1">
5798: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5799: its value is used.</p></li>
1.23 wiz 5800: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5801: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5802: <code class="filename">Makefile</code>, the resulting value is
5803: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5804: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5805: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5806: </ol></div>
5807: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5808: 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
5809: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5810: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5811: </div>
1.41 asau 5812: <div class="sect2">
1.1 dsieger 5813: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5814: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5815: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5816: known place, you need to teach each package where it shall install its
5817: files. In some cases you will have to patch the package Makefiles to
5818: achieve it. If you are lucky, though, it may be as easy as passing an
5819: extra flag to the configuration script; this is the case of GNU Autoconf-
5820: generated files:</p>
5821: <pre class="programlisting">
5822: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5823: </pre>
5824: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5825: for</em></span> its configuration files, not where they will be originally
5826: installed (although the difference is never explicit,
5827: unfortunately).</p>
5828: </div>
1.41 asau 5829: <div class="sect2">
1.1 dsieger 5830: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5831: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5832: <p>As said before, pkginstall automatically handles configuration files.
5833: This means that <span class="strong"><strong>the packages themselves must not
5834: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5835: directly</strong></span>. Bad news is that many software installation scripts
5836: will, out of the box, mess with the contents of that directory. So what is
5837: the correct procedure to fix this issue?</p>
5838: <p>You must teach the package (usually by manually patching it) to
5839: install any configuration files under the examples hierarchy,
5840: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5841: <code class="filename">PLIST</code> registers them and the administrator always
5842: has the original copies available.</p>
5843: <p>Once the required configuration files are in place (i.e., under the
5844: examples hierarchy), the pkginstall framework can use them as master copies
5845: during the package installation to update what is in
5846: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5847: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5848: 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.1 dsieger 5849: about their syntax and their purpose. Here is an example, taken from the
1.79 snj 5850: <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.1 dsieger 5851: <pre class="programlisting">
5852: EGDIR= ${PREFIX}/share/doc/mutt/samples
5853: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5854: </pre>
5855: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5856: package and has no meaning outside it.</p>
5857: </div>
1.41 asau 5858: <div class="sect2">
1.1 dsieger 5859: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5860: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5861: <p>The automatic copying of config files can be toggled by setting the
5862: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5863: installation.</p>
5864: </div>
5865: </div>
1.41 asau 5866: <div class="sect1">
1.1 dsieger 5867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5868: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5869: <p>System startup scripts are special files because they must be
5870: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5871: 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.1 dsieger 5872: can be used. However, pkginstall provides a special mechanism to handle
5873: these files.</p>
5874: <p>In order to provide system startup scripts, the package has
5875: to:</p>
1.23 wiz 5876: <div class="orderedlist"><ol class="orderedlist" type="1">
5877: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5878: the <code class="literal">.sh</code> suffix appended. Considering the
1.79 snj 5879: <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.1 dsieger 5880: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5881: <li class="listitem">
1.1 dsieger 5882: <p>Tell pkginstall to handle it, appending the name of the script,
5883: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5884: Continuing the previous example:</p>
5885: <pre class="programlisting">
5886: RCD_SCRIPTS+= cupsd
5887: </pre>
5888: </li>
5889: </ol></div>
5890: <p>Once this is done, pkginstall will do the following steps for each
5891: script in an automated fashion:</p>
1.23 wiz 5892: <div class="orderedlist"><ol class="orderedlist" type="1">
5893: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5894: substitutions described in the <code class="filename">FILES_SUBST</code>
5895: variable.</p></li>
1.23 wiz 5896: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5897: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5898: that this master file must be explicitly registered in the
5899: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5900: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5901: from the examples hierarchy into the system-wide startup scripts
5902: directory.</p></li>
5903: </ol></div>
1.41 asau 5904: <div class="sect2">
1.1 dsieger 5905: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5906: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5907: <p>The automatic copying of config files can be toggled by setting the
5908: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5909: installation. Note that the scripts will be always copied inside the
5910: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5911: matter what the value of this variable is.</p>
5912: </div>
5913: </div>
1.41 asau 5914: <div class="sect1">
1.1 dsieger 5915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5916: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5917: <p>If a package needs to create special users and/or groups during
5918: installation, it can do so by using the pkginstall framework.</p>
5919: <p>Users can be created by adding entries to the
5920: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5921: syntax:</p>
5922: <pre class="programlisting">
5923: user:group
5924: </pre>
5925: <p>Further specification of user details may be done by setting
5926: per-user variables.
5927: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5928: numeric UID for the user.
5929: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5930: user's description or comment.
5931: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5932: user's home directory, and defaults to
5933: <code class="filename">/nonexistent</code> if not specified.
5934: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5935: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5936: not specified.</p>
5937: <p>Similarly, groups can be created by adding entries to the
5938: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5939: <pre class="programlisting">
5940: group
5941: </pre>
5942: <p>The numeric GID of the group may be set by defining
5943: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5944: <p>If a package needs to create the users and groups at an earlier
5945: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5946: either <code class="literal">configure</code> or <code class="literal">build</code> to
5947: indicate the phase before which the users and groups are created. In
5948: this case, the numeric UIDs and GIDs of the created users and groups
5949: are automatically hardcoded into the final installation scripts.</p>
5950: </div>
1.41 asau 5951: <div class="sect1">
1.1 dsieger 5952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5953: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5954: <p>Packages that install system shells should register them in the shell
5955: database, <code class="filename">/etc/shells</code>, to make things easier to the
5956: administrator. This must be done from the installation scripts to keep
5957: binary packages working on any system. pkginstall provides an easy way to
5958: accomplish this task.</p>
5959: <p>When a package provides a shell interpreter, it has to set the
5960: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5961: add some hooks to the installation scripts to handle it. Consider the
1.79 snj 5962: 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.1 dsieger 5963: <pre class="programlisting">
5964: PKG_SHELL= ${PREFIX}/bin/zsh
5965: </pre>
1.41 asau 5966: <div class="sect2">
1.1 dsieger 5967: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5968: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5969: <p>The automatic registration of shell interpreters can be disabled by
5970: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5971: environment variable to <code class="literal">NO</code>.</p>
5972: </div>
5973: </div>
1.41 asau 5974: <div class="sect1">
1.1 dsieger 5975: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5976: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5977: <p>Packages that install X11 fonts should update the database files
5978: that index the fonts within each fonts directory. This can easily be
5979: accomplished within the pkginstall framework.</p>
5980: <p>When a package installs X11 fonts, it must list the directories in
5981: which fonts are installed in the
5982: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5983: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5984: <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.1 dsieger 5985: installation scripts to run the appropriate commands to update the fonts
5986: database files within each of those directories. For convenience, if the
5987: directory path is relative, it is taken to be relative to the package's
1.79 snj 5988: 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.1 dsieger 5989: <pre class="programlisting">
1.67 wiz 5990: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5991: </pre>
1.41 asau 5992: <div class="sect2">
1.1 dsieger 5993: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5994: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5995: <p>The automatic update of fonts databases can be disabled by
5996: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5997: environment variable to <code class="literal">NO</code>.</p>
5998: </div>
5999: </div>
6000: </div>
1.41 asau 6001: <div class="chapter">
1.1 dsieger 6002: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6003: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 6004: <div class="toc">
6005: <p><b>Table of Contents</b></p>
1.94 wiz 6006: <dl class="toc">
1.6 rillig 6007: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 6008: <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.6 rillig 6009: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 6010: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 6011: </dl>
6012: </div>
6013: <p>Many packages have the ability to be built to support different
6014: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6015: in pkgsrc that provides generic handling of those options that
6016: determine different ways in which the packages can be built. It's
6017: possible for the user to specify exactly which sets of options will be
6018: built into a package or to allow a set of global default options
6019: apply.</p>
1.7 rillig 6020: <p>There are two broad classes of behaviors that one might want to
6021: control via options. One is whether some particular feature is
6022: enabled in a program that will be built anyway, often by including or
6023: not including a dependency on some other package. The other is
6024: whether or not an additional program will be built as part of the
6025: package. Generally, it is better to make a split package for such
6026: additional programs instead of using options, because it enables
6027: binary packages to be built which can then be added separately. For
6028: example, the foo package might have minimal dependencies (those
6029: packages without which foo doesn't make sense), and then the foo-gfoo
6030: package might include the GTK frontend program gfoo. This is better
6031: than including a gtk option to foo that adds gfoo, because either that
6032: option is default, in which case binary users can't get foo without
6033: gfoo, or not default, in which case they can't get gfoo. With split
6034: packages, they can install foo without having GTK, and later decide to
6035: install gfoo (pulling in GTK at that time). This is an advantage to
6036: source users too, avoiding the need for rebuilds.</p>
6037: <p>Plugins with widely varying dependencies should usually be split
6038: instead of options.</p>
6039: <p>It is often more work to maintain split packages, especially if
6040: the upstream package does not support this. The decision of split
6041: vs. option should be made based on the likelihood that users will want
6042: or object to the various pieces, the size of the dependencies that are
6043: included, and the amount of work.</p>
6044: <p>A further consideration is licensing. Non-free parts, or parts
6045: that depend on non-free dependencies (especially plugins) should
6046: almost always be split if feasible.</p>
1.41 asau 6047: <div class="sect1">
1.1 dsieger 6048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6049: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6050: <p>Global default options are listed in
6051: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6052: that should be built into every package if that option is supported.
1.10 hubertf 6053: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6054: </div>
1.41 asau 6055: <div class="sect1">
1.1 dsieger 6056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6057: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6058: </h2></div></div></div>
6059: <p>The following example shows how
6060: <code class="filename">bsd.options.mk</code> should be used
6061: by the hypothetical ``wibble'' package, either in the package
6062: <code class="filename">Makefile</code>, or in a file,
6063: e.g. <code class="filename">options.mk</code>, that is included by the
6064: main package <code class="filename">Makefile</code>.</p>
6065: <pre class="programlisting">
6066: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6067: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6068: PKG_OPTIONS_OPTIONAL_GROUPS= database
6069: PKG_OPTIONS_GROUP.database= mysql pgsql
6070: PKG_SUGGESTED_OPTIONS= wibble-foo
6071: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6072: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6073:
6074: .include "../../mk/bsd.prefs.mk"
6075:
6076: # this package was previously named wibble2
6077: .if defined(PKG_OPTIONS.wibble2)
6078: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6079: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6080: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6081: .endif
6082:
6083: .include "../../mk/bsd.options.mk"
6084:
6085: # Package-specific option-handling
6086:
6087: ###
6088: ### FOO support
6089: ###
6090: .if !empty(PKG_OPTIONS:Mwibble-foo)
6091: CONFIGURE_ARGS+= --enable-foo
6092: .endif
6093:
6094: ###
6095: ### LDAP support
6096: ###
6097: .if !empty(PKG_OPTIONS:Mldap)
6098: . include "../../databases/openldap-client/buildlink3.mk"
6099: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6100: .endif
6101:
6102: ###
6103: ### database support
6104: ###
6105: .if !empty(PKG_OPTIONS:Mmysql)
6106: . include "../../mk/mysql.buildlink3.mk"
6107: .endif
6108: .if !empty(PKG_OPTIONS:Mpgsql)
6109: . include "../../mk/pgsql.buildlink3.mk"
6110: .endif
6111: </pre>
6112: <p>The first section contains the information about which build
6113: options are supported by the package, and any default options settings
6114: if needed.</p>
1.23 wiz 6115: <div class="orderedlist"><ol class="orderedlist" type="1">
6116: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.79 snj 6117: <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.1 dsieger 6118: options. It should be set to
6119: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6120: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6121: at the point where the options are processed.</p></li>
1.23 wiz 6122: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 6123: build options supported by the package.</p></li>
1.23 wiz 6124: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 6125: list of names of groups of mutually exclusive options. The options in
6126: each group are listed in
6127: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6128: The most specific setting of any option from the group takes
6129: precedence over all other options in the group. Options from the
6130: groups will be automatically added to
6131: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 6132: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 6133: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6134: packages will fail if no option from the group is
6135: selected.</p></li>
1.23 wiz 6136: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 6137: of names of sets of options. At least one option from each set must
6138: be selected. The options in each set are listed in
6139: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6140: Options from the sets will be automatically added to
6141: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6142: fail if no option from the set is selected.</p></li>
1.23 wiz 6143: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 6144: build options which are enabled by default.</p></li>
1.23 wiz 6145: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 6146: of
1.23 wiz 6147: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.10 hubertf 6148: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6149: their option counterparts. Pairs should be added with
1.23 wiz 6150: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 6151: warning will be issued if the user uses a legacy
6152: variable.</p></li>
1.23 wiz 6153: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 6154: of
1.23 wiz 6155: <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.1 dsieger 6156: pairs that map options that have been renamed to their new
1.23 wiz 6157: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 6158: the listing of global legacy options. A warning will be issued if
6159: the user uses a legacy option.</p></li>
1.23 wiz 6160: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 6161: options implied by deprecated variables used. This can be used for
6162: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6163: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6164: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 6165: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 6166: a list of warnings about deprecated variables or options used, and
6167: what to use instead.</p></li>
6168: </ol></div>
6169: <p>A package should never modify
6170: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6171: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6172: To suggest a default set of options, use
6173: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6174: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6175: including <code class="filename">bsd.options.mk</code>. If none of
6176: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6177: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6178: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6179: happen with platform-specific options if none of them is supported on
6180: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6181: empty list and the package is otherwise treated as not using the
6182: options framework.</p>
6183: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6184: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6185: build options, properly filtered to remove unsupported and duplicate
6186: options.</p>
6187: <p>The remaining sections contain the logic that is specific to
6188: each option. The correct way to check for an option is to check
6189: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6190: <pre class="programlisting">
6191: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6192: </pre>
6193: </div>
1.41 asau 6194: <div class="sect1">
1.1 dsieger 6195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6196: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6197: <p>Options that enable similar features in different packages (like
6198: optional support for a library) should use a common name in all
6199: packages that support it (like the name of the library). If another
6200: package already has an option with the same meaning, use the same
6201: name.</p>
6202: <p>Options that enable features specific to one package, where it's
6203: unlikely that another (unrelated) package has the same (or a similar)
6204: optional feature, should use a name prefixed with
6205: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6206: <p>If a group of related packages share an optional feature
6207: specific to that group, prefix it with the name of the
1.23 wiz 6208: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 6209: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6210: <p>For new options, add a line to
6211: <code class="filename">mk/defaults/options.description</code>. Lines have two
6212: fields, separated by tab. The first field is the option name, the
6213: second its description. The description should be a whole sentence
6214: (starting with an uppercase letter and ending with a period) that
1.23 wiz 6215: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6216: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 6217: </div>
1.41 asau 6218: <div class="sect1">
1.7 rillig 6219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6220: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 6221: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7 rillig 6222: different dependencies based on the options with which the package was
6223: built. For querying these options, the file
6224: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6225: typical example looks like this:</p>
6226: <pre class="programlisting">
6227: pkgbase := libpurple
6228: .include "../../mk/pkg-build-options.mk"
6229:
6230: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6231: ...
6232: .endif
6233: </pre>
6234: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6235: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6236: options of the libpurple package, which can then be queried like
6237: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6238: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6239: details.</p>
6240: </div>
1.1 dsieger 6241: </div>
1.41 asau 6242: <div class="chapter">
1.1 dsieger 6243: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6244: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6245: <div class="toc">
6246: <p><b>Table of Contents</b></p>
1.94 wiz 6247: <dl class="toc">
1.6 rillig 6248: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6249: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6250: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6251: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 6252: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 6253: <dd><dl>
6254: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6255: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6256: </dl></dd>
1.23 wiz 6257: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6258: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6259: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6260: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6261: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6262: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6263: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6264: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6265: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6266: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 6267: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6268: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6269: </dl>
6270: </div>
1.41 asau 6271: <div class="sect1">
1.1 dsieger 6272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6273: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6274: <p>This chapter gives a detailed description on how a package is
6275: built. Building a package is separated into different
6276: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6277: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 6278: described in the following sections. Each phase is split into
1.1 dsieger 6279: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6280: containing phase, prefixed by one of <code class="varname">pre-</code>,
6281: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6282: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6283: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6284: <p>Never override the regular targets (like
6285: <code class="varname">fetch</code>), if you have to, override the
6286: <code class="varname">do-*</code> ones instead.</p>
6287: <p>The basic steps for building a program are always the same. First
6288: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6289: the local system and then extracted. After any pkgsrc-specific patches
6290: to compile properly are applied, the software can be configured, then
6291: built (usually by compiling), and finally the generated binaries, etc.
6292: can be put into place on the system.</p>
6293: <p>To get more details about what is happening at each step,
6294: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6295: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6296: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6297: </div>
1.41 asau 6298: <div class="sect1">
1.1 dsieger 6299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6300: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6301: <p>Before outlining the process performed by the NetBSD package system in
6302: the next section, here's a brief discussion on where programs are
6303: installed, and which variables influence this.</p>
6304: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6305: where all files of the final program shall be installed. It is
6306: usually set to <code class="varname">LOCALBASE</code>
6307: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6308: for pkgs in the <code class="filename">cross</code> category. The value of
6309: <code class="varname">PREFIX</code> needs to be put
6310: into the various places in the program's source where paths to
1.10 hubertf 6311: 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.1 dsieger 6312: <p>When choosing which of these variables to use,
6313: follow the following rules:</p>
1.41 asau 6314: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6315: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 6316: where the current pkg will be installed. When referring to a
6317: pkg's own installation path, use
1.23 wiz 6318: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6319: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 6320: are installed. If you need to construct a -I or -L argument
6321: to the compiler to find includes and libraries installed by
1.23 wiz 6322: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 6323: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6324: installed all packages in <code class="filename">/usr/local</code>. As
6325: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6326: administrator, this variable is a misnomer.</p></li>
1.23 wiz 6327: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 6328: distribution (from xsrc, etc.) is installed. When looking for
6329: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 6330: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6331: <li class="listitem">
1.1 dsieger 6332: <p>X11-based packages are special in that they may be
6333: installed in either <code class="varname">X11BASE</code> or
6334: <code class="varname">LOCALBASE</code>.</p>
6335: <p>Usually, X11 packages should be installed under
6336: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6337: will need to include
6338: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6339: request the presence of X11 and to get the right compilation
6340: flags.</p>
6341: <p>Even though, there are some packages that cannot be installed
6342: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6343: files. These packages are special and they must be placed under
6344: <code class="varname">X11BASE</code>. To accomplish this, set either
6345: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6346: your package.</p>
6347: <p>Some notes: If you need
6348: to find includes or libraries installed by a pkg that has
6349: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6350: its pkg <code class="filename">Makefile</code>, you need to look in
6351: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6352: <code class="filename">${LOCALBASE}</code>. To force installation of
6353: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.79 snj 6354: <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.1 dsieger 6355: is enabled by default.</p>
6356: </li>
1.23 wiz 6357: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1 dsieger 6358: the installed location of an X11
6359: package. <code class="varname">X11PREFIX</code> will be set to
6360: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6361: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6362: installed.</p></li>
1.23 wiz 6363: <li class="listitem">
1.1 dsieger 6364: <p>If xpkgwedge is installed, it is possible to have some
6365: packages installed in <code class="varname">X11BASE</code> and some in
6366: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6367: installed package, the <code class="varname">EVAL_PREFIX</code>
6368: definition can be used. It takes pairs in the format
1.79 snj 6369: <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.1 dsieger 6370: variable <code class="varname">DIRNAME</code> will be set to the prefix
6371: of the installed package <package>, or
1.23 wiz 6372: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.1 dsieger 6373: installed.</p>
6374: <p>This is best illustrated by example.</p>
6375: <p>The following lines are taken from
6376: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6377: <pre class="programlisting">
6378: EVAL_PREFIX+= GTKDIR=gtk+
6379: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6380: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6381: CONFIGURE_ARGS+= --enable-multibyte
6382: </pre>
6383: <p>Specific defaults can be defined for the packages
6384: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6385: definition of the form:</p>
6386: <pre class="programlisting">
6387: GTKDIR_DEFAULT= ${LOCALBASE}
6388: </pre>
6389: <p>where <code class="varname">GTKDIR</code> corresponds
6390: to the first definition in
6391: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6392: </li>
1.23 wiz 6393: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.79 snj 6394: 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.1 dsieger 6395: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6396: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6397: </ul></div>
6398: </div>
1.41 asau 6399: <div class="sect1">
1.1 dsieger 6400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6401: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 6402: <p>When building a package, various directories are used to store
1.1 dsieger 6403: source files, temporary files, pkgsrc-internal files, and so on. These
6404: directories are explained here.</p>
6405: <p>Some of the directory variables contain relative pathnames. There
6406: are two common base directories for these relative directories:
6407: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6408: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6409: inside the package itself.</p>
1.41 asau 6410: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6411: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6412: <dd><p>This is an absolute pathname that points to the pkgsrc
6413: root directory. Generally, you don't need
6414: it.</p></dd>
6415: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6416: <dd><p>This is an absolute pathname that points to the
6417: current package.</p></dd>
6418: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6419: <dd><p>This is a pathname relative to
6420: <code class="varname">PKGSRCDIR</code> that points to the current
6421: package.</p></dd>
6422: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6423: <dd><p>This is an absolute pathname pointing to the directory
6424: where all work takes place. The distfiles are extracted to this
6425: directory. It also contains temporary directories and log files used by
6426: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6427: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6428: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6429: <dd><p>This is an absolute pathname pointing to the directory
6430: where the distfiles are extracted. It is usually a direct subdirectory
6431: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6432: that isn't hidden. This variable may be changed by a package
6433: <code class="filename">Makefile</code>.</p></dd>
6434: </dl></div>
1.14 jmcneill 6435: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6436: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 6437: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 6438: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6439: If users would like to have their pkgsrc trees behave in a
6440: read-only manner, then the value of
6441: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6442: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 6443: </div>
1.41 asau 6444: <div class="sect1">
1.1 dsieger 6445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6446: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 6447: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6448: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6449: phase. This will automatically run all phases that are required for this
6450: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6451: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6452: the package will be built, but not installed.</p>
6453: </div>
1.41 asau 6454: <div class="sect1">
1.1 dsieger 6455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6456: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6457: <p>The first step in building a package is to fetch the
6458: distribution files (distfiles) from the sites that are providing
6459: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6460: phase.</p>
1.41 asau 6461: <div class="sect2">
1.1 dsieger 6462: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6463: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 6464: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6465: defines all URLs from where the distfile, whose name is
6466: derived from the <code class="varname">DISTNAME</code> variable, is
6467: fetched. The more complicated cases are described
6468: below.</p>
6469: <p>The variable <code class="varname">DISTFILES</code> specifies
6470: the list of distfiles that have to be fetched. Its value
1.66 asau 6471: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6472: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 6473: so that most packages don't need to define it at all.
6474: <code class="varname">EXTRACT_SUFX</code> is
6475: <code class="literal">.tar.gz</code> by default, but can be changed
6476: freely. Note that if your package requires additional
6477: distfiles to the default one, you cannot just append the
6478: additional filenames using the <code class="literal">+=</code>
6479: operator, but you have write for example:</p>
6480: <pre class="programlisting">
1.66 asau 6481: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 6482: </pre>
6483: <p>Each distfile is fetched from a list of sites, usually
6484: <code class="varname">MASTER_SITES</code>. If the package has multiple
6485: <code class="varname">DISTFILES</code> or multiple
6486: <code class="varname">PATCHFILES</code> from different sites, you can
6487: set
6488: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6489: to the list of URLs where the file
6490: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6491: (including the suffix) can be found.</p>
6492: <pre class="programlisting">
6493: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6494: DISTFILES+= foo-file.tar.gz
6495: SITES.foo-file.tar.gz= \
6496: http://www.somewhere.com/somehow/ \
6497: http://www.somewhereelse.com/mirror/somehow/
6498: </pre>
6499: <p>When actually fetching the distfiles, each item from
6500: <code class="varname">MASTER_SITES</code> or
6501: <code class="varname">SITES.*</code> gets the name of each distfile
6502: appended to it, without an intermediate slash. Therefore,
6503: all site values have to end with a slash or other separator
6504: character. This allows for example to set
6505: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6506: that gets the name of the distfile as a parameter. In this
6507: case, the definition would look like:</p>
6508: <pre class="programlisting">
6509: MASTER_SITES= http://www.example.com/download.cgi?file=
6510: </pre>
1.22 jakllsch 6511: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 6512: In that case the URL is taken as is, fetched and the result
6513: stored under the name of the distfile. You can use this style
6514: for the case when the download URL style does not match the
6515: above common case. For example, if permanent download URL is a
6516: redirector to the real download URL, or the download file name
6517: is offered by an HTTP Content-Disposition header. In the
6518: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6519: created instead of the default
6520: <code class="filename">v1.0.0.tar.gz</code>.</p>
6521: <pre class="programlisting">
6522: DISTNAME= foo-1.0.0
6523: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6524: </pre>
1.1 dsieger 6525: <p>There are some predefined values for
6526: <code class="varname">MASTER_SITES</code>, which can be used in
6527: packages. The names of the variables should speak for
6528: themselves.</p>
6529: <pre class="programlisting">
6530: ${MASTER_SITE_APACHE}
6531: ${MASTER_SITE_BACKUP}
6532: ${MASTER_SITE_CYGWIN}
6533: ${MASTER_SITE_DEBIAN}
6534: ${MASTER_SITE_FREEBSD}
6535: ${MASTER_SITE_FREEBSD_LOCAL}
6536: ${MASTER_SITE_GENTOO}
6537: ${MASTER_SITE_GNOME}
6538: ${MASTER_SITE_GNU}
6539: ${MASTER_SITE_GNUSTEP}
1.66 asau 6540: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 6541: ${MASTER_SITE_IFARCHIVE}
6542: ${MASTER_SITE_KDE}
6543: ${MASTER_SITE_MOZILLA}
1.66 asau 6544: ${MASTER_SITE_MOZILLA_ALL}
6545: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 6546: ${MASTER_SITE_MYSQL}
1.66 asau 6547: ${MASTER_SITE_NETLIB}
1.1 dsieger 6548: ${MASTER_SITE_OPENOFFICE}
6549: ${MASTER_SITE_PERL_CPAN}
6550: ${MASTER_SITE_PGSQL}
1.66 asau 6551: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 6552: ${MASTER_SITE_R_CRAN}
6553: ${MASTER_SITE_SOURCEFORGE}
6554: ${MASTER_SITE_SOURCEFORGE_JP}
6555: ${MASTER_SITE_SUNSITE}
6556: ${MASTER_SITE_SUSE}
6557: ${MASTER_SITE_TEX_CTAN}
6558: ${MASTER_SITE_XCONTRIB}
6559: ${MASTER_SITE_XEMACS}
1.66 asau 6560: ${MASTER_SITE_XORG}
1.1 dsieger 6561: </pre>
6562: <p>Some explanations for the less self-explaining ones:
6563: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6564: 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.25 spz 6565: 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.1 dsieger 6566: <p>If you choose one of these predefined sites, you may
6567: want to specify a subdirectory of that site. Since these
6568: macros may expand to more than one actual site, you
6569: <span class="emphasis"><em>must</em></span> use the following construct to
6570: specify a subdirectory:</p>
6571: <pre class="programlisting">
6572: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6573: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6574: </pre>
6575: <p>Note the trailing slash after the subdirectory
6576: name.</p>
6577: </div>
1.41 asau 6578: <div class="sect2">
1.1 dsieger 6579: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6580: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6581: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6582: all the distfiles exist in a local directory
6583: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6584: user). If the files do not exist, they are fetched using
6585: commands of the form</p>
6586: <pre class="programlisting">
6587: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6588: </pre>
6589: <p>where <code class="literal">${site}</code> varies through
6590: several possibilities in turn: first,
6591: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6592: sites specified in either <code class="varname">SITES.file</code> if
6593: defined, else <code class="varname">MASTER_SITES</code> or
6594: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6595: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6596: all except the first and the last can be optionally sorted
6597: by the user, via setting either
6598: <code class="varname">MASTER_SORT_RANDOM</code>, and
6599: <code class="varname">MASTER_SORT_AWK</code> or
6600: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6601: <p> The specific command and arguments used depend on the
6602: <code class="varname">FETCH_USING</code> parameter. The example above is
6603: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6604: <p>The distfiles mirror run by the NetBSD Foundation uses the
6605: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6606: distfiles, if they are freely distributable. Packages setting
6607: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6608: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6609: mirrored.</p>
6610: </div>
6611: </div>
1.41 asau 6612: <div class="sect1">
1.1 dsieger 6613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6614: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6615: <p>After the distfile(s) are fetched, their checksum is
6616: generated and compared with the checksums stored in the
6617: distinfo file. If the checksums don't match, the build is
6618: aborted. This is to ensure the same distfile is used for
6619: building, and that the distfile wasn't changed, e.g. by some
6620: malign force, deliberately changed distfiles on the master
6621: distribution site or network lossage.</p>
6622: </div>
1.41 asau 6623: <div class="sect1">
1.1 dsieger 6624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6625: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6626: <p>When the distfiles are present on the local system, they
6627: need to be extracted, as they usually come in the form of some
6628: compressed archive format.</p>
6629: <p>By default, all <code class="varname">DISTFILES</code> are
6630: extracted. If you only need some of them, you can set the
6631: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6632: files.</p>
6633: <p>Extracting the files is usually done by a little
6634: program, <code class="filename">mk/extract/extract</code>, which
6635: already knows how to extract various archive formats, so most
6636: likely you will not need to change anything here. But if you
6637: need, the following variables may help you:</p>
1.41 asau 6638: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6639: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6640: <dd><p>Use these variables to override the default
6641: options for an extract command, which are defined in
6642: <code class="filename">mk/extract/extract</code>.</p></dd>
6643: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6644: <dd><p>This variable can be set to
1.14 jmcneill 6645: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6646: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6647: absolute pathname pointing to the command with which tar
1.14 jmcneill 6648: archives should be extracted. It is preferred to choose bsdtar over gtar
6649: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6650: </dl></div>
6651: <p>If the <code class="filename">extract</code> program doesn't
6652: serve your needs, you can also override the
6653: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6654: command used for extracting the files. This command is
6655: executed in the <code class="filename">${WRKSRC}</code>
6656: directory. During execution of this command, the shell
6657: variable <code class="varname">extract_file</code> holds the absolute
6658: pathname of the file that is going to be extracted.</p>
6659: <p>And if that still does not suffice, you can override the
6660: <code class="varname">do-extract</code> target in the package
6661: Makefile.</p>
6662: </div>
1.41 asau 6663: <div class="sect1">
1.1 dsieger 6664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6665: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6666: <p>After extraction, all the patches named by the
6667: <code class="varname">PATCHFILES</code>, those present in the patches
6668: subdirectory of the package as well as in
6669: $LOCALPATCHES/$PKGPATH (e.g.
6670: <code class="filename">/usr/local/patches/graphics/png</code>) are
6671: applied. Patchfiles ending in <code class="filename">.Z</code> or
6672: <code class="filename">.gz</code> are uncompressed before they are
6673: applied, files ending in <code class="filename">.orig</code> or
6674: <code class="filename">.rej</code> are ignored. Any special options to
1.79 snj 6675: <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.10 hubertf 6676: <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.79 snj 6677: <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.1 dsieger 6678: it fail if the patches apply with some lines of fuzz. Please
6679: fix (regen) the patches so that they apply cleanly. The
6680: rationale behind this is that patches that don't apply cleanly
6681: may end up being applied in the wrong place, and cause severe
6682: harm there.</p>
6683: </div>
1.41 asau 6684: <div class="sect1">
1.1 dsieger 6685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6686: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6687: <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.1 dsieger 6688: </p>
6689: </div>
1.41 asau 6690: <div class="sect1">
1.1 dsieger 6691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6692: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6693: <p>This phase creates wrapper programs for the compilers and
6694: linkers. The following variables can be used to tweak the
6695: wrappers.</p>
1.41 asau 6696: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6697: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6698: <dd><p>The command used to print progress
6699: messages. Does nothing by default. Set to
6700: <code class="literal">${ECHO}</code> to see the progress
6701: messages.</p></dd>
6702: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6703: <dd><p>This variable can be set to
6704: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6705: depending on whether you want additional information in the
6706: wrapper log file.</p></dd>
6707: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6708: <dd><p>This variable can be set to
6709: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6710: on whether the wrapper should use its cache, which will
6711: improve the speed. The default value is
6712: <code class="literal">yes</code>, but is forced to
6713: <code class="literal">no</code> if the platform does not support
6714: it.</p></dd>
6715: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6716: <dd><p>A list of reordering commands. A reordering
6717: command has the form
6718: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6719: It ensures that that
6720: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6721: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6722: </p></dd>
6723: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6724: <dd><p>A list of transformation commands. [TODO:
6725: investigate further]</p></dd>
6726: </dl></div>
6727: </div>
1.41 asau 6728: <div class="sect1">
1.1 dsieger 6729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6730: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6731: <p>Most pieces of software need information on the header
6732: files, system calls, and library routines which are available
6733: on the platform they run on. The process of determining this
6734: information is known as configuration, and is usually
6735: automated. In most cases, a script is supplied with the
6736: distfiles, and its invocation results in generation of header
6737: files, Makefiles, etc.</p>
6738: <p>If the package contains a configure script, this can be
6739: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6740: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6741: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6742: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6743: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6744: <pre class="programlisting">
6745: .for d in ${CONFIGURE_DIRS}
6746: cd ${WRKSRC} \
6747: && cd ${d} \
6748: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6749: .endfor
6750: </pre>
6751: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6752: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6753: <code class="varname">WRKSRC</code>. In each of these directories, the
6754: configure script is run with the environment
6755: <code class="varname">CONFIGURE_ENV</code> and arguments
6756: <code class="varname">CONFIGURE_ARGS</code>. The variables
6757: <code class="varname">CONFIGURE_ENV</code>,
6758: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6759: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6760: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6761: package.</p>
1.37 wiz 6762: <p>If the program uses the Perl way of configuration (mainly Perl
6763: modules, but not only), i.e. a file called
6764: <code class="filename">Makefile.PL</code>, it should include
6765: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6766: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6767: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6768: <p>If the program uses an <code class="filename">Imakefile</code>
6769: for configuration, the appropriate steps can be invoked by
6770: setting <code class="varname">USE_IMAKE</code> to
1.23 wiz 6771: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.1 dsieger 6772: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6773: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6774: xmkmf's environment by adding them to the
6775: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6776: <p>If the program uses <code class="filename">cmake</code>
6777: for configuration, the appropriate steps can be invoked by
1.23 wiz 6778: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6779: You can add variables to cmake's environment by adding them to the
6780: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6781: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6782: The top directory argument is given by the
6783: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6784: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6785: <p>If there is no configure step at all, set
1.23 wiz 6786: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6787: </div>
1.41 asau 6788: <div class="sect1">
1.1 dsieger 6789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6790: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6791: <p>For building a package, a rough equivalent of the
6792: following code is executed.</p>
6793: <pre class="programlisting">
6794: .for d in ${BUILD_DIRS}
6795: cd ${WRKSRC} \
6796: && cd ${d} \
6797: && env ${MAKE_ENV} \
6798: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6799: -f ${MAKE_FILE} \
6800: ${BUILD_TARGET}
6801: .endfor
6802: </pre>
6803: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6804: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6805: <code class="varname">WRKSRC</code>. In each of these directories,
6806: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6807: <code class="varname">MAKE_ENV</code> and arguments
6808: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6809: <code class="varname">MAKE_ENV</code>,
6810: <code class="varname">BUILD_MAKE_FLAGS</code>,
6811: <code class="varname">MAKE_FILE</code> and
6812: <code class="varname">BUILD_TARGET</code> may all be changed by the
6813: package.</p>
6814: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6815: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6816: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6817: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6818: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6819: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6820: <p>If there is no build step at all, set
1.23 wiz 6821: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6822: </div>
1.41 asau 6823: <div class="sect1">
1.1 dsieger 6824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6825: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6826: <p>[TODO]</p>
6827: </div>
1.41 asau 6828: <div class="sect1">
1.1 dsieger 6829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6830: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6831: <p>Once the build stage has completed, the final step is to
6832: install the software in public directories, so users can
6833: access the programs and files.</p>
6834: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6835: equivalent of the following code is executed. Additionally,
6836: before and after this code, much magic is performed to do
6837: consistency checks, registering the package, and so on.</p>
6838: <pre class="programlisting">
6839: .for d in ${INSTALL_DIRS}
6840: cd ${WRKSRC} \
6841: && cd ${d} \
6842: && env ${MAKE_ENV} \
6843: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6844: -f ${MAKE_FILE} \
6845: ${INSTALL_TARGET}
6846: .endfor
6847: </pre>
6848: <p>The variable's meanings are analogous to the ones in the
6849: <span class="emphasis"><em>build</em></span> phase.
6850: <code class="varname">INSTALL_DIRS</code> defaults to
6851: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6852: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6853: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6854: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6855: defined.</p>
6856: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6857: variables are useful. They are all variations of the
1.79 snj 6858: <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.1 dsieger 6859: permissions preset. <code class="varname">INSTALL</code> is the plain
6860: install command. The specialized variants, together with their
6861: intended use, are:</p>
1.41 asau 6862: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6863: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6864: <dd><p>directories that contain
6865: binaries</p></dd>
6866: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6867: <dd><p>directories that contain
6868: scripts</p></dd>
6869: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6870: <dd><p>directories that contain shared and static
6871: libraries</p></dd>
6872: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6873: <dd><p>directories that contain data
6874: files</p></dd>
6875: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6876: <dd><p>directories that contain man
6877: pages</p></dd>
6878: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6879: <dd><p>binaries that can be stripped from debugging
6880: symbols</p></dd>
6881: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6882: <dd><p>binaries that cannot be
6883: stripped</p></dd>
6884: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6885: <dd><p>game
6886: binaries</p></dd>
6887: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6888: <dd><p>shared and static
6889: libraries</p></dd>
6890: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6891: <dd><p>data files</p></dd>
6892: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6893: <dd><p>data files for
6894: games</p></dd>
6895: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6896: <dd><p>man pages</p></dd>
6897: </dl></div>
6898: <p>Some other variables are:</p>
1.41 asau 6899: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6900: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6901: <dd><p>A list of directories relative to
6902: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6903: beginning of the <span class="emphasis"><em>install</em></span> phase.
6904: The package is supposed to create all needed directories itself
6905: before installing files to it and list all other directories here.
6906: </p></dd>
6907: </dl></div>
6908: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6909: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6910: mostly relevant for packages in the <code class="filename">regress</code>
6911: category.</p>
6912: </div>
1.41 asau 6913: <div class="sect1">
1.1 dsieger 6914: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6915: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6916: <p>Once the install stage has completed, a binary package of
6917: the installed files can be built. These binary packages can be
6918: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6919: the <span class="command"><strong>make bin-install</strong></span> or by using
6920: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6921: <p>By default, the binary packages are created in
6922: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6923: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6924: one for each category in the <code class="varname">CATEGORIES</code>
6925: variable. <code class="varname">PACKAGES</code> defaults to
6926: <code class="filename">pkgsrc/packages</code>.</p>
6927: </div>
1.41 asau 6928: <div class="sect1">
1.1 dsieger 6929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6930: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6931: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6932: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6933: to clean the work directories of all dependencies too, use
1.10 hubertf 6934: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6935: </div>
1.41 asau 6936: <div class="sect1">
1.1 dsieger 6937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6938: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6939: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6940: <dt><span class="term">pre/post-*</span></dt>
6941: <dd><p>For any of the main targets described in the
6942: previous section, two auxiliary targets exist with
1.23 wiz 6943: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.1 dsieger 6944: prefix for the main target's name. These targets are
6945: invoked before and after the main target is called,
6946: allowing extra configuration or installation steps be
6947: performed from a package's Makefile, for example, which
6948: a program's configure script or install target
6949: omitted.</p></dd>
6950: <dt><span class="term">do-*</span></dt>
6951: <dd><p>Should one of the main targets do the wrong thing,
6952: and should there be no variable to fix this, you can
6953: redefine it with the do-* target. (Note that redefining
6954: the target itself instead of the do-* target is a bad
6955: idea, as the pre-* and post-* targets won't be called
6956: anymore, etc.) You will not usually need to do
6957: this.</p></dd>
6958: <dt><span class="term">reinstall</span></dt>
6959: <dd>
1.10 hubertf 6960: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6961: you noticed some file was not installed properly, you
6962: can repeat the installation with this target, which will
1.23 wiz 6963: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6964: <p>This is the default value of
6965: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6966: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6967: package</strong></span>, where the defaults are
1.23 wiz 6968: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6969: respectively.</p>
6970: </dd>
6971: <dt><span class="term">deinstall</span></dt>
6972: <dd>
1.79 snj 6973: <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.1 dsieger 6974: current directory, effectively de-installing the
6975: package. The following variables can be used to tune the
6976: behaviour:</p>
1.41 asau 6977: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6978: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.79 snj 6979: <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.1 dsieger 6980: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6981: <dd><p>Remove all packages that require (depend on)
6982: the given package. This can be used to remove any
6983: packages that may have been pulled in by a given
1.10 hubertf 6984: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6985: DEINSTALLDEPENDS=1</strong></span> is done in
6986: <code class="filename">pkgsrc/x11/kde</code>, this is
6987: likely to remove whole KDE. Works by adding
1.79 snj 6988: <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.1 dsieger 6989: command line.</p></dd>
6990: </dl></div>
6991: </dd>
6992: <dt><span class="term">bin-install</span></dt>
6993: <dd><p>Install a binary package from local disk and via FTP
6994: from a list of sites (see the
6995: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6996: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6997: available anywhere. The arguments given to
1.10 hubertf 6998: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6999: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7000: operation, etc.</p></dd>
1.95 ! wiz 7001: <dt><span class="term">install-clean</span></dt>
! 7002: <dd><p>This target removes the state files for the "install" and later
! 7003: phases so that the "install" target may be re-invoked. This can be
! 7004: used after editing the PLIST to install the package without
! 7005: rebuilding it.</p></dd>
! 7006: <dt><span class="term">build-clean</span></dt>
! 7007: <dd><p>This target removes the state files for the "build" and later
! 7008: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 7009: <dt><span class="term">update</span></dt>
7010: <dd>
7011: <p>This target causes the current package to be
7012: updated to the latest version. The package and all
7013: depending packages first get de-installed, then current
7014: versions of the corresponding packages get compiled and
7015: installed. This is similar to manually noting which
7016: packages are currently installed, then performing a
1.10 hubertf 7017: series of <span class="command"><strong>make deinstall</strong></span> and
7018: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 7019: <code class="varname">UPDATE_TARGET</code> is set to) for these
7020: packages.</p>
1.23 wiz 7021: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 7022: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 7023: update</strong></span> was interrupted for some reason.
7024: However, in this case, make sure you don't call
1.10 hubertf 7025: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 7026: list of dependent packages in <code class="varname">WRKDIR</code>.
7027: Otherwise, you lose the ability to automatically update
7028: the current package along with the dependent packages
7029: you have installed.</p>
1.10 hubertf 7030: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 7031: update</strong></span> will only work as long as the package
7032: tree remains unchanged. If the source code for one of
7033: the packages to be updated has been changed, resuming
1.10 hubertf 7034: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 7035: fail!</p>
7036: <p>The following variables can be used either on the
1.10 hubertf 7037: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7038: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 7039: update</strong></span>:</p>
1.41 asau 7040: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7041: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7042: <dd><p>Install target to recursively use for the
7043: updated package and the dependent packages.
7044: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 7045: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 7046: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 7047: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7048: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7049: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 7050: endless loop!</p></dd>
7051: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7052: <dd><p>Don't clean up after updating. Useful if
7053: you want to leave the work sources of the updated
7054: packages around for inspection or other purposes.
7055: Be sure you eventually clean up the source tree
1.23 wiz 7056: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 7057: or you may run into troubles with old source code
7058: still lying around on your next
1.10 hubertf 7059: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 7060: update</strong></span>.</p></dd>
7061: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7062: <dd><p>Deinstall each package before installing
7063: (making <code class="varname">DEPENDS_TARGET</code>). This
7064: may be necessary if the
1.23 wiz 7065: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 7066: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 7067: update</strong></span>.</p></dd>
7068: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7069: <dd><p>Allows you to disable recursion and hardcode
7070: the target for packages. The default is
1.23 wiz 7071: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 7072: facilitating a recursive update of prerequisite
7073: packages. Only set
7074: <code class="varname">DEPENDS_TARGET</code> if you want to
7075: disable recursive updates. Use
7076: <code class="varname">UPDATE_TARGET</code> instead to just
7077: set a specific target for each package to be
1.10 hubertf 7078: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 7079: (see above).</p></dd>
7080: </dl></div>
7081: </dd>
7082: <dt><span class="term">clean-update</span></dt>
7083: <dd>
7084: <p>Clean the source tree for all packages that would
1.10 hubertf 7085: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 7086: from the current directory. This target should not be
7087: used if the current package (or any of its depending
7088: packages) have already been de-installed (e.g., after
1.10 hubertf 7089: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 7090: some packages you intended to update. As a rule of
7091: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 7092: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 7093: and only if you have a dirty package tree (e.g., if you
7094: used <code class="varname">NOCLEAN</code>).</p>
7095: <p>If you are unsure about whether your tree is
1.10 hubertf 7096: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 7097: clean</strong></span> at the top of the tree, or use the
7098: following sequence of commands from the directory of the
7099: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 7100: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 7101: time, otherwise you lose all the packages you wanted to
7102: update!):</p>
7103: <pre class="screen">
7104: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7105: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7106: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7107: </pre>
7108: <p>The following variables can be used either on the
1.10 hubertf 7109: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7110: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 7111: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7112: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 7113: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 7114: reconstruct the list of directories to update for
1.10 hubertf 7115: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 7116: update</strong></span> successfully installed all
7117: packages you wanted to update. Normally, this is
1.10 hubertf 7118: done automatically on <span class="command"><strong>make
1.1 dsieger 7119: update</strong></span>, but may have been suppressed by
7120: the <code class="varname">NOCLEAN</code> variable (see
7121: above).</p></dd>
7122: </dl></div>
7123: </dd>
7124: <dt><span class="term">replace</span></dt>
7125: <dd>
7126: <p>Update the installation of the current package. This
7127: differs from update in that it does not replace dependent
1.79 snj 7128: 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.1 dsieger 7129: target to work.</p>
7130: <p><span class="emphasis"><em>Be careful when using this
7131: target!</em></span> There are no guarantees that dependent
7132: packages will still work, in particular they will most
1.10 hubertf 7133: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 7134: library package whose shared library major version changed
7135: between your installed version and the new one. For this
7136: reason, this target is not officially supported and only
7137: recommended for advanced users.</p>
7138: </dd>
7139: <dt><span class="term">info</span></dt>
1.79 snj 7140: <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.1 dsieger 7141: package. You can use this to check which version of a
7142: package is installed.</p></dd>
7143: <dt><span class="term">index</span></dt>
7144: <dd>
7145: <p>This is a top-level command, i.e. it should be used in
7146: the <code class="filename">pkgsrc</code> directory. It creates a
7147: database of all packages in the local pkgsrc tree, including
7148: dependencies, comment, maintainer, and some other useful
7149: information. Individual entries are created by running
1.10 hubertf 7150: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 7151: directories. This index file is saved as
7152: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 7153: verbose format by running <span class="command"><strong>make
1.1 dsieger 7154: print-index</strong></span>. You can search in it with
1.10 hubertf 7155: <span class="command"><strong>make search
1.1 dsieger 7156: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7157: extract a list of all packages that depend on a particular
1.10 hubertf 7158: one by running <span class="command"><strong>make show-deps
1.1 dsieger 7159: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7160: <p>Running this command takes a very long time, some
7161: hours even on fast machines!</p>
7162: </dd>
7163: <dt><span class="term">readme</span></dt>
7164: <dd>
7165: <p>This target generates a
7166: <code class="filename">README.html</code> file, which can be
1.79 snj 7167: 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.1 dsieger 7168: contain references to any packages which are in the
7169: <code class="varname">PACKAGES</code> directory on the local
7170: host. The generated files can be made to refer to URLs
7171: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7172: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7173: wanted to generate <code class="filename">README.html</code>
7174: files which pointed to binary packages on the local
7175: machine, in the directory
7176: <code class="filename">/usr/packages</code>, set
7177: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7178: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7179: <code class="varname">${PACKAGES}</code> directory and its
7180: subdirectories will be searched for all the binary
7181: packages.</p>
7182: <p>The target can be run at the toplevel or in category
7183: directories, in which case it descends recursively.</p>
7184: </dd>
7185: <dt><span class="term">readme-all</span></dt>
7186: <dd><p>This is a top-level command, run it in
7187: <code class="filename">pkgsrc</code>. Use this target to create a
7188: file <code class="filename">README-all.html</code> which contains a
7189: list of all packages currently available in the NetBSD
7190: Packages Collection, together with the category they belong
7191: to and a short description. This file is compiled from the
7192: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 7193: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 7194: readme</strong></span>.</p></dd>
7195: <dt><span class="term">cdrom-readme</span></dt>
7196: <dd><p>This is very much the same as the
1.23 wiz 7197: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 7198: used when generating a pkgsrc tree to be written to a
7199: CD-ROM. This target also produces
7200: <code class="filename">README.html</code> files, and can be made
7201: to refer to URLs based on
7202: <code class="varname">CDROM_PKG_URL_HOST</code> and
7203: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7204: <dt><span class="term">show-distfiles</span></dt>
7205: <dd><p>This target shows which distfiles and patchfiles
7206: are needed to build the package
7207: (<code class="varname">ALLFILES</code>, which contains all
7208: <code class="varname">DISTFILES</code> and
7209: <code class="varname">PATCHFILES</code>, but not
7210: <code class="filename">patches/*</code>).</p></dd>
7211: <dt><span class="term">show-downlevel</span></dt>
7212: <dd><p>This target shows nothing if the package is not
7213: installed. If a version of this package is installed,
7214: but is not the version provided in this version of
7215: pkgsrc, then a warning message is displayed. This target
7216: can be used to show which of your installed packages are
7217: downlevel, and so the old versions can be deleted, and
7218: the current ones added.</p></dd>
7219: <dt><span class="term">show-pkgsrc-dir</span></dt>
7220: <dd><p>This target shows the directory in the pkgsrc
7221: hierarchy from which the package can be built and
7222: installed. This may not be the same directory as the one
7223: from which the package was installed. This target is
7224: intended to be used by people who may wish to upgrade
7225: many packages on a single host, and can be invoked from
7226: the top-level pkgsrc Makefile by using the
1.23 wiz 7227: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 7228: <dt><span class="term">show-installed-depends</span></dt>
7229: <dd><p>This target shows which installed packages match
7230: the current package's <code class="varname">DEPENDS</code>. Useful
7231: if out of date dependencies are causing build
7232: problems.</p></dd>
1.95 ! wiz 7233: <dt><span class="term">print-build-depends-list</span></dt>
! 7234: <dd><p>This target shows the list of packages that the current package
! 7235: depends on for building.</p></dd>
! 7236: <dt><span class="term">print-run-depends-list</span></dt>
! 7237: <dd><p>This target shows the list of packages that the current package
! 7238: depends on for running.</p></dd>
1.1 dsieger 7239: <dt><span class="term">check-shlibs</span></dt>
7240: <dd><p>After a package is installed, check all its
7241: binaries and (on ELF platforms) shared libraries to see
7242: if they find the shared libs they need. Run by default
1.10 hubertf 7243: 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.1 dsieger 7244: <dt><span class="term">print-PLIST</span></dt>
7245: <dd>
1.23 wiz 7246: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 7247: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 7248: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 7249: -newer work/.extract_done</strong></span>. An attempt is made
7250: to care for shared libs etc., but it is
7251: <span class="emphasis"><em>strongly</em></span> recommended to review the
7252: result before putting it into
7253: <code class="filename">PLIST</code>. On upgrades, it's useful to
7254: diff the output of this command against an already
7255: existing <code class="filename">PLIST</code> file.</p>
1.79 snj 7256: <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.1 dsieger 7257: other methods that don't update file access times, be
7258: sure to add these files manually to your
1.23 wiz 7259: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7260: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 7261: them!</p>
1.23 wiz 7262: <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.1 dsieger 7263: information on this target.</p>
7264: </dd>
7265: <dt><span class="term">bulk-package</span></dt>
7266: <dd>
7267: <p>Used to do bulk builds. If an appropriate binary
7268: package already exists, no action is taken. If not, this
7269: target will compile, install and package it (and its
7270: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 7271: 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
7272: builds)</i></a>).
1.1 dsieger 7273: After creating the binary package, the sources, the
7274: just-installed package and its required packages are
7275: removed, preserving free disk space.</p>
7276: <p><span class="emphasis"><em>Beware that this target may deinstall
7277: all packages installed on a system!</em></span></p>
7278: </dd>
7279: <dt><span class="term">bulk-install</span></dt>
7280: <dd>
7281: <p>Used during bulk-installs to install required
7282: packages. If an up-to-date binary package is available,
1.79 snj 7283: 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.10 hubertf 7284: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 7285: but the installed binary won't be removed.</p>
7286: <p>A binary package is considered
1.23 wiz 7287: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.79 snj 7288: <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.41 asau 7289: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7290: <li class="listitem"><p>None of the package's files
1.1 dsieger 7291: (<code class="filename">Makefile</code>, ...) were modified
7292: since it was built.</p></li>
1.23 wiz 7293: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 7294: packages were modified since it was built.</p></li>
7295: </ul></div>
7296: <p><span class="emphasis"><em>Beware that this target may deinstall
7297: all packages installed on a system!</em></span></p>
7298: </dd>
7299: </dl></div>
7300: </div>
7301: </div>
1.41 asau 7302: <div class="chapter">
1.1 dsieger 7303: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7304: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7305: <div class="toc">
7306: <p><b>Table of Contents</b></p>
1.94 wiz 7307: <dl class="toc">
1.6 rillig 7308: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7309: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7310: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7311: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7312: </dl>
7313: </div>
7314: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7315: by pkgsrc and also for individual packages to define what commands
7316: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7317: or for later run-time of an installed packaged (such as
7318: <code class="varname">DEPENDS</code>).
7319: If the native system provides an adequate tool, then in many cases, a pkgsrc
7320: package will not be used.</p>
7321: <p>When building a package, the replacement tools are
7322: made available in a directory (as symlinks or wrapper scripts)
7323: that is early in the executable search path. Just like the buildlink
7324: system, this helps with consistent builds.</p>
7325: <p>A tool may be needed to help build a specific package. For example,
7326: perl, GNU make (gmake) or yacc may be needed.</p>
7327: <p>Also a tool may be needed, for example, because the native system's supplied
7328: tool may be inefficient for building a package with pkgsrc.
7329: For example, a package may need GNU awk, bison (instead of
7330: yacc) or a better sed.</p>
7331: <p>The tools used by a package can be listed by running
1.10 hubertf 7332: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 7333: <div class="sect1">
1.1 dsieger 7334: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7335: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7336: <p>The default set of tools used by pkgsrc is defined in
7337: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7338: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7339: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7340: These can be seen by running:
1.10 hubertf 7341: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7342: <p>If a package needs a specific program to build
7343: then the <code class="varname">USE_TOOLS</code> variable can be used
7344: to define the tools needed.</p>
7345: </div>
1.41 asau 7346: <div class="sect1">
1.1 dsieger 7347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7348: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 7349: <p>In the following examples, the :run means that it is needed at
7350: run-time (and becomes a DEPENDS).
1.1 dsieger 7351: The default is a build dependency which can be set with
7352: :build. (So in this example, it is the same as gmake:build
7353: and pkg-config:build.)</p>
7354: <pre class="programlisting">
7355: USE_TOOLS+= gmake perl:run pkg-config
7356: </pre>
7357: <p>When using the tools framework, a
7358: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7359: which contains the full path to the appropriate tool. For example,
1.23 wiz 7360: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 7361: on Linux systems.</p>
7362: <p>If you always need a pkgsrc version of the
7363: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7364: </p>
7365: </div>
1.41 asau 7366: <div class="sect1">
1.1 dsieger 7367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7368: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7369: <p>When improving or porting pkgsrc to a new platform, have a look
7370: at (or create) the corresponding platform specific make file fragment under
7371: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7372: the name of the common tools. For example:</p>
7373: <pre class="programlisting">
7374: .if exists(/usr/bin/bzcat)
7375: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7376: .elif exists(/usr/bin/bzip2)
7377: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7378: .endif
7379:
7380: TOOLS_PLATFORM.true?= true # shell builtin
7381: </pre>
7382: </div>
1.41 asau 7383: <div class="sect1">
1.1 dsieger 7384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7385: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.41 asau 7386: <div class="qandaset">
1.95 ! wiz 7387: <a name="idm76167696"></a><dl>
1.6 rillig 7388: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7389: </dt>
1.6 rillig 7390: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7391: tools?</a>
7392: </dt>
1.6 rillig 7393: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7394: package is using while being built? I want to know whether it
7395: uses sed or not.</a>
7396: </dt>
7397: </dl>
1.41 asau 7398: <table border="0" style="width: 100%;">
7399: <colgroup>
1.1 dsieger 7400: <col align="left" width="1%">
1.23 wiz 7401: <col>
1.41 asau 7402: </colgroup>
1.1 dsieger 7403: <tbody>
1.41 asau 7404: <tr class="question">
1.1 dsieger 7405: <td align="left" valign="top">
1.95 ! wiz 7406: <a name="tools.new"></a><a name="idm76167312"></a><p><b>18.4.1.</b></p>
1.1 dsieger 7407: </td>
7408: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7409: </tr>
7410: <tr class="answer">
7411: <td align="left" valign="top"></td>
7412: <td align="left" valign="top"><p>TODO</p></td>
7413: </tr>
1.41 asau 7414: <tr class="question">
1.1 dsieger 7415: <td align="left" valign="top">
1.95 ! wiz 7416: <a name="tools.listall"></a><a name="idm76166288"></a><p><b>18.4.2.</b></p>
1.1 dsieger 7417: </td>
7418: <td align="left" valign="top"><p>How do I get a list of all available
7419: tools?</p></td>
7420: </tr>
7421: <tr class="answer">
7422: <td align="left" valign="top"></td>
7423: <td align="left" valign="top"><p>TODO</p></td>
7424: </tr>
1.41 asau 7425: <tr class="question">
1.1 dsieger 7426: <td align="left" valign="top">
1.95 ! wiz 7427: <a name="tools.used"></a><a name="idm76165264"></a><p><b>18.4.3.</b></p>
1.1 dsieger 7428: </td>
7429: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7430: package is using while being built? I want to know whether it
7431: uses sed or not.</p></td>
7432: </tr>
7433: <tr class="answer">
7434: <td align="left" valign="top"></td>
7435: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7436: to do it.)</p></td>
7437: </tr>
7438: </tbody>
7439: </table>
7440: </div>
7441: </div>
7442: </div>
1.41 asau 7443: <div class="chapter">
1.1 dsieger 7444: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7445: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7446: <div class="toc">
7447: <p><b>Table of Contents</b></p>
1.94 wiz 7448: <dl class="toc">
1.6 rillig 7449: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7450: <dd><dl>
1.6 rillig 7451: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 7452: <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.6 rillig 7453: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7454: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7455: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7456: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7457: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7458: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7459: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7460: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7461: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7462: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7463: </dl></dd>
1.23 wiz 7464: <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.6 rillig 7465: <dd><dl>
7466: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7467: <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.88 tnn 7468: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 7469: </dl></dd>
1.23 wiz 7470: <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.6 rillig 7471: <dd><dl>
7472: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7473: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7474: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7475: </dl></dd>
7476: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7477: <dd><dl>
7478: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7479: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7480: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 7481: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7482: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 7483: </dl></dd>
1.23 wiz 7484: <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.6 rillig 7485: <dd><dl>
7486: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7487: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 7488: <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.6 rillig 7489: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7490: </dl></dd>
1.23 wiz 7491: <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.6 rillig 7492: <dd><dl>
7493: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7494: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7495: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7496: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7497: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7498: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7499: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7500: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7501: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 7502: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 7503: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7504: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7505: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7506: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7507: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7508: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7509: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7510: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7511: emulation</a></span></dt>
1.6 rillig 7512: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7513: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7514: </dl></dd>
1.6 rillig 7515: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7516: </dl>
7517: </div>
1.41 asau 7518: <div class="sect1">
1.1 dsieger 7519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7520: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.41 asau 7521: <div class="sect2">
1.1 dsieger 7522: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7523: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7524: <p>One appealing feature of pkgsrc is that it runs on many
7525: different platforms. As a result, it is important to ensure,
7526: where possible, that packages in pkgsrc are portable. This
7527: chapter mentions some particular details you should pay
7528: attention to while working on pkgsrc.</p>
7529: </div>
1.41 asau 7530: <div class="sect2">
1.1 dsieger 7531: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 7532: <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.1 dsieger 7533: </h3></div></div></div>
7534: <p>The pkgsrc user can configure pkgsrc by overriding several
7535: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7536: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7537: want to use those variables in the preprocessor directives of
1.79 snj 7538: <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.1 dsieger 7539: <code class="literal">.for</code>), you need to include the file
7540: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7541: loads the user preferences.</p>
7542: <p>But note that some variables may not be completely defined
7543: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7544: included, as they may contain references to variables that are
7545: not yet defined. In shell commands this is no problem, since
7546: variables are actually macros, which are only expanded when they
7547: are used. But in the preprocessor directives mentioned above and
7548: in dependency lines (of the form <code class="literal">target:
7549: dependencies</code>) the variables are expanded at load
7550: time.</p>
1.41 asau 7551: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7552: <h3 class="title">Note</h3>
7553: <p>Currently there is no exhaustive list of all
7554: variables that tells you whether they can be used at load time
7555: or only at run time, but it is in preparation.</p>
7556: </div>
7557: </div>
1.41 asau 7558: <div class="sect2">
1.1 dsieger 7559: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7560: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7561: <p>Occasionally, packages require interaction from the user,
7562: and this can be in a number of ways:</p>
1.41 asau 7563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7564: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7565: interaction such as entering username/password or accepting a
7566: license on a web page.</p></li>
1.23 wiz 7567: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7568: passwords.</p></li>
1.23 wiz 7569: <li class="listitem"><p>help to configure the package before it is built</p></li>
7570: <li class="listitem"><p>help during the build process</p></li>
7571: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7572: </ul></div>
7573: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7574: provided to notify the pkgsrc mechanism of an interactive stage
7575: which will be needed, and this should be set in the package's
7576: <code class="filename">Makefile</code>, e.g.:</p>
7577: <pre class="programlisting">
7578: INTERACTIVE_STAGE= build
7579: </pre>
7580: <p>Multiple interactive stages can be specified:</p>
7581: <pre class="programlisting">
7582: INTERACTIVE_STAGE= configure install
7583: </pre>
7584: <p>The user can then decide to skip this package by setting the
7585: <code class="varname">BATCH</code> variable.</p>
7586: </div>
1.41 asau 7587: <div class="sect2">
1.1 dsieger 7588: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7589: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7590: <p>Authors of software can choose the licence under which
7591: software can be copied. This is due to copyright law, and reasons
7592: for license choices are outside the scope of pkgsrc. The pkgsrc
7593: system recognizes that there are a number of licenses which some
7594: users may find objectionable or difficult or impossible to comply
7595: with. The Free Software Foundation has declared some licenses
7596: "Free", and the Open Source Initiative has a definition of "Open
7597: Source". The pkgsrc system, as a policy choice, does not label
7598: packages which have licenses that are Free or Open Source.
7599: However, packages without a license meeting either of those tests
7600: are labeled with a license tag denoting the license. Note that a
7601: package with no license to copy trivially does not meet either the
7602: Free or Open Source test.</p>
7603: <p>For packages which are not Free or Open Source, pkgsrc will
7604: not build the package unless the user has indicated to pkgsrc that
7605: packages with that particular license may be built. Note that
7606: this documentation avoids the term "accepted the license". The
7607: pkgsrc system is merely providing a mechanism to avoid
7608: accidentally building a package with a non-free license;
7609: judgement and responsibility remain with the user. (Installation
7610: of binary packages are not currently subject to this mechanism;
7611: this is a bug.)</p>
7612: <p>One might want to only install packages with a BSD license,
1.19 jnemeth 7613: or the GPL, and not the other. The free licenses are added to the
7614: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7615: user can override the default by setting the
7616: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7617: of "+=". The licenses accepted by default are:
7618: </p>
7619: <pre class="programlisting">
1.48 rodent 7620: apache-1.1 apache-2.0
7621: arphic-public
7622: artistic artistic-2.0
7623: boost-license
7624: cc-by-sa-v3.0
1.55 ryoon 7625: cc0-1.0-universal
1.48 rodent 7626: cddl-1.0
7627: cpl-1.0
7628: epl-v1.0
7629: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7630: gnu-gpl-v1
7631: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7632: gnu-gpl-v3 gnu-lgpl-v3
7633: ibm-public-license-1.0
7634: ipafont
7635: isc
7636: lppl-1.3c
7637: lucent
7638: miros
7639: mit
7640: mpl-1.0 mpl-1.1 mpl-2.0
7641: mplusfont
7642: ofl-v1.0 ofl-v1.1
7643: original-bsd modified-bsd 2-clause-bsd
7644: php
7645: png-license
7646: postgresql-license
7647: public-domain
7648: python-software-foundation
7649: qpl-v1.0
1.52 rodent 7650: sgi-free-software-b-v2.0
1.48 rodent 7651: sleepycat-public
7652: unlicense
7653: x11
7654: zlib
7655: zpl
1.19 jnemeth 7656: </pre>
7657: <p>
7658: </p>
1.1 dsieger 7659: <p>The license tag mechanism is intended to address
7660: copyright-related issues surrounding building, installing and
7661: using a package, and not to address redistribution issues (see
7662: <code class="varname">RESTRICTED</code> and
1.19 jnemeth 7663: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7664: Packages with redistribution restrictions should set these
7665: tags.</p>
1.1 dsieger 7666: <p>Denoting that a package may be copied according to a
7667: particular license is done by placing the license in
7668: <code class="filename">pkgsrc/licenses</code> and setting the
7669: <code class="varname">LICENSE</code> variable to a string identifying the
1.79 snj 7670: 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.1 dsieger 7671: <pre class="programlisting">
7672: LICENSE= xv-license
7673: </pre>
7674: <p>When trying to build, the user will get a notice that the
7675: package is covered by a license which has not been placed in the
7676: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7677: <pre class="programlisting">
7678: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7679: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7680: ===> To view the license, enter "/usr/bin/make show-license".
7681: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7682: ===> ACCEPTABLE_LICENSES+=xv-license
7683: *** Error code 1
7684: </pre>
1.10 hubertf 7685: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7686: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7687: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7688: convey to pkgsrc that it should not in the future fail because of
7689: that license:</p>
7690: <pre class="programlisting">
7691: ACCEPTABLE_LICENSES+=xv-license
7692: </pre>
1.48 rodent 7693: <p>When adding a package with a new license, the following steps
7694: are required:</p>
7695: <div class="orderedlist"><ol class="orderedlist" type="1">
7696: <li class="listitem">
7697: <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>
7698: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7699: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7700: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.52 rodent 7701: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.48 rodent 7702: </ul></div>
7703: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7704: </li>
7705: <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>
7706: </ol></div>
1.1 dsieger 7707: <p>When the license changes (in a way other than formatting),
7708: please make sure that the new license has a different name (e.g.,
7709: append the version number if it exists, or the date). Just
7710: because a user told pkgsrc to build programs under a previous
7711: version of a license does not mean that pkgsrc should build
7712: programs under the new licenses. The higher-level point is that
7713: pkgsrc does not evaluate licenses for reasonableness; the only
7714: test is a mechanistic test of whether a particular text has been
7715: approved by either of two bodies.</p>
7716: <p>The use of <code class="varname">LICENSE=shareware</code>,
7717: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7718: is deprecated because it does not crisply refer to a particular
7719: license text. Another problem with such usage is that it does not
7720: enable a user to tell pkgsrc to proceed for a single package
7721: without also telling pkgsrc to proceed for all packages with that
7722: tag.</p>
7723: </div>
1.41 asau 7724: <div class="sect2">
1.1 dsieger 7725: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7726: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7727: <p>Some licenses restrict how software may be re-distributed.
7728: Because a license tag is required unless the package is Free or
7729: Open Source, all packages with restrictions should have license
7730: tags. By declaring the restrictions, package tools can
7731: automatically refrain from e.g. placing binary packages on FTP
7732: sites.</p>
7733: <p>There are four restrictions that may be encoded, which are
7734: the cross product of sources (distfiles) and binaries not being
7735: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7736: language in any license, and because non-Free licenses tend to be
7737: different from each other, pkgsrc adopts a definition of FTP and
7738: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7739: should not be made available over the Internet at no charge.
7740: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7741: made available on some kind of media, together with other source
7742: and binary packages, and which is sold for a distribution charge.
7743: </p>
7744: <p>In order to encode these restrictions, the package system
7745: defines five make variables that can be set to note these
7746: restrictions:</p>
1.41 asau 7747: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7748: <li class="listitem">
1.1 dsieger 7749: <p><code class="varname">RESTRICTED</code></p>
7750: <p>This variable should be set whenever a restriction
7751: exists (regardless of its kind). Set this variable to a
7752: string containing the reason for the restriction. It should
7753: be understood that those wanting to understand the restriction
7754: will have to read the license, and perhaps seek advice of
7755: counsel.</p>
7756: </li>
1.23 wiz 7757: <li class="listitem">
1.1 dsieger 7758: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7759: <p>Binaries may not be placed on CD-ROM containing other
7760: binary packages, for which a distribution charge may be made.
7761: In this case, set this variable to
7762: <code class="varname">${RESTRICTED}</code>.</p>
7763: </li>
1.23 wiz 7764: <li class="listitem">
1.1 dsieger 7765: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7766: <p>Binaries may not made available on the Internet without
7767: charge. In this case, set this variable to
7768: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7769: binary packages will not be included on ftp.NetBSD.org.</p>
7770: </li>
1.23 wiz 7771: <li class="listitem">
1.1 dsieger 7772: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7773: <p>Distfiles may not be placed on CD-ROM, together with
7774: other distfiles, for which a fee may be charged. In this
7775: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7776: </p>
7777: </li>
1.23 wiz 7778: <li class="listitem">
1.1 dsieger 7779: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7780: <p>Distfiles may not made available via FTP at no charge.
7781: In this case, set this variable to
7782: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7783: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7784: </li>
7785: </ul></div>
1.32 wiz 7786: <p>Please note that packages will to be removed from pkgsrc
7787: when the distfiles are not distributable and cannot be obtained
7788: for a period of one full quarter branch. Packages with manual /
7789: interactive fetch must have a maintainer and it is his/her
7790: responsibility to ensure this.</p>
1.1 dsieger 7791: </div>
1.41 asau 7792: <div class="sect2">
1.1 dsieger 7793: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7794: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7795: <p>Your package may depend on some other package being present
7796: - and there are various ways of expressing this dependency.
7797: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7798: <code class="varname">DEPENDS</code> definitions, the
7799: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7800: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7801: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7802: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 7803: <p>The basic difference between the two variables is as
7804: follows: The <code class="varname">DEPENDS</code> definition registers
7805: that pre-requisite in the binary package so it will be pulled in
7806: when the binary package is later installed, whilst the
7807: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7808: dependency that is only needed for building the package.</p>
7809: <p>This means that if you only need a package present whilst
7810: you are building, it should be noted as a
7811: <code class="varname">BUILD_DEPENDS</code>.</p>
7812: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7813: <code class="varname">DEPENDS</code> definition is:</p>
7814: <pre class="programlisting">
7815: <pre-req-package-name>:../../<category>/<pre-req-package>
7816: </pre>
1.23 wiz 7817: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7818: may include any of the wildcard version numbers recognized by
1.79 snj 7819: <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.23 wiz 7820: <div class="orderedlist"><ol class="orderedlist" type="1">
7821: <li class="listitem">
1.1 dsieger 7822: <p>If your package needs another package's binaries or
1.54 wiz 7823: libraries to build and run, and if that package has a
1.1 dsieger 7824: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7825: <pre class="programlisting">
7826: .include "../../graphics/jpeg/buildlink3.mk"
7827: </pre>
7828: </li>
1.23 wiz 7829: <li class="listitem">
1.54 wiz 7830: <p>If your package needs another package's binaries or
7831: libraries only for building, and if that package has a
7832: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7833: <pre class="programlisting">
7834: .include "../../graphics/jpeg/buildlink3.mk"
7835: </pre>
7836: <p>but set
7837: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7838: to make it a build dependency only. This case is rather
7839: rare.</p>
7840: </li>
7841: <li class="listitem">
1.25 spz 7842: <p>If your package needs binaries from another package to build,
7843: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7844: <pre class="programlisting">
1.25 spz 7845: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1 dsieger 7846: </pre>
7847: </li>
1.25 spz 7848: <li class="listitem"><p>If your package needs a library with which to link and
7849: there is no <code class="filename">buildlink3.mk</code> file
7850: available, create one. Using
7851: <code class="varname">DEPENDS</code> won't be sufficient because the
7852: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7853: <li class="listitem">
1.25 spz 7854: <p>If your package needs some executable to be able to run
7855: correctly and if there's no
7856: <code class="filename">buildlink3.mk</code> file, this is specified
7857: using the <code class="varname">DEPENDS</code> variable. The
1.79 snj 7858: <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.25 spz 7859: be able to execute the latex binary from the teTeX package
7860: when it runs, and that is specified:</p>
1.1 dsieger 7861: <pre class="programlisting">
1.25 spz 7862: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.1 dsieger 7863: </pre>
1.25 spz 7864: </li>
7865: <li class="listitem">
7866: <p>You can use wildcards in package dependencies. Note that
7867: such wildcard dependencies are retained when creating binary
7868: packages. The dependency is checked when installing the binary
7869: package and any package which matches the pattern will be
7870: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7871: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7872: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7873: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7874: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7875: <p>Wildcards can also be used to specify that a package
7876: will only build against a certain minimum version of a
7877: pre-requisite:</p>
7878: <pre class="programlisting">
1.25 spz 7879: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 7880: </pre>
1.25 spz 7881: <p>This means that the package will build using version 6.0
7882: of ImageMagick or newer. Such a dependency may be warranted
7883: if, for example, the command line options of an executable
7884: have changed.</p>
7885: <p>If you need to depend on minimum versions of libraries,
7886: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7887: <p>For security fixes, please update the package
1.10 hubertf 7888: 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.1 dsieger 7889: information.</p>
7890: </li>
1.59 jnemeth 7891: <li class="listitem">
7892: <p>If the package depends on either one of two (or more)
7893: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7894: comma-separated list between curly braces.</p>
7895: <p>As an example, take a package that depends on the Perl
7896: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7897: itself since version 5.10.0. This either/or dependency is
7898: expressed as:</p>
7899: <pre class="programlisting">
7900: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7901: </pre>
7902: </li>
1.1 dsieger 7903: </ol></div>
7904: <p>If your package needs files from another package to build,
7905: add the relevant distribution files to
7906: <code class="varname">DISTFILES</code>, so they will be extracted
1.79 snj 7907: 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.1 dsieger 7908: (It relies on the jpeg sources being present in source form
7909: during the build.)</p>
7910: </div>
1.41 asau 7911: <div class="sect2">
1.1 dsieger 7912: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7913: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7914: <p>Your package may conflict with other packages a user might
7915: already have installed on his system, e.g. if your package
7916: installs the same set of files as another package in the pkgsrc
1.80 wiz 7917: tree or has the same <code class="varname">PKGNAME</code>.</p>
7918: <p>These cases are handled automatically by the packaging tools
7919: at package installation time and do not need to be handled
7920: manually.</p>
7921: <p>In case the conflicts can not be recognized automatically
7922: (e.g., packages using the same config file location but no other
7923: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7924: space-separated list of packages (including version string) your
7925: package conflicts with.</p>
1.80 wiz 7926: <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>
7927: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7928: use the same config file, you would set in
7929: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7930: <pre class="programlisting">
1.80 wiz 7931: CONFLICTS= baz-[0-9]*
1.1 dsieger 7932: </pre>
1.80 wiz 7933: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7934: <pre class="programlisting">
1.80 wiz 7935: CONFLICTS= bar-[0-9]*
1.1 dsieger 7936: </pre>
7937: </div>
1.41 asau 7938: <div class="sect2">
1.1 dsieger 7939: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7940: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7941: <p>There are several reasons why a package might be
7942: instructed to not build under certain circumstances. If the
7943: package builds and runs on most platforms, the exceptions
1.83 dholland 7944: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7945: the package builds and runs on a small handful of platforms,
7946: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7947: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7948: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7949: (OS-version-platform) that can use glob-style
7950: wildcards.</p>
7951: <p>If a package is not appropriate for some platforms (as
7952: oopposed to merely broken), a different set of variables should be
7953: used as this affects failure reporting and statistics.
7954: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7955: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7956: the package is appropriate for only a small handful of platforms
7957: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7958: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7959: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7960: (OS-version-platform) that can use glob-style
7961: wildcards.</p>
7962: <p>Some packages are tightly bound to a specific version of an
1.79 snj 7963: 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.1 dsieger 7964: backwards compatible with other versions of the OS, and should be
7965: uploaded to a version specific directory on the FTP server. Mark
7966: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7967: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7968: the package system internals, but may be used in the
7969: future.</p>
7970: <p>If the package should be skipped (for example, because it
7971: provides functionality already provided by the system), set
7972: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7973: the package should fail because some preconditions are not met,
7974: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7975: message.</p>
7976: </div>
1.41 asau 7977: <div class="sect2">
1.1 dsieger 7978: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7979: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7980: <p>To ensure that a package may not be deleted, once it has been
7981: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7982: be set in the package Makefile. This will be carried into any
7983: binary package that is made from this pkgsrc entry. A
1.23 wiz 7984: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.79 snj 7985: 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.23 wiz 7986: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7987: </div>
1.41 asau 7988: <div class="sect2">
1.1 dsieger 7989: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7990: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7991: <p>When a vulnerability is found, this should be noted in
7992: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7993: and after committing that file, ask pkgsrc-security@NetBSD.org to
7994: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7995: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7996: <code class="varname">PKGREVISION</code> should be increased (this is of
7997: course not necessary if the problem is fixed by using a newer
7998: release of the software), and the pattern in the
7999: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 8000: <p>Also, if the fix should be applied to the stable pkgsrc
8001: branch, be sure to submit a pullup request!</p>
8002: <p>Binary packages already on ftp.NetBSD.org will be handled
8003: semi-automatically by a weekly cron job.</p>
8004: </div>
1.41 asau 8005: <div class="sect2">
1.1 dsieger 8006: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8007: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 8008: <p>When making fixes to an existing package it can be useful
8009: to change the version number in <code class="varname">PKGNAME</code>. To
8010: avoid conflicting with future versions by the original author, a
1.23 wiz 8011: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 8012: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 8013: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8014: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 8015: <pre class="programlisting">
8016: DISTNAME= foo-17.42
8017: PKGREVISION= 9
8018: </pre>
8019: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 8020: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8021: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 8022: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8023: <code class="varname">PKGNAME_NOREV</code>.</p>
8024: <p>When a new release of the package is released, the
8025: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8026: minor release of the above package, things should be like:</p>
8027: <pre class="programlisting">
8028: DISTNAME= foo-17.43
8029: </pre>
8030: <p><code class="varname">PKGREVISION</code> should be incremented for any
8031: non-trivial change in the resulting binary package. Without a
8032: <code class="varname">PKGREVISION</code> bump, someone with the previous
8033: version installed has no way of knowing that their package is out
8034: of date. Thus, changes without increasing
8035: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8036: trivial that no reasonable person would want to upgrade", and this
8037: is the rough test for when increasing
8038: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8039: changes that do not merit increasing
8040: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 8041: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8042: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 8043: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 8044: or comments in Makefile.</p></li>
1.23 wiz 8045: <li class="listitem"><p>
1.1 dsieger 8046: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 8047: <li class="listitem"><p>
1.1 dsieger 8048: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 8049: <li class="listitem"><p>
1.1 dsieger 8050: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8051: </ul></div>
8052: <p>Examples of changes that do merit an increase to
8053: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8054: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8055: <li class="listitem"><p>
1.1 dsieger 8056: Security fixes</p></li>
1.23 wiz 8057: <li class="listitem"><p>
1.1 dsieger 8058: Changes or additions to a patch file</p></li>
1.23 wiz 8059: <li class="listitem"><p>
1.1 dsieger 8060: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 8061: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 8062: </ul></div>
8063: <p>PKGREVISION must also be incremented when dependencies have ABI
8064: changes.</p>
8065: </div>
1.41 asau 8066: <div class="sect2">
1.1 dsieger 8067: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8068: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1 dsieger 8069: <p>When you want to replace the same text in multiple files
8070: or when the replacement text varies, patches alone cannot help.
8071: This is where the SUBST framework comes in. It provides an
8072: easy-to-use interface for replacing text in files.
8073: Example:</p>
8074: <pre class="programlisting">
8075: SUBST_CLASSES+= fix-paths
8076: SUBST_STAGE.fix-paths= pre-configure
8077: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8078: SUBST_FILES.fix-paths= src/*.c
8079: SUBST_FILES.fix-paths+= scripts/*.sh
8080: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8081: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8082: </pre>
8083: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8084: that are used to identify the different SUBST blocks that are
8085: defined. The SUBST framework is heavily used by pkgsrc, so it is
8086: important to always use the <code class="literal">+=</code> operator with
8087: this variable. Otherwise some substitutions may be
8088: skipped.</p>
8089: <p>The remaining variables of each SUBST block are
8090: parameterized with the identifier from the first line
8091: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8092: parameters to a function call.</p>
8093: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8094: which the replacement will take place. All combinations of
8095: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8096: <code class="literal">post-</code> together with a phase name are
8097: possible, though only few are actually used. Most commonly used
8098: are <code class="literal">post-patch</code> and
8099: <code class="literal">pre-configure</code>. Of these two,
8100: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 8101: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 8102: have the state after applying the patches but before making any
8103: other changes. This is especially useful when you are debugging
8104: a package in order to create new patches for it. Similarly,
8105: <code class="literal">post-build</code> is preferred over
8106: <code class="literal">pre-install</code>, because the install phase should
8107: generally be kept as simple as possible. When you use
8108: <code class="literal">post-build</code>, you have the same files in the
8109: working directory that will be installed later, so you can check
8110: if the substitution has succeeded.</p>
8111: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8112: that is printed just before the substitution is done.</p>
8113: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8114: globbing patterns that specifies the files in which the
8115: substitution will take place. The patterns are interpreted
8116: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8117: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.79 snj 8118: <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.1 dsieger 8119: command should be prefixed with <code class="literal">-e</code>, so that
8120: all SUBST blocks look uniform.</p>
8121: <p>There are some more variables, but they are so seldomly
8122: used that they are only documented in the
8123: <code class="filename">mk/subst.mk</code> file.</p>
8124: </div>
8125: </div>
1.41 asau 8126: <div class="sect1">
1.1 dsieger 8127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8128: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8129: <div class="sect2">
1.1 dsieger 8130: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8131: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 8132: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8133: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8134: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8135: with the name of each file to download as an argument, expecting
8136: it to output the URL of the directory from which to download
1.79 snj 8137: 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.1 dsieger 8138: example of this usage.</p>
8139: <p>If the download can't be automated, because the user must
8140: submit personal information to apply for a password, or must pay
8141: for the source, or whatever, you can set
8142: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8143: displayed to the user before aborting the build. Example:</p>
8144: <pre class="programlisting">
8145: FETCH_MESSAGE= "Please download the files"
8146: FETCH_MESSAGE+= " "${DISTFILES:Q}
8147: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8148: </pre>
8149: </div>
1.41 asau 8150: <div class="sect2">
1.1 dsieger 8151: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8152: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 8153: <p>Sometimes authors of a software package make some
8154: modifications after the software was released, and they put up a
8155: new distfile without changing the package's version number. If a
8156: package is already in pkgsrc at that time, the checksum will
8157: no longer match. The contents of the new distfile should be
8158: compared against the old one before changing anything, to make
8159: sure the distfile was really updated on purpose, and that
8160: no trojan horse or so crept in.
8161: Please mention that the distfiles were compared and what was found
1.53 rodent 8162: in your commit message.</p>
8163: <p>Then, the correct way to work around this is to
1.1 dsieger 8164: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8165: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8166: <code class="varname">DISTFILES</code> and
8167: <code class="varname">PATCHFILES</code> for this package will be put in that
8168: subdirectory of the local distfiles directory.
1.10 hubertf 8169: (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.1 dsieger 8170: In case this
8171: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8172: including the <code class="filename">nbX</code> suffix) or a date stamp
1.53 rodent 8173: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8174: <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>
8175: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8176: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8177: path in the filenames.
1.53 rodent 8178: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8179: Furthermore, a mail to the package's authors seems appropriate
8180: telling them that changing distfiles after releases without
8181: changing the file names is not good practice.</p>
8182: </div>
1.88 tnn 8183: <div class="sect2">
8184: <div class="titlepage"><div><div><h3 class="title">
8185: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 8186: <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:
8187: </p>
1.88 tnn 8188: <div class="sect3">
8189: <div class="titlepage"><div><div><h4 class="title">
8190: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
8191: <p>
8192: 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.
8193: </p>
8194: <pre class="programlisting">
8195: DISTNAME= exampleproject-1.0
1.90 tnn 8196: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8197: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
8198: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8199: EXTRACT_SUFX= .zip
8200: </pre>
8201: </div>
8202: <div class="sect3">
8203: <div class="titlepage"><div><div><h4 class="title">
8204: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
8205: <p>
8206: 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.
8207: </p>
8208: <pre class="programlisting">
8209: DISTNAME= example-1.0
1.90 tnn 8210: MASTER_SITES= ${MASTER_SITE_GITHUB:example/}
8211: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
8212: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 8213: </pre>
8214: </div>
8215: <div class="sect3">
8216: <div class="titlepage"><div><div><h4 class="title">
8217: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
8218: <p>
8219: 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.
8220: </p>
8221: <pre class="programlisting">
8222: DISTNAME= offensive-1.6
1.90 tnn 8223: PKGNAME= ${DISTNAME:S/offensive/proper/}
8224: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8225: GITHUB_PROJECT= exampleproject
8226: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8227: EXTRACT_SUFX= .zip
1.88 tnn 8228: </pre>
8229: </div>
8230: </div>
1.1 dsieger 8231: </div>
1.41 asau 8232: <div class="sect1">
1.1 dsieger 8233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8234: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8235: <div class="sect2">
1.1 dsieger 8236: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8237: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8238: <p>pkgsrc supports many different machines, with different
8239: object formats like a.out and ELF, and varying abilities to do
8240: shared library and dynamic loading at all. To accompany this,
8241: varying commands and options have to be passed to the
8242: compiler, linker, etc. to get the Right Thing, which can be
8243: pretty annoying especially if you don't have all the machines
8244: at your hand to test things. The
1.79 snj 8245: <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.23 wiz 8246: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8247: both static and dynamic libraries from a set of source files,
8248: thus being platform-independent.</p>
8249: <p>Here's how to use libtool in a package in seven simple
8250: steps:</p>
1.23 wiz 8251: <div class="orderedlist"><ol class="orderedlist" type="1">
8252: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8253: Makefile.</p></li>
1.23 wiz 8254: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8255: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8256: add it to the definition of <code class="varname">CC</code>, if only
8257: libraries are being built in a given Makefile. This one command
8258: will build both PIC and non-PIC library objects, so you need not
8259: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8260: <li class="listitem">
1.1 dsieger 8261: <p>For the linking of the library, remove any
1.23 wiz 8262: <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
8263: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8264: <pre class="programlisting">
8265: ${LIBTOOL} --mode=link \
8266: ${CC} -o ${.TARGET:.a=.la} \
8267: ${OBJS:.o=.lo} \
8268: -rpath ${PREFIX}/lib \
8269: -version-info major:minor
8270: </pre>
8271: <p>Note that the library is changed to have a
8272: <code class="filename">.la</code> extension, and the objects are
8273: changed to have a <code class="filename">.lo</code>
8274: extension. Change <code class="varname">OBJS</code> as
8275: necessary. This automatically creates all of the
8276: <code class="filename">.a</code>,
8277: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8278: necessary) in the build directory. Be sure to include
1.23 wiz 8279: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8280: minor are zero, as libtool will otherwise strip off the
8281: shared library version.</p>
8282: <p>From the libtool manual:</p>
8283: <pre class="programlisting">
8284: So, libtool library versions are described by three integers:
8285:
8286: CURRENT
8287: The most recent interface number that this library implements.
8288:
8289: REVISION
8290: The implementation number of the CURRENT interface.
8291:
8292: AGE
8293: The difference between the newest and oldest interfaces that
8294: this library implements. In other words, the library implements
8295: all the interface numbers in the range from number `CURRENT -
8296: AGE' to `CURRENT'.
8297:
8298: If two libraries have identical CURRENT and AGE numbers, then the
8299: dynamic linker chooses the library with the greater REVISION number.
8300: </pre>
1.23 wiz 8301: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8302: different results for a.out and ELF (excluding symlinks)
8303: in only one case. An ELF library of the form
1.23 wiz 8304: <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.1 dsieger 8305: will have a symlink of
1.23 wiz 8306: <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.1 dsieger 8307: on an a.out platform. This is handled
8308: automatically.</p>
1.23 wiz 8309: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8310: directory of the library being built.</p>
8311: <p>In the <code class="filename">PLIST</code>, include only the
8312: <code class="filename">.la</code> file, the other files will be
8313: added automatically.</p>
8314: </li>
1.23 wiz 8315: <li class="listitem">
1.1 dsieger 8316: <p>When linking shared object (<code class="filename">.so</code>)
1.79 snj 8317: 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.23 wiz 8318: shared libraries, use <span class="quote">“<span class="quote">-module
8319: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8320: tacked on.</p>
8321: <p>The <code class="filename">PLIST</code> file gets the
8322: <code class="filename">foo.so</code> entry.</p>
8323: </li>
1.23 wiz 8324: <li class="listitem">
1.1 dsieger 8325: <p>When linking programs that depend on these libraries
8326: <span class="emphasis"><em>before</em></span> they are installed, preface
1.79 snj 8327: 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.23 wiz 8328: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8329: libraries (static or shared), but please be aware that
8330: libtool will not allow you to specify a relative path in
1.23 wiz 8331: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8332: expects you to change that argument to be the
8333: <code class="filename">.la</code> file. e.g.</p>
8334: <pre class="programlisting">
8335: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8336: </pre>
8337: <p>should be changed to:</p>
8338: <pre class="programlisting">
8339: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8340: </pre>
8341: <p>and it will do the right thing with the libraries.</p>
8342: </li>
1.23 wiz 8343: <li class="listitem">
1.79 snj 8344: <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>
8345: 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.23 wiz 8346: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8347: <code class="filename">.la</code>. e.g.</p>
8348: <pre class="programlisting">
1.22 jakllsch 8349: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 8350: </pre>
8351: <p>This will install the static <code class="filename">.a</code>,
8352: shared library, any needed symlinks, and run
1.79 snj 8353: <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.1 dsieger 8354: </li>
1.23 wiz 8355: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8356: the <code class="filename">.la</code>
8357: file (this is a change from previous behaviour).</p></li>
8358: </ol></div>
8359: </div>
1.41 asau 8360: <div class="sect2">
1.1 dsieger 8361: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8362: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8363: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8364: package Makefile. This will override the package's own libtool
8365: in most cases. For older libtool using packages, libtool is
8366: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8367: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8368: configure; find work*/ -name libtool</strong></span>.</p>
8369: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8370: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8371: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8372: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8373: package's libtool script(s), set it as appropriate.</p>
8374: <p>If you do not need <code class="filename">*.a</code> static
8375: libraries built and installed, then use
8376: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8377: <p>If your package makes use of the platform-independent library
8378: for loading dynamic shared objects, that comes with libtool
8379: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8380: <p>Some packages use libtool incorrectly so that the package
8381: may not work or build in some circumstances. Some of the more
8382: common errors are:</p>
1.41 asau 8383: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8384: <li class="listitem">
1.1 dsieger 8385: <p>The inclusion of a shared object (-module) as a dependent library in an
8386: executable or library. This in itself isn't a problem if one of two things
8387: has been done:</p>
1.23 wiz 8388: <div class="orderedlist"><ol class="orderedlist" type="1">
8389: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8390: <code class="filename">libfoo.la</code>, not
8391: <code class="filename">foo.la</code></p></li>
1.23 wiz 8392: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8393: </ol></div>
8394: </li>
1.23 wiz 8395: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8396: The function lt_dlinit() should be called and the macro
8397: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8398: executables.</p></li>
8399: </ul></div>
8400: </div>
1.41 asau 8401: <div class="sect2">
1.1 dsieger 8402: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8403: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8404: <p>If a package needs GNU autoconf or automake to be executed
8405: to regenerate the configure script and Makefile.in makefile
8406: templates, then they should be executed in a pre-configure
8407: target.</p>
8408: <p>For packages that need only autoconf:</p>
8409: <pre class="programlisting">
8410: AUTOCONF_REQD= 2.50 # if default version is not good enough
8411: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8412: ...
8413:
8414: pre-configure:
8415: cd ${WRKSRC} && autoconf
8416:
8417: ...
8418: </pre>
8419: <p>and for packages that need automake and autoconf:</p>
8420: <pre class="programlisting">
8421: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8422: USE_TOOLS+= automake # use "automake14" for automake-1.4
8423: ...
8424:
8425: pre-configure:
8426: set -e; cd ${WRKSRC}; \
8427: aclocal; autoheader; automake -a --foreign -i; autoconf
8428:
8429: ...
8430: </pre>
8431: <p>Packages which use GNU Automake will almost certainly
8432: require GNU Make.</p>
8433: <p>There are times when the configure process makes
8434: additional changes to the generated files, which then causes
8435: the build process to try to re-execute the automake sequence.
8436: This is prevented by touching various files in the configure
8437: stage. If this causes problems with your package you can set
8438: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8439: Makefile.</p>
8440: </div>
8441: </div>
1.41 asau 8442: <div class="sect1">
1.1 dsieger 8443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8444: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 8445: <div class="sect2">
1.1 dsieger 8446: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8447: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8448: <p>Compilers for the C, C++, and Fortran languages comes with
8449: the NetBSD base system. By default, pkgsrc assumes that a package
8450: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 8451: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8452: <p>To declare which language's compiler a package needs, set
8453: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8454: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8455: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8456: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8457: written in C++, usually need a C compiler for the configure
8458: phase.</p>
8459: </div>
1.41 asau 8460: <div class="sect2">
1.1 dsieger 8461: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8462: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8463: <p>If a program is written in Java, use the Java framework in
8464: pkgsrc. The package must include
8465: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8466: provides the following variables:</p>
1.41 asau 8467: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8468: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8469: dependency on the JDK is added. If
1.23 wiz 8470: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8471: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8472: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8473: JDK.</p></li>
1.23 wiz 8474: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8475: a package needs a Java2 implementation. The supported values
1.23 wiz 8476: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8477: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8478: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8479: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8480: above. This variable is not set by default.</p></li>
1.24 wiz 8481: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8482: automatically set to the runtime location of the used Java
8483: implementation dependency. It may be used to set
8484: <code class="varname">JAVA_HOME</code> to a good value if the program
8485: needs this variable to be defined.
8486: </p></li>
1.1 dsieger 8487: </ul></div>
8488: </div>
1.41 asau 8489: <div class="sect2">
1.1 dsieger 8490: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8491: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8492: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8493: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8494: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8495: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8496: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8497: that you want adjusted. Every occurrence of
8498: <code class="filename">*/bin/perl</code> in a she-bang line will be
8499: replaced with the full path to the perl executable.</p>
1.1 dsieger 8500: <p>If a particular version of perl is needed, set the
8501: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8502: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 8503: <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.1 dsieger 8504: about handling perl modules.</p>
8505: </div>
1.41 asau 8506: <div class="sect2">
1.1 dsieger 8507: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 8508: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8509: <p><code class="varname">REPLACE_SH</code>,
8510: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8511: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8512: hash bangs in files. Please use the appropriate one, prefering
8513: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 8514: Each should contain a list of scripts, relative to
8515: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8516: occurrence of the matching shell in a she-bang line will be
8517: replaced with the full path to the shell executable.
1.40 wiz 8518: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8519: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8520: </div>
1.41 asau 8521: <div class="sect2">
1.40 wiz 8522: <div class="titlepage"><div><div><h3 class="title">
8523: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8524: <p>Currently, there is no special handling for other languages
8525: in pkgsrc. If a compiler package provides a
8526: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8527: just add a (build) dependency on the appropriate compiler
8528: package.</p>
8529: </div>
8530: </div>
1.41 asau 8531: <div class="sect1">
1.1 dsieger 8532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8533: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8534: <p>The most common failures when building a package are that
8535: some platforms do not provide certain header files, functions or
8536: libraries, or they provide the functions in a library that the
8537: original package author didn't know. To work around this, you
8538: can rewrite the source code in most cases so that it does not
8539: use the missing functions or provides a replacement function.</p>
1.41 asau 8540: <div class="sect2">
1.1 dsieger 8541: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8542: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8543: <p>If a package already comes with a GNU configure script, the
8544: preferred way to fix the build failure is to change the
8545: configure script, not the code. In the other cases, you can
8546: utilize the C preprocessor, which defines certain macros
8547: depending on the operating system and hardware architecture it
8548: compiles for. These macros can be queried using for example
8549: <code class="varname">#if defined(__i386)</code>. Almost every operating
8550: system, hardware architecture and compiler has its own macro.
8551: For example, if the macros <code class="varname">__GNUC__</code>,
8552: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8553: are all defined, you know that you are using NetBSD on an i386
8554: compatible CPU, and your compiler is GCC.</p>
8555: <p>The list of the following macros for hardware and
8556: operating system depends on the compiler that is used. For
8557: example, if you want to conditionally compile code on Solaris,
8558: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8559: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8560: <div class="sect3">
1.1 dsieger 8561: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8562: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 8563: <p>To distinguish between 4.4 BSD-derived systems and the
8564: rest of the world, you should use the following code.</p>
8565: <pre class="programlisting">
8566: #include <sys/param.h>
8567: #if (defined(BSD) && BSD >= 199306)
8568: /* BSD-specific code goes here */
8569: #else
8570: /* non-BSD-specific code goes here */
8571: #endif
8572: </pre>
8573: <p>If this distinction is not fine enough, you can also test
8574: for the following macros.</p>
8575: <pre class="programlisting">
1.45 obache 8576: Cygwin __CYGWIN__
8577: DragonFly __DragonFly__
1.1 dsieger 8578: FreeBSD __FreeBSD__
1.45 obache 8579: Haiku __HAIKU__
1.1 dsieger 8580: Interix __INTERIX
8581: IRIX __sgi (TODO: get a definite source for this)
8582: Linux linux, __linux, __linux__
1.83 dholland 8583: Mac OS X __APPLE__
1.45 obache 8584: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8585: Minix3 __minix
1.1 dsieger 8586: NetBSD __NetBSD__
8587: OpenBSD __OpenBSD__
8588: Solaris sun, __sun
8589: </pre>
8590: </div>
1.41 asau 8591: <div class="sect3">
1.1 dsieger 8592: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8593: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8594: <pre class="programlisting">
8595: i386 i386, __i386, __i386__
8596: MIPS __mips
8597: SPARC sparc, __sparc
8598: </pre>
8599: </div>
1.41 asau 8600: <div class="sect3">
1.1 dsieger 8601: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8602: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8603: <pre class="programlisting">
8604: GCC __GNUC__ (major version), __GNUC_MINOR__
8605: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8606: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8607: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8608: </pre>
8609: </div>
8610: </div>
1.41 asau 8611: <div class="sect2">
1.1 dsieger 8612: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8613: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8614: <p>Some source files trigger bugs in the compiler, based on
8615: combinations of compiler version and architecture and almost
8616: always relation to optimisation being enabled. Common symptoms
8617: are gcc internal errors or never finishing compiling a
8618: file.</p>
8619: <p>Typically, a workaround involves testing the
8620: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8621: optimisation for that combination of file,
1.87 tnn 8622: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8623: <p>This used to be a big problem in the past, but is rarely
8624: needed now as compiler technology has matured. If you still need
8625: to add a compiler specific workaround, please do so in the file
8626: <code class="filename">hacks.mk</code> and describe the symptom and
8627: compiler version as detailed as possible.</p>
1.1 dsieger 8628: </div>
1.41 asau 8629: <div class="sect2">
1.1 dsieger 8630: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 8631: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8632: </h3></div></div></div>
1.1 dsieger 8633: <p>This error message often means that a package did not
8634: link to a shared library it needs. The following functions are
8635: known to cause this error message over and over.</p>
8636: <div class="informaltable">
8637: <a name="undefined-reference-functions"></a><table border="1">
8638: <colgroup>
8639: <col>
8640: <col>
8641: <col>
8642: </colgroup>
8643: <thead><tr>
8644: <th>Function</th>
8645: <th>Library</th>
8646: <th>Affected platforms</th>
8647: </tr></thead>
8648: <tbody>
8649: <tr>
8650: <td>accept, bind, connect</td>
8651: <td>-lsocket</td>
8652: <td>Solaris</td>
8653: </tr>
8654: <tr>
8655: <td>crypt</td>
8656: <td>-lcrypt</td>
8657: <td>DragonFly, NetBSD</td>
8658: </tr>
8659: <tr>
8660: <td>dlopen, dlsym</td>
8661: <td>-ldl</td>
8662: <td>Linux</td>
8663: </tr>
8664: <tr>
8665: <td>gethost*</td>
8666: <td>-lnsl</td>
8667: <td>Solaris</td>
8668: </tr>
8669: <tr>
8670: <td>inet_aton</td>
8671: <td>-lresolv</td>
8672: <td>Solaris</td>
8673: </tr>
8674: <tr>
8675: <td>nanosleep, sem_*, timer_*</td>
8676: <td>-lrt</td>
8677: <td>Solaris</td>
8678: </tr>
8679: <tr>
8680: <td>openpty</td>
8681: <td>-lutil</td>
8682: <td>Linux</td>
8683: </tr>
8684: </tbody>
8685: </table>
8686: </div>
8687: <p>To fix these linker errors, it is often sufficient to say
8688: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8689: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8690: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8691: bmake</strong></span>.</p>
1.41 asau 8692: <div class="sect3">
1.1 dsieger 8693: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8694: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8695: <p>When you are using the SunPro compiler, there is another
8696: possibility. That compiler cannot handle the following code:</p>
8697: <pre class="programlisting">
8698: extern int extern_func(int);
8699:
8700: static inline int
8701: inline_func(int x)
8702: {
8703: return extern_func(x);
8704: }
8705:
8706: int main(void)
8707: {
8708: return 0;
8709: }
8710: </pre>
8711: <p>It generates the code for <code class="function">inline_func</code> even if
8712: that function is never used. This code then refers to
8713: <code class="function">extern_func</code>, which can usually not be resolved. To
8714: solve this problem you can try to tell the package to disable inlining
8715: of functions.</p>
8716: </div>
8717: </div>
1.41 asau 8718: <div class="sect2">
1.1 dsieger 8719: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8720: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8721: <p>Sometimes packages fail to build because the compiler runs
8722: into an operating system specific soft limit. With the
8723: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8724: to unlimit the resources. Currently, the allowed values are any combination of
8725: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8726: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8727: Setting this variable is similar to running the shell builtin
1.10 hubertf 8728: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8729: segment size or maximum stack size of a process, respectively, to
8730: their hard limits.</p>
8731: </div>
8732: </div>
1.41 asau 8733: <div class="sect1">
1.1 dsieger 8734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8735: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8736: <div class="sect2">
1.1 dsieger 8737: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8738: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8739: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8740: with some operating systems cannot create more than one
8741: directory at a time. As such, you should call
8742: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8743: <pre class="programlisting">
8744: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8745: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8746: </pre>
1.23 wiz 8747: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8748: dir2</code></span>”</span> to the
1.1 dsieger 8749: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8750: automatically do the right thing.</p>
8751: </div>
1.41 asau 8752: <div class="sect2">
1.1 dsieger 8753: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8754: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8755: <p>In general, documentation should be installed into
8756: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8757: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8758: includes the version number of the package).</p>
8759: <p>Many modern packages using GNU autoconf allow to set the
8760: directory where HTML documentation is installed with the
1.23 wiz 8761: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8762: is needed because otherwise the documentation ends up in
8763: <code class="filename">${PREFIX}/share/doc/html</code> or other
8764: places.</p>
8765: <p>An exception to the above is that library API documentation
1.79 snj 8766: 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.1 dsieger 8767: browsers (devhelp) should be left at their default location, which
8768: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8769: documentation can be recognized from files ending in
8770: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8771: (It is also acceptable to install such files in
8772: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8773: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8774: <code class="filename">.devhelp*</code> file must be directly in that
8775: directory then, no additional subdirectory level is allowed in
8776: this case. This is usually achieved by using
1.23 wiz 8777: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8778: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8779: though.)</p>
8780: </div>
1.41 asau 8781: <div class="sect2">
1.1 dsieger 8782: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8783: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8784: <p>Certain packages, most of them in the games category, install
8785: a score file that allows all users on the system to record their
8786: highscores. In order for this to work, the binaries need to be
8787: installed setgid and the score files owned by the appropriate
1.35 wiz 8788: group and/or owner (traditionally the "games" user/group). Set
8789: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8790: following variables, documented in more detail in
8791: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8792: behaviour: <code class="varname">GAMEDATAMODE</code>,
8793: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8794: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.14 jmcneill 8795: <p>A package should therefore never hard code file ownership or
1.1 dsieger 8796: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8797: <code class="varname">INSTALL_GAME_DATA</code> to set these
8798: correctly.</p>
8799: </div>
1.41 asau 8800: <div class="sect2">
1.1 dsieger 8801: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8802: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8803: <p><code class="varname">DESTDIR</code> support means that a package
8804: installs into a staging directory, not the final location of the
8805: files. Then a binary package is created which can be used for
8806: installation as usual. There are two ways: Either the package must
1.23 wiz 8807: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8808: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8809: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8810: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 8811: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8812: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8813: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8814: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8815: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8816: the inclusion.</p></li>
1.23 wiz 8817: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8818: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8819: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8820: automatically. Many manual rules and pre/post-install often are
8821: incorrect; fix them.</p></li>
1.23 wiz 8822: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8823: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8824: <li class="listitem"><p>In general, packages should support
1.4 rillig 8825: <code class="varname">UNPRIVILEGED</code> to be able to use
8826: DESTDIR.</p></li>
8827: </ul></div>
8828: </div>
1.41 asau 8829: <div class="sect2">
1.4 rillig 8830: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8831: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8832: <p>Your package may also contain scripts with hardcoded paths to
8833: other interpreters besides (or as well as) perl. To correct the
8834: full pathname to the script interpreter, you need to set the
8835: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8836: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8837: <pre class="programlisting">
8838: REPLACE_INTERPRETER+= tcl
8839: REPLACE.tcl.old= .*/bin/tclsh
8840: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8841: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8842: # relative to ${WRKSRC}, just as in REPLACE_PERL
8843: </pre>
1.41 asau 8844: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8845: <h3 class="title">Note</h3>
8846: <p>Before March 2006, these variables were called
8847: <code class="varname">_REPLACE.*</code> and
8848: <code class="varname">_REPLACE_FILES.*</code>.</p>
8849: </div>
8850: </div>
1.41 asau 8851: <div class="sect2">
1.1 dsieger 8852: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8853: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8854: <p>Makefiles of packages providing perl5 modules should include
8855: the Makefile fragment
8856: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8857: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8858: configuration for such modules as well as various hooks to tune
8859: this configuration. See comments in this file for
8860: details.</p>
8861: <p>Perl5 modules will install into different places depending
8862: on the version of perl used during the build process. To
8863: address this, pkgsrc will append lines to the
8864: <code class="filename">PLIST</code> corresponding to the files listed in
8865: the installed <code class="filename">.packlist</code> file generated by
8866: most perl5 modules. This is invoked by defining
8867: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8868: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8869: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8870: e.g.:</p>
1.1 dsieger 8871: <pre class="programlisting">
1.47 wiz 8872: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 8873: </pre>
1.47 wiz 8874: <p>The perl5 config variables
8875: <code class="varname">installarchlib</code>,
8876: <code class="varname">installscript</code>,
8877: <code class="varname">installvendorbin</code>,
8878: <code class="varname">installvendorscript</code>,
8879: <code class="varname">installvendorarch</code>,
8880: <code class="varname">installvendorlib</code>,
8881: <code class="varname">installvendorman1dir</code>, and
8882: <code class="varname">installvendorman3dir</code> represent those
8883: locations in which components of perl5 modules may be installed,
8884: provided as variable with uppercase and prefixed with
8885: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8886: and may be used by perl5 packages that don't have a packlist.
8887: These variables are also substituted for in the
8888: <code class="filename">PLIST</code> as uppercase prefixed with
8889: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8890: </div>
1.41 asau 8891: <div class="sect2">
1.1 dsieger 8892: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8893: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8894: <p>Some packages install info files or use the
1.23 wiz 8895: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8896: commands. <code class="varname">INFO_FILES</code> should be defined in
8897: the package Makefile so that <code class="filename">INSTALL</code> and
8898: <code class="filename">DEINSTALL</code> scripts will be generated to
8899: handle registration of the info files in the Info directory
1.23 wiz 8900: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8901: files registration is either provided by the system, or by a
8902: special purpose package automatically added as dependency if
8903: needed.</p>
8904: <p><code class="varname">PKGINFODIR</code> is the directory under
8905: <code class="filename">${PREFIX}</code> where info files are primarily
8906: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8907: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8908: <p>The info files for the package should be listed in the
8909: package <code class="filename">PLIST</code>; however any split info files
8910: need not be listed.</p>
1.23 wiz 8911: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8912: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8913: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8914: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8915: should be noted with the <code class="varname">TEXINFO_REQD</code>
8916: variable in the package <code class="filename">Makefile</code>. By
8917: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8918: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8919: does not match the required minimum, a build dependency on the
1.79 snj 8920: <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.1 dsieger 8921: be added automatically.</p>
8922: <p>The build and installation process of the software provided
8923: by the package should not use the
1.10 hubertf 8924: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8925: info files is the task of the package
8926: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8927: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8928: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8929: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8930: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8931: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8932: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8933: no effect except the logging of a message. The script overriding
1.10 hubertf 8934: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8935: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8936: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8937: </div>
1.41 asau 8938: <div class="sect2">
1.1 dsieger 8939: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8940: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8941: <p>All packages that install manual pages should install them
8942: into the same directory, so that there is one common place to look
8943: for them. In pkgsrc, this place is
8944: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8945: should be used in packages. The default for
8946: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8947: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8948: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8949: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8950: <h3 class="title">Note</h3>
8951: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8952: is far from complete.</p>
8953: </div>
8954: <p>The <code class="filename">PLIST</code> files can just use
8955: <code class="filename">man/</code> as the top level directory for the man
8956: page file entries, and the pkgsrc framework will convert as
8957: needed. In all other places, the correct
8958: <code class="varname">PKGMANDIR</code> must be used.</p>
8959: <p>Packages that are
8960: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8961: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8962: <code class="filename">./configure</code>
8963: --mandir switch to set where the man pages should be installed.
8964: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8965: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8966: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8967: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8968: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8969: Or if the <code class="filename">./configure</code> script uses
8970: a non-standard use of --mandir, you can set
8971: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8972: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.1 dsieger 8973: information on installation of compressed manual pages.</p>
8974: </div>
1.41 asau 8975: <div class="sect2">
1.1 dsieger 8976: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8977: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8978: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8979: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8980: you need to take some extra steps to make sure they get registered
8981: in the database:</p>
1.23 wiz 8982: <div class="orderedlist"><ol class="orderedlist" type="1">
8983: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8984: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8985: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8986: deinstallation time, and tells the package where to install
1.7 rillig 8987: GConf data files using some standard configure arguments. It
1.1 dsieger 8988: also disallows any access to the database directly from the
8989: package.</p></li>
1.23 wiz 8990: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8991: <code class="filename">.schemas</code> files under
8992: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8993: installed under <code class="filename">${PREFIX}/etc</code>, you will
8994: need to manually patch the package.</p></li>
1.23 wiz 8995: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8996: directory, as they will be handled automatically. See
1.84 wiz 8997: <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.23 wiz 8998: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8999: your <code class="filename">Makefile</code> with a list of all
9000: <code class="filename">.schemas</code> files installed by the package, if
9001: any. Names must not contain any directories in them.</p></li>
1.23 wiz 9002: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 9003: your <code class="filename">Makefile</code> with a
9004: list of all <code class="filename">.entries</code> files installed by the
9005: package, if any. Names must not contain any directories in
9006: them.</p></li>
9007: </ol></div>
9008: </div>
1.41 asau 9009: <div class="sect2">
1.1 dsieger 9010: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 9011: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 9012: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 9013: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 9014: get registered in the database:</p>
1.23 wiz 9015: <div class="orderedlist"><ol class="orderedlist" type="1">
9016: <li class="listitem"><p>Include
1.18 snj 9017: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9018: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 9019: takes care of rebuilding the scrollkeeper database at
9020: installation and deinstallation time, and disallows any access
9021: to it directly from the package.</p></li>
1.23 wiz 9022: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9023: <code class="filename">libdata/scrollkeeper</code> directory, as they
9024: will be handled automatically.</p></li>
1.23 wiz 9025: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 9026: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9027: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 9028: </ol></div>
9029: </div>
1.41 asau 9030: <div class="sect2">
1.1 dsieger 9031: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9032: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9033: <p>If a package installs font files, you will need to rebuild
9034: the fonts database in the directory where they get installed at
9035: installation and deinstallation time. This can be automatically
9036: done by using the pkginstall framework.</p>
9037: <p>You can list the directories where fonts are installed in the
9038: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9039: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9040: <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.1 dsieger 9041: Also make sure that the database file
9042: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9043: <p>Note that you should not create new directories for fonts;
9044: instead use the standard ones to avoid that the user needs to
9045: manually configure his X server to find them.</p>
9046: </div>
1.41 asau 9047: <div class="sect2">
1.1 dsieger 9048: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9049: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 9050: <p>If a package installs GTK2 immodules or loaders, you need to
9051: take some extra steps to get them registered in the GTK2 database
9052: properly:</p>
1.23 wiz 9053: <div class="orderedlist"><ol class="orderedlist" type="1">
9054: <li class="listitem"><p>Include
1.1 dsieger 9055: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9056: <code class="filename">buildlink3.mk</code> file. This takes care of
9057: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 9058: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 9059: your package installs GTK2 immodules.</p></li>
1.23 wiz 9060: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 9061: GTK2 loaders.</p></li>
1.23 wiz 9062: <li class="listitem">
1.1 dsieger 9063: <p>Patch the package to not touch any of the GTK2
9064: databases directly. These are:</p>
1.41 asau 9065: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9066: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9067: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 9068: </ul></div>
9069: </li>
1.23 wiz 9070: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 9071: any entries under the <code class="filename">libdata/gtk-2.0</code>
9072: directory, as they will be handled automatically.</p></li>
9073: </ol></div>
9074: </div>
1.41 asau 9075: <div class="sect2">
1.1 dsieger 9076: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9077: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9078: <p>If a package installs SGML or XML data files that need to be
9079: registered in system-wide catalogs (like DTDs, sub-catalogs,
9080: etc.), you need to take some extra steps:</p>
1.23 wiz 9081: <div class="orderedlist"><ol class="orderedlist" type="1">
9082: <li class="listitem"><p>Include
1.1 dsieger 9083: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9084: your <code class="filename">Makefile</code>, which takes care of
9085: registering those files in system-wide catalogs at
9086: installation and deinstallation time.</p></li>
1.23 wiz 9087: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9088: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9089: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9090: any XML catalogs installed by the package.</p></li>
1.23 wiz 9091: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9092: to be added to the SGML catalog. These come in groups of
9093: three strings; see xmlcatmgr(1) for more information
9094: (specifically, arguments recognized by the 'add' action).
9095: Note that you will normally not use this variable.</p></li>
1.23 wiz 9096: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9097: to be added to the XML catalog. These come in groups of three
9098: strings; see xmlcatmgr(1) for more information (specifically,
9099: arguments recognized by the 'add' action). Note that you will
9100: normally not use this variable.</p></li>
9101: </ol></div>
9102: </div>
1.41 asau 9103: <div class="sect2">
1.1 dsieger 9104: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9105: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9106: <p>If a package provides extensions to the MIME database by
9107: installing <code class="filename">.xml</code> files inside
9108: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9109: need to take some extra steps to ensure that the database is kept
9110: consistent with respect to these new files:</p>
1.23 wiz 9111: <div class="orderedlist"><ol class="orderedlist" type="1">
9112: <li class="listitem"><p>Include
1.1 dsieger 9113: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9114: (avoid using the <code class="filename">buildlink3.mk</code> file from
9115: this same directory, which is reserved for inclusion from
9116: other <code class="filename">buildlink3.mk</code> files). It takes
9117: care of rebuilding the MIME database at installation and
9118: deinstallation time, and disallows any access to it directly
9119: from the package.</p></li>
1.23 wiz 9120: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9121: <code class="filename">share/mime</code> directory,
9122: <span class="emphasis"><em>except</em></span> for files saved under
9123: <code class="filename">share/mime/packages</code>. The former are
9124: handled automatically by
9125: the update-mime-database program, but the latter are
9126: package-dependent and must be removed by the package that
9127: installed them in the first place.</p></li>
1.23 wiz 9128: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9129: from the PLIST. They will be handled by the shared-mime-info
9130: package.</p></li>
9131: </ol></div>
9132: </div>
1.41 asau 9133: <div class="sect2">
1.1 dsieger 9134: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9135: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9136: <p>If a package uses intltool during its build, add
9137: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9138: which forces it to use the intltool package provided by pkgsrc,
9139: instead of the one bundled with the distribution file.</p>
9140: <p>This tracks intltool's build-time dependencies and uses the
9141: latest available version; this way, the package benefits of any
9142: bug fixes that may have appeared since it was released.</p>
9143: </div>
1.41 asau 9144: <div class="sect2">
1.1 dsieger 9145: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9146: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9147: <p>If a package contains a rc.d script, it won't be copied into
9148: the startup directory by default, but you can enable it, by adding
9149: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9150: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9151: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9152: it will automatically remove the scripts when the package is
9153: deinstalled.</p>
9154: </div>
1.41 asau 9155: <div class="sect2">
1.1 dsieger 9156: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9157: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9158: <p>If a package installs TeX packages into the texmf tree,
9159: the <code class="filename">ls-R</code> database of the tree needs to be
9160: updated.</p>
1.41 asau 9161: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9162: <h3 class="title">Note</h3>
1.22 jakllsch 9163: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9164: packages should install files
1.22 jakllsch 9165: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9166: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9167: </div>
1.23 wiz 9168: <div class="orderedlist"><ol class="orderedlist" type="1">
9169: <li class="listitem"><p>Include
1.22 jakllsch 9170: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9171: takes care of rebuilding the <code class="filename">ls-R</code>
9172: database at installation and deinstallation time.</p></li>
1.23 wiz 9173: <li class="listitem">
1.1 dsieger 9174: <p>If your package installs files into a texmf
9175: tree other than the one
1.22 jakllsch 9176: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9177: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9178: trees that need database update.</p>
9179: <p>If your package also installs font map files that need
1.10 hubertf 9180: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9181: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9182: set <code class="varname">TEX_MAP_FILES</code> and/or
9183: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9184: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9185: be run automatically at installation/deinstallation to
9186: enable/disable font map files for TeX output
9187: drivers.</p>
9188: </li>
1.23 wiz 9189: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9190: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9191: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9192: </ol></div>
9193: </div>
1.41 asau 9194: <div class="sect2">
1.1 dsieger 9195: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9196: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9197: emulation</h3></div></div></div>
9198: <p>There are some packages that provide libraries and
9199: executables for running binaries from a one operating system
9200: on a different one (if the latter supports it). One example
9201: is running Linux binaries on NetBSD.</p>
1.79 snj 9202: <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.1 dsieger 9203: helps in extracting and packaging Linux rpm packages.</p>
9204: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9205: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9206: if all libraries for each installed executable can be found by
9207: the dynamic linker. Since the standard dynamic linker is run,
9208: this fails for emulation packages, because the libraries used
9209: by the emulation are not in the standard directories.</p>
9210: </div>
1.41 asau 9211: <div class="sect2">
1.1 dsieger 9212: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9213: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9214: <p>If a package installs images under the
9215: <code class="filename">share/icons/hicolor</code> and/or updates the
9216: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9217: database, you need to take some extra steps to make sure that the
9218: shared theme directory is handled appropriately and that the cache
9219: database is rebuilt:</p>
1.23 wiz 9220: <div class="orderedlist"><ol class="orderedlist" type="1">
9221: <li class="listitem"><p>Include
1.1 dsieger 9222: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 9223: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 9224: entry that refers to the theme cache.</p></li>
1.23 wiz 9225: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 9226: directories from the <code class="filename">share/icons/hicolor</code>
9227: hierarchy because they will be handled automatically.</p></li>
9228: </ol></div>
9229: <p>The best way to verify that the PLIST is correct with
9230: respect to the last two points is to regenerate it using
1.10 hubertf 9231: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9232: </div>
1.41 asau 9233: <div class="sect2">
1.1 dsieger 9234: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9235: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9236: <p>If a package installs <code class="filename">.desktop</code> files
9237: under <code class="filename">share/applications</code> and these include
1.53 rodent 9238: MIME information (MimeType key), you need to take extra steps to
9239: ensure that they are registered into the MIME database:</p>
1.23 wiz 9240: <div class="orderedlist"><ol class="orderedlist" type="1">
9241: <li class="listitem"><p>Include
1.1 dsieger 9242: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 9243: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 9244: <code class="filename">share/applications/mimeinfo.cache</code> file.
9245: It will be handled automatically.</p></li>
9246: </ol></div>
9247: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9248: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9249: print-PLIST</strong></span>.</p>
9250: </div>
9251: </div>
1.41 asau 9252: <div class="sect1">
1.1 dsieger 9253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9254: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9255: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 9256: immediately. In this case, one can plainly mark a package as broken. For
9257: this, one just sets the variable <code class="varname">BROKEN</code> to the
9258: reason why the package is broken (similar to the
9259: <code class="varname">RESTRICTED</code> variable). A user trying to build
9260: the package will immediately be shown this message, and the build
9261: will not be even tried.</p>
9262: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 9263: intervals.</p>
9264: </div>
9265: </div>
1.41 asau 9266: <div class="chapter">
1.1 dsieger 9267: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9268: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9269: <p>To check out all the gotchas when building a package, here are
9270: the steps that I do in order to get a package working. Please note
9271: this is basically the same as what was explained in the previous
9272: sections, only with some debugging aids.</p>
1.41 asau 9273: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9274: <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>
9275: <li class="listitem">
1.79 snj 9276: <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.1 dsieger 9277: create a directory for a new package, change into it, then run
1.10 hubertf 9278: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9279: <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>
9280: <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>
9281: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9282: </li>
1.23 wiz 9283: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9284: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9285: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9286: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 9287: configure step to the package's
9288: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 9289: <li class="listitem">
1.1 dsieger 9290: <p>Make the package compile, doing multiple rounds of</p>
9291: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9292: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9293: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9294: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9295: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9296: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9297: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9298: <p>Doing this step as non-root user will ensure that no files
9299: are modified that shouldn't be, especially during the build
1.10 hubertf 9300: phase. <span class="command"><strong>mkpatches</strong></span>,
9301: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.79 snj 9302: 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.1 dsieger 9303: package.</p>
9304: </li>
1.23 wiz 9305: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9306: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9307: <li class="listitem">
1.1 dsieger 9308: <p>Generate a <code class="filename">PLIST</code>:</p>
9309: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9310: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9311: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9312: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9313: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9314: <p>You usually need to be <code class="username">root</code> to do
9315: this. Look if there are any files left:</p>
9316: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9317: <p>If this reveals any files that are missing in
9318: <code class="filename">PLIST</code>, add them.</p>
9319: </li>
1.23 wiz 9320: <li class="listitem">
1.1 dsieger 9321: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9322: package again and make a binary package:</p>
9323: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9324: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9325: </li>
1.23 wiz 9326: <li class="listitem">
1.1 dsieger 9327: <p>Delete the installed package:</p>
9328: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9329: </li>
1.23 wiz 9330: <li class="listitem">
1.10 hubertf 9331: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9332: command, which shouldn't find anything now:</p>
9333: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9334: </li>
1.23 wiz 9335: <li class="listitem">
1.1 dsieger 9336: <p>Reinstall the binary package:</p>
9337: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9338: </li>
1.23 wiz 9339: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9340: <li class="listitem">
1.79 snj 9341: <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.1 dsieger 9342: reports:</p>
9343: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9344: </li>
1.23 wiz 9345: <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.1 dsieger 9346: </ul></div>
9347: </div>
1.41 asau 9348: <div class="chapter">
1.1 dsieger 9349: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9350: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9351: <div class="toc">
9352: <p><b>Table of Contents</b></p>
1.94 wiz 9353: <dl class="toc">
1.6 rillig 9354: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9355: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9356: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 9357: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 9358: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 9359: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9360: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9361: </dl>
9362: </div>
1.41 asau 9363: <div class="sect1">
1.1 dsieger 9364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9365: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9366: <p>Our policy is that we accept binaries only from pkgsrc
9367: developers to guarantee that the packages don't contain any
9368: trojan horses etc. This is not to annoy anyone but rather to
9369: protect our users! You're still free to put up your home-made
9370: binary packages and tell the world where to get them. NetBSD
9371: developers doing bulk builds and wanting to upload them please
1.66 asau 9372: 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
9373: builds)</i></a>.</p>
1.1 dsieger 9374: </div>
1.41 asau 9375: <div class="sect1">
1.1 dsieger 9376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9377: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9378: <p>First, check that your package is complete, compiles and
1.10 hubertf 9379: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.79 snj 9380: 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.1 dsieger 9381: archive that contains all files that make up the package.
9382: Finally, send this package to the pkgsrc bug tracking system,
1.79 snj 9383: 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.1 dsieger 9384: that, go to the web page
1.10 hubertf 9385: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 9386: which contains some instructions and a link to a form where you
9387: can submit packages. The
1.79 snj 9388: <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.21 snj 9389: also available as a substitute for either of the above two tools.
9390: </p>
1.1 dsieger 9391: <p>In the form of the problem report, the category should be
1.23 wiz 9392: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9393: and version number, and the description field should contain a
9394: short description of your package (contents of the COMMENT
9395: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9396: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9397: <p>If you want to submit several packages, please send a
9398: separate PR for each one, it's easier for us to track things
9399: that way.</p>
9400: <p>Alternatively, you can also import new packages into
1.23 wiz 9401: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.10 hubertf 9402: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1 dsieger 9403: for details.</p>
9404: </div>
1.41 asau 9405: <div class="sect1">
1.1 dsieger 9406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9407: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9408: <p>Please note all package additions, updates, moves, and
9409: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9410: important to keep this file up to date and conforming to the
9411: existing format, because it will be used by scripts to
1.10 hubertf 9412: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9413: sites. Additionally, check the
9414: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9415: for the package you updated or removed, in case it was mentioned
9416: there.</p>
9417: <p>When the <code class="varname">PKGREVISION</code> of a package is
9418: bumped, the change should appear in
9419: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9420: related or otherwise relevant. Mass bumps that result from a
9421: dependency being updated should not be mentioned. In all other
9422: cases it's the developer's decision.</p>
9423: <p>There is a make target that helps in creating proper
1.10 hubertf 9424: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9425: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9426: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9427: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9428: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9429: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9430: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9431: For new packages, or package moves or removals, set the
9432: <code class="varname">CTYPE</code> variable on the command line to "Added",
9433: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9434: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9435: not the same as your NetBSD login name. The target also automatically
9436: removes possibly existing entries for the package in the
9437: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9438: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9439: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9440: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9441: makes the cvs commands use the main repository.
9442: </p>
1.1 dsieger 9443: </div>
1.41 asau 9444: <div class="sect1">
1.1 dsieger 9445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 9446: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9447: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9448: access to the pkgsrc repository.</p>
9449: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9450: Start by adding the directory and then files in the directory. Don't
9451: forget to add the new package to the category's
9452: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9453: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9454: <pre class="programlisting">
9455: <code class="prompt">$</code> cd .../pkgsrc/category
9456: <code class="prompt">$</code> cvs add pkgname
9457: <code class="prompt">$</code> cd pkgname
9458: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9459: <code class="prompt">$</code> cvs add patches/p*
9460: <code class="prompt">$</code> cvs status | less
1.34 wiz 9461: <code class="prompt">$</code> cvs commit
1.33 wiz 9462: <code class="prompt">$</code> cd ..
9463: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9464: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9465: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9466: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9467: </pre>
1.1 dsieger 9468: <p>The commit message of the initial import should include part of the
9469: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9470: what the package is/does.</p>
1.33 wiz 9471: <p>Also mention the new package in
9472: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9473: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9474: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9475: </div>
1.41 asau 9476: <div class="sect1">
1.1 dsieger 9477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9478: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9479: <p>Please always put a concise, appropriate and relevant summary of the
9480: changes between old and new versions into the commit log when updating
9481: a package. There are various reasons for this:</p>
1.41 asau 9482: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9483: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9484: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9485: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9486: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9487: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9488: repository is very useful for people who read the pkgsrc-changes mailing
9489: list, so that they can make tactical decisions about when to upgrade
9490: the package.</p></li>
9491: </ul></div>
9492: <p>Please also recognize that, just because a new version of a package
9493: has been released, it should not automatically be upgraded in the CVS
9494: repository. We prefer to be conservative in the packages that are
9495: included in pkgsrc - development or beta packages are not really the
9496: best thing for most places in which pkgsrc is used. Please use your
9497: judgement about what should go into pkgsrc, and bear in mind that
9498: stability is to be preferred above new and possibly untested features.</p>
9499: </div>
1.41 asau 9500: <div class="sect1">
1.1 dsieger 9501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 9502: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9503: <p>Renaming packages is not recommended.</p>
9504: <p>When renaming packages, be sure to fix any references to old name
9505: in other Makefiles, options, buildlink files, etc.</p>
9506: <p>Also When renaming a package, please define
9507: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9508: pattern(s) of the previous package name.
9509: This may be repeated for multiple renames.
9510: The new package would be an exact replacement.
9511: </p>
1.23 wiz 9512: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9513: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9514: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9515: not be an exact replacement but is a suggestion for the replaced
9516: functionality.</p>
9517: </div>
1.41 asau 9518: <div class="sect1">
1.20 snj 9519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9520: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9521: <p>It is preferred that packages are not renamed or moved, but if needed
9522: please follow these steps.
9523: </p>
1.23 wiz 9524: <div class="orderedlist"><ol class="orderedlist" type="1">
9525: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9526: <li class="listitem">
1.1 dsieger 9527: <p>Remove all CVS dirs.</p>
9528: <p>Alternatively to the first two steps you can also do:</p>
9529: <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>
9530: <p>and use that for further work.</p>
9531: </li>
1.23 wiz 9532: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9533: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9534: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9535: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9536: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9537: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9538: for doing an update using pkgsrc building; for example, it can
1.79 snj 9539: 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.20 snj 9540: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9541: new <code class="varname">PKGPATH</code> for that moved package. Note that
9542: it may have multiple matches, so the tool should also check on the
9543: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9544: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9545: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9546: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9547: place.</p></li>
1.23 wiz 9548: <li class="listitem">
1.1 dsieger 9549: <p>Check if any package depends on it:
9550: </p>
9551: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9552: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9553: </li>
1.23 wiz 9554: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9555: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9556: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9557: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9558: <li class="listitem">
1.1 dsieger 9559: <p>Commit the changed and removed files:</p>
9560: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9561: <p>(and any packages from step 5, of course).</p>
9562: </li>
9563: </ol></div>
9564: </div>
9565: </div>
1.41 asau 9566: <div class="chapter">
1.1 dsieger 9567: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9568: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9569: <p>This section contains the answers to questions that may
9570: arise when you are writing a package. If you don't find your
9571: question answered here, first have a look in the other chapters,
9572: and if you still don't have the answer, ask on the
9573: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9574: <div class="qandaset">
1.95 ! wiz 9575: <a name="idm77713936"></a><dl>
1.6 rillig 9576: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9577: MAKEFLAGS, .MAKEFLAGS and
9578: MAKE_FLAGS?</a>
9579: </dt>
1.6 rillig 9580: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9581: MAKE, GMAKE and
9582: MAKE_PROGRAM?</a>
9583: </dt>
1.6 rillig 9584: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9585: CC, PKG_CC and
9586: PKGSRC_COMPILER?</a>
9587: </dt>
1.6 rillig 9588: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9589: BUILDLINK_LDFLAGS,
9590: BUILDLINK_LDADD and
9591: BUILDLINK_LIBS?</a>
9592: </dt>
1.6 rillig 9593: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9594: VARNAME=BUILDLINK_PREFIX.foo
9595: say it's empty?</a>
9596: </dt>
1.6 rillig 9597: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9598: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9599: don't understand the := inside
9600: it.</a>
9601: </dt>
1.6 rillig 9602: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9603: developers?</a>
9604: </dt>
1.6 rillig 9605: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9606: documentation?</a>
9607: </dt>
1.6 rillig 9608: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9609: do?</a>
9610: </dt>
9611: </dl>
1.41 asau 9612: <table border="0" style="width: 100%;">
9613: <colgroup>
1.1 dsieger 9614: <col align="left" width="1%">
1.23 wiz 9615: <col>
1.41 asau 9616: </colgroup>
1.1 dsieger 9617: <tbody>
1.41 asau 9618: <tr class="question">
1.1 dsieger 9619: <td align="left" valign="top">
1.95 ! wiz 9620: <a name="devfaq.makeflags"></a><a name="idm77713552"></a><p><b>22.1.</b></p>
1.1 dsieger 9621: </td>
9622: <td align="left" valign="top"><p>What is the difference between
9623: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9624: <code class="varname">MAKE_FLAGS</code>?</p></td>
9625: </tr>
9626: <tr class="answer">
9627: <td align="left" valign="top"></td>
9628: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.79 snj 9629: 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.1 dsieger 9630: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9631: the <code class="varname">MAKE_PROGRAM</code> when building the
9632: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9633: </tr>
1.41 asau 9634: <tr class="question">
1.1 dsieger 9635: <td align="left" valign="top">
1.95 ! wiz 9636: <a name="devfaq.make"></a><a name="idm77709456"></a><p><b>22.2.</b></p>
1.1 dsieger 9637: </td>
9638: <td align="left" valign="top"><p>What is the difference between
9639: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9640: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9641: </tr>
9642: <tr class="answer">
9643: <td align="left" valign="top"></td>
9644: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.79 snj 9645: <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.1 dsieger 9646: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9647: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9648: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9649: Make program that is used for building the
9650: package.</p></td>
9651: </tr>
1.41 asau 9652: <tr class="question">
1.1 dsieger 9653: <td align="left" valign="top">
1.95 ! wiz 9654: <a name="devfaq.cc"></a><a name="idm77705104"></a><p><b>22.3.</b></p>
1.1 dsieger 9655: </td>
9656: <td align="left" valign="top"><p>What is the difference between
9657: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9658: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9659: </tr>
9660: <tr class="answer">
9661: <td align="left" valign="top"></td>
9662: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9663: compiler, which can be configured by the pkgsrc user.
9664: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9665: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9666: path to a compiler, but the type of compiler that should be
9667: used. See <code class="filename">mk/compiler.mk</code> for more
9668: information about the latter variable.</p></td>
9669: </tr>
1.41 asau 9670: <tr class="question">
1.1 dsieger 9671: <td align="left" valign="top">
1.95 ! wiz 9672: <a name="devfaq.bl3flags"></a><a name="idm77700880"></a><p><b>22.4.</b></p>
1.1 dsieger 9673: </td>
9674: <td align="left" valign="top"><p>What is the difference between
9675: <code class="varname">BUILDLINK_LDFLAGS</code>,
9676: <code class="varname">BUILDLINK_LDADD</code> and
9677: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9678: </tr>
9679: <tr class="answer">
9680: <td align="left" valign="top"></td>
9681: <td align="left" valign="top"><p>[FIXME]</p></td>
9682: </tr>
1.41 asau 9683: <tr class="question">
1.1 dsieger 9684: <td align="left" valign="top">
1.95 ! wiz 9685: <a name="devfaq.bl3prefix"></a><a name="idm77698704"></a><p><b>22.5.</b></p>
1.1 dsieger 9686: </td>
1.10 hubertf 9687: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9688: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9689: say it's empty?</p></td>
9690: </tr>
9691: <tr class="answer">
9692: <td align="left" valign="top"></td>
9693: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9694: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9695: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9696: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9697: command.</p></td>
9698: </tr>
1.41 asau 9699: <tr class="question">
1.1 dsieger 9700: <td align="left" valign="top">
1.95 ! wiz 9701: <a name="devfaq.master_sites"></a><a name="idm77695632"></a><p><b>22.6.</b></p>
1.1 dsieger 9702: </td>
9703: <td align="left" valign="top"><p>What does
9704: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9705: don't understand the <code class="literal">:=</code> inside
9706: it.</p></td>
9707: </tr>
9708: <tr class="answer">
9709: <td align="left" valign="top"></td>
9710: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9711: assignment operator, like you might expect at first sight.
9712: Instead, it is a degenerate form of
9713: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.79 snj 9714: 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.1 dsieger 9715: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9716: case of <code class="varname">MASTER_SITE_*</code>,
9717: <em class="replaceable"><code>old_string</code></em> is the empty string and
9718: <em class="replaceable"><code>new_string</code></em> is
9719: <code class="literal">package/</code>. That's where the
9720: <code class="literal">:</code> and the <code class="literal">=</code> fall
9721: together.</p></td>
9722: </tr>
1.41 asau 9723: <tr class="question">
1.1 dsieger 9724: <td align="left" valign="top">
1.95 ! wiz 9725: <a name="devfaq.mailinglists"></a><a name="idm77687568"></a><p><b>22.7.</b></p>
1.1 dsieger 9726: </td>
9727: <td align="left" valign="top"><p>Which mailing lists are there for package
9728: developers?</p></td>
9729: </tr>
9730: <tr class="answer">
9731: <td align="left" valign="top"></td>
1.41 asau 9732: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9733: <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.1 dsieger 9734: <dd><p>This is a list for technical discussions related
9735: to pkgsrc development, e.g. soliciting feedback for changes to
9736: pkgsrc infrastructure, proposed new features, questions related
9737: to porting pkgsrc to a new platform, advice for maintaining a
9738: package, patches that affect many packages, help requests moved
9739: from pkgsrc-users when an infrastructure bug is found,
9740: etc.</p></dd>
1.10 hubertf 9741: <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.1 dsieger 9742: <dd><p>All bug reports in category "pkg" sent with
1.79 snj 9743: <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.1 dsieger 9744: directly; use one of the other mailing
9745: lists.</p></dd>
9746: </dl></div></td>
9747: </tr>
1.41 asau 9748: <tr class="question">
1.1 dsieger 9749: <td align="left" valign="top">
1.95 ! wiz 9750: <a name="devfaq.documentation"></a><a name="idm77683728"></a><p><b>22.8.</b></p>
1.1 dsieger 9751: </td>
9752: <td align="left" valign="top"><p>Where is the pkgsrc
9753: documentation?</p></td>
9754: </tr>
9755: <tr class="answer">
9756: <td align="left" valign="top"></td>
9757: <td align="left" valign="top">
9758: <p>There are many places where you can find
9759: documentation about pkgsrc:</p>
1.41 asau 9760: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9761: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9762: of chapters that explain large parts of pkgsrc, but some
9763: chapters tend to be outdated. Which ones they are is hard to
9764: say.</p></li>
1.23 wiz 9765: <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.1 dsieger 9766: about certain features, announcements of new parts of the pkgsrc
9767: infrastructure and sometimes even announcements that a certain
9768: feature has been marked as obsolete. The benefit here is that
9769: each message has a date appended to it.</p></li>
1.23 wiz 9770: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9771: <code class="filename">mk/</code> directory start with a comment that
9772: describes the purpose of the file and how it can be used by the
9773: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9774: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9775: help</strong></span>.</p></li>
1.23 wiz 9776: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9777: information, but they tend to be highly abbreviated, especially
9778: for actions that occur often. Some contain a detailed
9779: description of what has changed, but they are geared towards the
9780: other pkgsrc developers, not towards an average pkgsrc user.
9781: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9782: don't know what has been before, these messages may not be worth
9783: too much to you.</p></li>
1.23 wiz 9784: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9785: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9786: mind of the developer who wrote the code. To get this
1.10 hubertf 9787: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9788: to see who has written it and ask on the
9789: <code class="literal">tech-pkg</code> mailing list, so that others can
9790: find your questions later (see above). To be sure that the
9791: developer in charge reads the mail, you may CC him or
9792: her.</p></li>
9793: </ul></div>
9794: </td>
9795: </tr>
1.41 asau 9796: <tr class="question">
1.1 dsieger 9797: <td align="left" valign="top">
1.95 ! wiz 9798: <a name="devfaq.too-much-time"></a><a name="idm77677200"></a><p><b>22.9.</b></p>
1.1 dsieger 9799: </td>
9800: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9801: do?</p></td>
9802: </tr>
9803: <tr class="answer">
9804: <td align="left" valign="top"></td>
9805: <td align="left" valign="top">
9806: <p>This is not really an FAQ yet, but here's the answer
9807: anyway.</p>
1.41 asau 9808: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9809: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.79 snj 9810: <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.1 dsieger 9811: will tell you about newer versions of installed packages that are
9812: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9813: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9814: — it contains a list of suggested new packages and a list of
1.1 dsieger 9815: cleanups and enhancements for pkgsrc that would be nice to
9816: have.</p></li>
1.23 wiz 9817: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9818: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9819: mailing list.</p></li>
9820: </ul></div>
9821: </td>
9822: </tr>
9823: </tbody>
9824: </table>
9825: </div>
9826: </div>
1.41 asau 9827: <div class="chapter">
1.1 dsieger 9828: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9829: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9830: <div class="toc">
9831: <p><b>Table of Contents</b></p>
1.94 wiz 9832: <dl class="toc">
1.6 rillig 9833: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9834: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9835: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9836: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9837: </dl>
9838: </div>
1.10 hubertf 9839: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9840: site</a>:</p>
9841: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9842: environment, an intuitive and attractive desktop for users, and the
9843: GNOME development platform, an extensive framework for building
9844: applications that integrate into the rest of the desktop.</p></blockquote></div>
9845: <p>pkgsrc provides a seamless way to automatically build and install
9846: a complete GNOME environment <span class="emphasis"><em>under many different
9847: platforms</em></span>. We can say with confidence that pkgsrc is one of
9848: the most advanced build and packaging systems for GNOME due to its
9849: included technologies buildlink3, the wrappers and tools framework and
9850: automatic configuration file management. Lots of efforts are put into
9851: achieving a completely clean deinstallation of installed software
9852: components.</p>
1.10 hubertf 9853: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9854: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9855: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9856: pkgsrc as its preferred packaging system, contributing lots of
9857: portability fixes to make GNOME build and install under it.</p>
9858: <p>This chapter is aimed at pkgsrc developers and other people
9859: interested in helping our GNOME porting and packaging efforts. It
9860: provides instructions on how to manage the existing packages and some
9861: important information regarding their internals.</p>
1.41 asau 9862: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9863: <h3 class="title">We need your help!</h3>
9864: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9865: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9866: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9867: work</a> list! There is still a long way to go to get a
9868: fully-functional GNOME desktop under NetBSD and we need your help to
9869: achieve it!</p>
9870: </div>
1.41 asau 9871: <div class="sect1">
1.1 dsieger 9872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9873: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9874: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9875: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 9876: <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.1 dsieger 9877: the core GNOME desktop environment. It only includes the necessary
9878: bits to get it to boot correctly, although it may lack important
9879: functionality for daily operation. The idea behind this package is
9880: to let end users build their own configurations on top of this one,
9881: first installing this meta package to achieve a functional setup and
9882: then adding individual applications.</p></li>
1.79 snj 9883: <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.1 dsieger 9884: complete installation of the GNOME platform and desktop as defined
9885: by the GNOME project; this is based on the components distributed in
9886: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9887: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9888: official FTP server. Developer-only tools found in those
9889: directories are not installed unless required by some other
9890: component to work properly. Similarly, packages from the bindings
9891: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9892: in unless required as a dependency for an end-user component. This
1.79 snj 9893: 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>
9894: <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.1 dsieger 9895: Installs all the tools required to build a GNOME component when
9896: fetched from the CVS repository. These are required to let the
1.10 hubertf 9897: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9898: </ul></div>
9899: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9900: sorted in a way that eases updates: a package may depend on other
9901: packages listed before it but not on any listed after it. It is very
9902: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9903: change it to alphabetical sorting!</em></span></p>
9904: </div>
1.41 asau 9905: <div class="sect1">
1.1 dsieger 9906: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9907: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9908: <p>Almost all GNOME applications are written in C and use a common
9909: set of tools as their build system. Things get different with the new
9910: bindings to other languages (such as Python), but the following will
9911: give you a general idea on the minimum required tools:</p>
1.41 asau 9912: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9913: <li class="listitem">
1.1 dsieger 9914: <p>Almost all GNOME applications use the GNU Autotools as their
9915: build system. As a general rule you will need to tell this to your
9916: package:</p>
9917: <pre class="programlisting">
9918: GNU_CONFIGURE=yes
9919: USE_LIBTOOL=yes
9920: USE_TOOLS+=gmake
9921: </pre>
9922: </li>
1.23 wiz 9923: <li class="listitem">
1.1 dsieger 9924: <p>If the package uses pkg-config to detect dependencies, add this
9925: tool to the list of required utilities:</p>
9926: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.79 snj 9927: <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.1 dsieger 9928: the end of the build process to ensure that you did not miss to
9929: specify any dependency in your package and that the version
9930: requirements are all correct.</p>
9931: </li>
1.23 wiz 9932: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9933: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9934: to handle dependencies and to force the package to use the latest
9935: available version.</p></li>
1.23 wiz 9936: <li class="listitem">
1.1 dsieger 9937: <p>If the package uses gtk-doc (a documentation generation
9938: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9939: tool is rather big and the distfile should come with pregenerated
9940: documentation anyway; if it does not, it is a bug that you ought to
9941: report. For such packages you should disable gtk-doc (unless it is
9942: the default):</p>
9943: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9944: <p>The default location of installed HTML files
9945: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9946: and should not be changed unless the package insists on installing
9947: them somewhere else. Otherwise programs as
1.10 hubertf 9948: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9949: do that with an entry similar to:</p>
9950: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9951: </li>
9952: </ul></div>
9953: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9954: files under the installation prefix to maintain databases. In this
9955: context, shared means that those exact same directories and files are
9956: used among several different packages, leading to conflicts in the
9957: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9958: handle the most common cases, so you have to forget about using
9959: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9960: omitting shared files from them. If you find yourself doing those,
9961: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9962: <p>The following table lists the common situations that result in
9963: using shared directories or files. For each of them, the appropriate
9964: solution is given. After applying the solution be sure to
9965: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9966: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9967: <div class="table">
1.6 rillig 9968: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 9969: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
9970: <colgroup>
9971: <col>
9972: <col>
9973: </colgroup>
9974: <thead><tr>
9975: <th>If the package...</th>
9976: <th>Then...</th>
9977: </tr></thead>
9978: <tbody>
9979: <tr>
9980: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9981: <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.1 dsieger 9982: </tr>
9983: <tr>
9984: <td>Installs icons under the
9985: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9986: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9987: <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.1 dsieger 9988: </tr>
9989: <tr>
9990: <td>Installs files under
9991: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9992: <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.1 dsieger 9993: </tr>
9994: <tr>
9995: <td>Installs <code class="filename">.desktop</code> files under
9996: <code class="filename">share/applications</code> and these include MIME
9997: information.</td>
1.10 hubertf 9998: <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.1 dsieger 9999: </tr>
10000: </tbody>
10001: </table></div>
10002: </div>
10003: <br class="table-break">
10004: </div>
1.41 asau 10005: <div class="sect1">
1.1 dsieger 10006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10007: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 10008: <p>When seeing GNOME as a whole, there are two kinds of
10009: updates:</p>
1.41 asau 10010: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10011: <dt><span class="term">Major update</span></dt>
10012: <dd>
10013: <p>Given that there is still a very long way for GNOME 3 (if it
10014: ever appears), we consider a major update one that goes from a
10015: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10016: where <code class="literal">Y</code> is even and greater than
10017: <code class="literal">X</code>. These are hard to achieve because they
10018: introduce lots of changes in the components' code and almost all
10019: GNOME distfiles are updated to newer versions. Some of them can
10020: even break API and ABI compatibility with the previous major
10021: version series. As a result, the update needs to be done all at
10022: once to minimize breakage.</p>
10023: <p>A major update typically consists of around 80 package
10024: updates and the addition of some new ones.</p>
10025: </dd>
10026: <dt><span class="term">Minor update</span></dt>
10027: <dd>
10028: <p>We consider a minor update one that goes from a
10029: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10030: one where <code class="literal">Y</code> is greater than
10031: <code class="literal">X</code>. These are easy to achieve because they do
10032: not update all GNOME components, can be done in an incremental way
10033: and do not break API nor ABI compatibility.</p>
10034: <p>A minor update typically consists of around 50 package
10035: updates, although the numbers here may vary a lot.</p>
10036: </dd>
10037: </dl></div>
10038: <p>In order to update the GNOME components in pkgsrc to a new stable
10039: release (either major or minor), the following steps should be
10040: followed:</p>
1.23 wiz 10041: <div class="orderedlist"><ol class="orderedlist" type="1">
10042: <li class="listitem">
1.1 dsieger 10043: <p>Get a list of all the tarballs that form the new release by
10044: using the following commands. These will leave the full list of the
1.18 snj 10045: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 10046: file:</p>
10047: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10048: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10049: awk '{ print $9 }' >list.txt</code></strong>
10050: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10051: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10052: awk '{ print $9 }' >>list.txt</code></strong></pre>
10053: </li>
1.23 wiz 10054: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 10055: bump their version to the release you are updating them to. The
10056: three meta packages should be always consistent with versioning.
10057: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10058: in them.</p></li>
1.23 wiz 10059: <li class="listitem">
1.1 dsieger 10060: <p>For each meta package, update all its
10061: <code class="varname">DEPENDS</code> lines to match the latest versions as
10062: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10063: newer version (even if found in the FTP) because the meta packages
10064: are supposed to list the exact versions that form a specific GNOME
10065: release. Exceptions are permitted here if a newer version solves a
10066: serious issue in the overall desktop experience; these typically
10067: come in the form of a revision bump in pkgsrc, not in newer versions
10068: from the developers.</p>
10069: <p>Packages not listed in the <code class="filename">list.txt</code> file
10070: should be updated to the latest version available (if found in
10071: pkgsrc). This is the case, for example, of the dependencies on the
1.79 snj 10072: 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.1 dsieger 10073: </li>
1.23 wiz 10074: <li class="listitem">
1.1 dsieger 10075: <p>Generate a patch from the modified meta packages and extract the
10076: list of "new" lines. This will provide you an outline on what
10077: packages need to be updated in pkgsrc and in what order:</p>
10078: <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>
10079: </li>
1.23 wiz 10080: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 10081: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 10082: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 10083: of <code class="filename">todo.txt</code> and update the packages listed in
10084: it in order. For major desktop updates none of these should be
10085: committed until the entire set is completed because there are chances
10086: of breaking not-yet-updated packages.</p></li>
1.23 wiz 10087: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 10088: the tree one by one with appropriate log messages. At the end,
10089: commit the three meta package updates and all the corresponding
10090: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10091: <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>
10092: </ol></div>
10093: </div>
1.41 asau 10094: <div class="sect1">
1.1 dsieger 10095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10096: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 10097: <p>GNOME is a very big component in pkgsrc which approaches 100
10098: packages. Please, it is very important that you always, always,
10099: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 10100: 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.1 dsieger 10101: their attention on portability issues and to ensure that future versions
10102: can be built out-of-the box on NetBSD. The less custom patches in
10103: pkgsrc, the easier further updates are. Those developers in charge of
10104: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 10105: <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.1 dsieger 10106: Bugzilla</a>. Not all components use these to track bugs, but most
10107: of them do. Do not be short on your reports: always provide detailed
10108: explanations of the current failure, how it can be improved to achieve
10109: maximum portability and, if at all possible, provide a patch against CVS
10110: head. The more verbose you are, the higher chances of your patch being
10111: accepted.</p>
10112: <p>Also, please avoid using preprocessor magic to fix portability
10113: issues. While the FreeBSD GNOME people are doing a great job in porting
10114: GNOME to their operating system, the official GNOME sources are now
10115: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10116: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 10117: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 10118: details.</p>
10119: </div>
10120: </div>
10121: </div>
1.41 asau 10122: <div class="part">
1.1 dsieger 10123: <div class="titlepage"><div><div><h1 class="title">
10124: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10125: <div class="partintro">
1.1 dsieger 10126: <div></div>
10127: <p>This part of the guide deals with everything
10128: from the infrastructure that is behind the interfaces described
10129: in the developer's guide. A casual package maintainer should not
10130: need anything from this part.</p>
10131: <div class="toc">
10132: <p><b>Table of Contents</b></p>
1.94 wiz 10133: <dl class="toc">
1.6 rillig 10134: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10135: <dd><dl>
1.6 rillig 10136: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10137: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10138: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10139: <dd><dl>
1.6 rillig 10140: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10141: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10142: </dl></dd>
1.6 rillig 10143: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10144: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10145: <dd><dl>
1.6 rillig 10146: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10147: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10148: </dl></dd>
1.6 rillig 10149: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10150: <dd><dl>
1.23 wiz 10151: <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>
10152: <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.1 dsieger 10153: </dl></dd>
10154: </dl></dd>
1.6 rillig 10155: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10156: <dd><dl>
1.6 rillig 10157: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10158: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10159: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10160: <dd><dl>
1.6 rillig 10161: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10162: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10163: </dl></dd>
10164: </dl></dd>
1.6 rillig 10165: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10166: <dd><dl>
1.6 rillig 10167: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10168: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10169: </dl></dd>
10170: </dl>
10171: </div>
10172: </div>
1.41 asau 10173: <div class="chapter">
1.1 dsieger 10174: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10175: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10176: <div class="toc">
10177: <p><b>Table of Contents</b></p>
1.94 wiz 10178: <dl class="toc">
1.6 rillig 10179: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10180: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10181: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10182: <dd><dl>
1.6 rillig 10183: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10184: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10185: </dl></dd>
1.6 rillig 10186: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10187: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10188: <dd><dl>
1.6 rillig 10189: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10190: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10191: </dl></dd>
1.6 rillig 10192: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10193: <dd><dl>
1.23 wiz 10194: <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>
10195: <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.1 dsieger 10196: </dl></dd>
10197: </dl>
10198: </div>
10199: <p>The pkgsrc infrastructure consists of many small Makefile
10200: fragments. Each such fragment needs a properly specified
10201: interface. This chapter explains how such an interface looks
10202: like.</p>
1.41 asau 10203: <div class="sect1">
1.1 dsieger 10204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10205: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10206: <p>Whenever a variable is defined in the pkgsrc
10207: infrastructure, the location and the way of definition provide
10208: much information about the intended use of that variable.
10209: Additionally, more documentation may be found in a header
10210: comment or in this pkgsrc guide.</p>
10211: <p>A special file is
10212: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10213: variables that are intended to be user-defined. They are either
10214: defined using the <code class="literal">?=</code> operator or they are
10215: left undefined because defining them to anything would
1.23 wiz 10216: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10217: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10218: file.</p>
10219: <p>Outside this file, the following conventions apply:
10220: Variables that are defined using the <code class="literal">?=</code>
10221: operator may be overridden by a package.</p>
10222: <p>Variables that are defined using the <code class="literal">=</code>
10223: operator may be used read-only at run-time.</p>
10224: <p>Variables whose name starts with an underscore must not be
10225: accessed outside the pkgsrc infrastructure at all. They may
10226: change without further notice.</p>
1.41 asau 10227: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10228: <h3 class="title">Note</h3>
10229: <p>These conventions are currently not applied
10230: consistently to the complete pkgsrc
10231: infrastructure.</p>
10232: </div>
10233: </div>
1.41 asau 10234: <div class="sect1">
1.1 dsieger 10235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10236: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10237: <p>All variables that contain lists of things should default
10238: to being empty. Two examples that do not follow this rule are
10239: <code class="varname">USE_LANGUAGES</code> and
10240: <code class="varname">DISTFILES</code>. These variables cannot simply be
10241: modified using the <code class="literal">+=</code> operator in package
10242: <code class="filename">Makefile</code>s (or other files included by
10243: them), since there is no guarantee whether the variable is
10244: already set or not, and what its value is. In the case of
1.23 wiz 10245: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10246: the default value and just define it as in the following
10247: example.</p>
10248: <pre class="programlisting">
10249: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10250: </pre>
10251: <p>Because of the selection of this default value, the same
10252: value appears in many package Makefiles. Similarly for
10253: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10254: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10255: doesn't stand out. Nevertheless it is mentioned in many
10256: files.</p>
10257: </div>
1.41 asau 10258: <div class="sect1">
1.1 dsieger 10259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10260: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 10261: <div class="sect2">
1.1 dsieger 10262: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10263: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10264: <p>Variable evaluation takes place either at load time or at
10265: runtime, depending on the context in which they occur. The
10266: contexts where variables are evaluated at load time are:</p>
1.41 asau 10267: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10268: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10269: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10270: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10271: <code class="literal">.for</code>,</p></li>
1.23 wiz 10272: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10273: </ul></div>
10274: <p>A special exception are references to the iteration
10275: variables of <code class="literal">.for</code> loops, which are expanded
10276: inline, no matter in which context they appear.</p>
10277: <p>As the values of variables may change during load time,
10278: care must be taken not to evaluate them by accident. Typical
10279: examples for variables that should not be evaluated at load time
10280: are <code class="varname">DEPENDS</code> and
10281: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10282: clear, here is an example:</p>
10283: <pre class="programlisting">
10284: CONFIGURE_ARGS= # none
10285: CFLAGS= -O
10286: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10287:
10288: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10289:
10290: CFLAGS+= -Wall
10291: </pre>
10292: <p>This code shows how the use of the <code class="literal">:=</code>
10293: operator can quickly lead to unexpected results. The first
10294: paragraph is fairly common code. The second paragraph evaluates
10295: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10296: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10297: <code class="literal">-Wall</code> is appended to the
10298: <code class="varname">CFLAGS</code>, but this addition will not appear in
10299: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10300: paragraphs from above typically occur in completely unrelated
10301: files.</p>
10302: </div>
1.41 asau 10303: <div class="sect2">
1.1 dsieger 10304: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10305: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10306: <p>After all the files have been loaded, the values of the
10307: variables cannot be changed anymore. Variables that are used in
10308: the shell commands are expanded at this point.</p>
10309: </div>
10310: </div>
1.41 asau 10311: <div class="sect1">
1.1 dsieger 10312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10313: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10314: <p>There are many ways in which the definition and use of a
10315: variable can be restricted in order to detect bugs and
10316: violations of the (mostly unwritten) policies. See the
10317: <code class="literal">pkglint</code> developer's documentation for further
10318: details.</p>
10319: </div>
1.41 asau 10320: <div class="sect1">
1.1 dsieger 10321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10322: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10323: <p>Most of the <code class="filename">.mk</code> files fall into one
10324: of the following classes. Cases where a file falls into more
10325: than one class should be avoided as it often leads to subtle
10326: bugs.</p>
1.41 asau 10327: <div class="sect2">
1.1 dsieger 10328: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10329: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10330: <p>In a traditional imperative programming language some of
10331: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10332: procedures. They take some input parameters and—after
10333: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10334: variables in <code class="filename">Makefile</code>s have global scope
10335: care must be taken not to use parameter names that have already
10336: another meaning. For example, <code class="varname">PKGNAME</code> is a
10337: bad choice for a parameter name.</p>
10338: <p>Procedures are completely evaluated at preprocessing time.
10339: That is, when calling a procedure all input parameters must be
10340: completely resolvable. For example,
10341: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10342: parameter since it is very likely that further text will be
10343: added after calling the procedure, which would effectively apply
10344: the procedure to only a part of the variable. Also, references
10345: to other variables wit will be modified after calling the
10346: procedure.</p>
10347: <p>A procedure can declare its output parameters either as
10348: suitable for use in preprocessing directives or as only
10349: available at runtime. The latter alternative is for variables
10350: that contain references to other runtime variables.</p>
10351: <p>Procedures shall be written such that it is possible to
10352: call the procedure more than once. That is, the file must not
10353: contain multiple-inclusion guards.</p>
10354: <p>Examples for procedures are
10355: <code class="filename">mk/bsd.options.mk</code> and
10356: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10357: that the parameters are evaluated at load time, they should be
10358: assigned using the <code class="literal">:=</code> operator, which should
10359: be used only for this purpose.</p>
10360: </div>
1.41 asau 10361: <div class="sect2">
1.1 dsieger 10362: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10363: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10364: <p>Action files take some input parameters and may define
10365: runtime variables. They shall not define loadtime variables.
10366: There are action files that are included implicitly by the
10367: pkgsrc infrastructure, while other must be included
10368: explicitly.</p>
10369: <p>An example for action files is
10370: <code class="filename">mk/subst.mk</code>.</p>
10371: </div>
10372: </div>
1.41 asau 10373: <div class="sect1">
1.1 dsieger 10374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10375: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10376: <p>Package <code class="filename">Makefile</code>s usually consist of
10377: a set of variable definitions, and include the file
10378: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10379: Before that, they may also include various other
10380: <code class="filename">*.mk</code> files if they need to query the
10381: availability of certain features like the type of compiler or
10382: the X11 implementation. Due to the heavy use of preprocessor
10383: directives like <code class="literal">.if</code> and
10384: <code class="literal">.for</code>, the order in which the files are loaded
10385: matters.</p>
10386: <p>This section describes at which point the various files
10387: are loaded and gives reasons for that order.</p>
1.41 asau 10388: <div class="sect2">
1.1 dsieger 10389: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10390: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10391: </h3></div></div></div>
10392: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10393: is to define some essential variables like
10394: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10395: <code class="varname">MACHINE_ARCH</code>.</p>
10396: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10397: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 10398: After that, those variables
1.1 dsieger 10399: that have not been overridden by the user are loaded from
10400: <code class="filename">mk/defaults/mk.conf</code>.</p>
10401: <p>After the user settings, the system settings and platform
10402: settings are loaded, which may override the user
10403: settings.</p>
10404: <p>Then, the tool definitions are loaded. The tool wrappers
10405: are not yet in effect. This only happens when building a
10406: package, so the proper variables must be used instead of the
10407: direct tool names.</p>
10408: <p>As the last steps, some essential variables from the
10409: wrapper and the package system flavor are loaded, as well as the
10410: variables that have been cached in earlier phases of a package
10411: build.</p>
10412: </div>
1.41 asau 10413: <div class="sect2">
1.1 dsieger 10414: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10415: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10416: </h3></div></div></div>
10417: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10418: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10419: loaded, which fill default values for those variables that have
10420: not been defined by the package. These variables may later
10421: be used even in unrelated files.</p>
10422: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10423: provides the target <code class="literal">error-check</code> that is added
10424: as a special dependency to all other targets that use
10425: <code class="varname">DELAYED_ERROR_MSG</code> or
10426: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10427: <p>Then, the package-specific hacks from
10428: <code class="filename">hacks.mk</code> are included.</p>
10429: <p>Then, various other files follow. Most of them don't have
10430: any dependencies on what they need to have included before or
10431: after them, though some do.</p>
10432: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10433: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10434: restricts the use of these variables to all the files that have
10435: been included before. Appearances in later files will be
10436: silently ignored.</p>
10437: <p>Then, the files for the main targets are included, in the
10438: order of later execution, though the actual order should not
10439: matter.</p>
10440: <p>At last, some more files are included that don't set any
10441: interesting variables but rather just define make targets to be
10442: executed.</p>
10443: </div>
10444: </div>
10445: </div>
1.41 asau 10446: <div class="chapter">
1.1 dsieger 10447: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10448: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10449: <div class="toc">
10450: <p><b>Table of Contents</b></p>
1.94 wiz 10451: <dl class="toc">
1.6 rillig 10452: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10453: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10454: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10455: <dd><dl>
1.6 rillig 10456: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10457: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10458: </dl></dd>
10459: </dl>
10460: </div>
10461: <p>The pkgsrc infrastructure consists of a large codebase,
10462: and there are many corners where every little bit of a file is
10463: well thought out, making pkgsrc likely to fail as soon as
10464: anything is changed near those parts. To prevent most changes
10465: from breaking anything, a suite of regression tests should go
10466: along with every important part of the pkgsrc infrastructure.
10467: This chapter describes how regression tests work in pkgsrc and
10468: how you can add new tests.</p>
1.41 asau 10469: <div class="sect1">
1.1 dsieger 10470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10471: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10472: <p></p>
10473: </div>
1.41 asau 10474: <div class="sect1">
1.1 dsieger 10475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10476: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.79 snj 10477: <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.10 hubertf 10478: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10479: can simply run that command, which will run all tests in the
10480: <code class="filename">regress</code> category.</p>
10481: </div>
1.41 asau 10482: <div class="sect1">
1.1 dsieger 10483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10484: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10485: <p>Every directory in the <code class="filename">regress</code>
10486: category that contains a file called <code class="filename">spec</code>
10487: is considered a regression test. This file is a shell program
1.10 hubertf 10488: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10489: The following functions can be overridden to suit your
10490: needs.</p>
1.41 asau 10491: <div class="sect2">
1.1 dsieger 10492: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10493: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10494: <p>These functions do not take any parameters. They are all
1.23 wiz 10495: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.1 dsieger 10496: to check the exitcodes of any commands you run in the
10497: test.</p>
1.41 asau 10498: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10499: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10500: <dd><p>This function prepares the environment for the
10501: test. By default it does nothing.</p></dd>
10502: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10503: <dd><p>This function runs the actual test. By default,
10504: it calls <code class="varname">TEST_MAKE</code> with the arguments
10505: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10506: error messages into the file
10507: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10508: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10509: <dd><p>This function is run after the test and is
10510: typically used to compare the actual output from the one that is
10511: expected. It can make use of the various helper functions from
10512: the next section.</p></dd>
10513: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10514: <dd><p>This function cleans everything up after the
10515: test has been run. By default it does nothing.</p></dd>
10516: </dl></div>
10517: </div>
1.41 asau 10518: <div class="sect2">
1.1 dsieger 10519: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10520: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.41 asau 10521: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10522: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10523: <dd><p>This function compares the exitcode of the
1.10 hubertf 10524: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1 dsieger 10525: If they differ, the test will fail.</p></dd>
10526: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10527: <dd><p>This function checks for each of its parameters
1.10 hubertf 10528: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1 dsieger 10529: extended regular expression. If it does not, the test will
10530: fail.</p></dd>
10531: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10532: <dd><p>This function checks for each of its parameters
1.10 hubertf 10533: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10534: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10535: If any of the regular expressions matches, the test will
10536: fail.</p></dd>
10537: </dl></div>
10538: </div>
10539: </div>
10540: </div>
1.41 asau 10541: <div class="chapter">
1.1 dsieger 10542: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10543: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10544: <div class="toc">
10545: <p><b>Table of Contents</b></p>
1.94 wiz 10546: <dl class="toc">
1.6 rillig 10547: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10548: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10549: </dl>
10550: </div>
10551: <p>The pkgsrc system has already been ported to many
10552: operating systems, hardware architectures and compilers. This
10553: chapter explains the necessary steps to make pkgsrc even more
10554: portable.</p>
1.41 asau 10555: <div class="sect1">
1.1 dsieger 10556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10557: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10558: <p>To port pkgsrc to a new operating system (called
10559: <code class="literal">MyOS</code> in this example), you need to touch the
10560: following files:</p>
1.41 asau 10561: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10562: <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>
10563: <dd><p>This file contains some basic definitions, for
10564: example the name of the C
10565: compiler.</p></dd>
10566: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10567: <dd><p>Insert code that defines the variables
10568: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10569: <code class="varname">LOWER_OS_VERSION</code>,
10570: <code class="varname">LOWER_VENDOR</code>,
10571: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10572: <code class="varname">APPEND_ELF</code>, and the other variables that
10573: appear in this file.</p></dd>
10574: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10575: <dd><p>This file contains the platform-specific
10576: definitions that are used by pkgsrc. Start by copying one of the
10577: other files and edit it to your
10578: needs.</p></dd>
10579: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10580: <dd><p>This file defines the paths to all the tools
10581: that are needed by one or the other package in pkgsrc, as well
10582: as by pkgsrc itself. Find out where these tools are on your
10583: platform and add them.</p></dd>
10584: </dl></div>
10585: <p>Now, you should be able to build some basic packages, like
1.79 snj 10586: <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.1 dsieger 10587: </div>
1.41 asau 10588: <div class="sect1">
1.1 dsieger 10589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10590: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10591: <p>TODO</p>
10592: </div>
10593: </div>
10594: </div>
1.41 asau 10595: <div class="appendix">
10596: <div class="titlepage"><div><div><h1 class="title">
10597: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10598: <div class="toc">
10599: <p><b>Table of Contents</b></p>
1.94 wiz 10600: <dl class="toc">
1.1 dsieger 10601: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10602: <dd><dl>
10603: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10604: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10605: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10606: <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.1 dsieger 10607: </dl></dd>
10608: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10609: </dl>
10610: </div>
10611: <p>We checked to find a piece of software that wasn't in the packages
10612: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10613: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10614: present in the tree is beyond us, but it's useful for the purposes of
10615: this exercise.</p>
1.41 asau 10616: <div class="sect1">
1.1 dsieger 10617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10618: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10619: <div class="sect2">
1.1 dsieger 10620: <div class="titlepage"><div><div><h3 class="title">
10621: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10622: <pre class="programlisting">
10623: # $NetBSD$
10624: #
10625:
10626: DISTNAME= bison-1.25
10627: CATEGORIES= devel
10628: MASTER_SITES= ${MASTER_SITE_GNU}
10629:
1.29 dholland 10630: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10631: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10632: COMMENT= GNU yacc clone
10633:
10634: GNU_CONFIGURE= yes
1.46 wiz 10635: INFO_FILES= yes
1.1 dsieger 10636:
10637: .include "../../mk/bsd.pkg.mk"
10638: </pre>
10639: </div>
1.41 asau 10640: <div class="sect2">
1.1 dsieger 10641: <div class="titlepage"><div><div><h3 class="title">
10642: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10643: <pre class="programlisting">
10644: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.79 snj 10645: 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.1 dsieger 10646: of the NetBSD source tree is beyond me.
10647: </pre>
10648: </div>
1.41 asau 10649: <div class="sect2">
1.1 dsieger 10650: <div class="titlepage"><div><div><h3 class="title">
10651: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10652: <pre class="programlisting">
10653: @comment $NetBSD$
10654: bin/bison
10655: man/man1/bison.1.gz
10656: share/bison.simple
10657: share/bison.hairy
10658: </pre>
10659: </div>
1.41 asau 10660: <div class="sect2">
1.1 dsieger 10661: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10662: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10663: </h3></div></div></div>
10664: <p>The NetBSD package system comes with
1.79 snj 10665: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 10666: which helps to check the contents of these
10667: files. After installation it is quite easy to use, just change to the
10668: directory of the package you wish to examine and execute
1.10 hubertf 10669: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10670: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10671: looks fine.</pre>
10672: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10673: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10674: -Wall</strong></span> for a very thorough check.</p>
10675: </div>
10676: </div>
1.41 asau 10677: <div class="sect1">
1.1 dsieger 10678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10679: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10680: <p>Create the directory where the package lives,
10681: plus any auxiliary directories:</p>
10682: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10683: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10684: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10685: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10686: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 10687: <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.1 dsieger 10688: then continue with fetching the distfile:</p>
10689: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10690: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10691: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10692: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10693: ftp: Error retrieving file: 500 Internal error
10694:
10695: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10696: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10697: ftp: Error retrieving file: 500 Internal error
10698:
10699: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10700: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10701: Successfully retrieved file.</pre>
10702: <p>Generate the checksum of the distfile into
10703: <code class="filename">distinfo</code>:</p>
10704: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10705: <p>Now compile:</p>
10706: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10707: >> Checksum OK for bison-1.25.tar.gz.
10708: ===> Extracting for bison-1.25
10709: ===> Patching for bison-1.25
10710: ===> Ignoring empty patch directory
10711: ===> Configuring for bison-1.25
10712: creating cache ./config.cache
10713: checking for gcc... cc
10714: checking whether we are using GNU C... yes
10715: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10716: checking how to run the C preprocessor... cc -E
10717: checking for minix/config.h... no
10718: checking for POSIXized ISC... no
10719: checking whether cross-compiling... no
10720: checking for ANSI C header files... yes
10721: checking for string.h... yes
10722: checking for stdlib.h... yes
10723: checking for memory.h... yes
10724: checking for working const... yes
10725: checking for working alloca.h... no
10726: checking for alloca... yes
10727: checking for strerror... yes
10728: updating cache ./config.cache
10729: creating ./config.status
10730: creating Makefile
10731: ===> Building for bison-1.25
10732: 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
10733: 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
10734: 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
10735: 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
10736: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
10737: 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
10738: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10739: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10740: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
10741: 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
10742: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
10743: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.c
10744: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
10745: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
10746: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
10747: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reduce.c
10748: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
10749: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g warshall.c
10750: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
10751: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
10752: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt1.c
10753: 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
10754: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10755: rm -f bison.s1
10756: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10757: <p>Everything seems OK, so install the files:</p>
10758: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10759: >> Checksum OK for bison-1.25.tar.gz.
10760: ===> Installing for bison-1.25
10761: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10762: rm -f /usr/pkg/bin/bison
10763: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10764: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10765: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10766: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10767: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10768: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10769: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10770: ===> Registering installation for bison-1.25</pre>
10771: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10772: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10773: binary package, do this now:</p>
10774: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10775: >> Checksum OK for bison-1.25.tar.gz.
10776: ===> Building package for bison-1.25
10777: Creating package bison-1.25.tgz
10778: Registering depends:.
10779: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10780: <p>Now that you don't need the source and object files
10781: any more, clean up:</p>
10782: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10783: ===> Cleaning for bison-1.25</pre>
10784: </div>
10785: </div>
1.41 asau 10786: <div class="appendix">
10787: <div class="titlepage"><div><div><h1 class="title">
10788: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10789: <div class="toc">
10790: <p><b>Table of Contents</b></p>
1.94 wiz 10791: <dl class="toc">
1.1 dsieger 10792: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10793: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10794: </dl>
10795: </div>
1.41 asau 10796: <div class="sect1">
1.1 dsieger 10797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10798: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10800: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10801: => figlet221.tar.gz doesn't seem to exist on this system.
10802: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10803: => [172219 bytes]
10804: Connected to ftp.plig.net.
10805: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10806: 331 Guest login ok, send your complete e-mail address as password.
10807: 230-You are user #5 of 500 simultaneous users allowed.
10808: 230-
10809: 230- ___ _ _ _
10810: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10811: 230- | _| _| . |_| . | | | . |_| . | _| . |
10812: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10813: 230- |_| |_| |___| |___|
10814: 230-
10815: 230-** Welcome to ftp.plig.org **
10816: 230-
10817: 230-Please note that all transfers from this FTP site are logged. If you
10818: 230-do not like this, please disconnect now.
10819: 230-
1.18 snj 10820: 230-This archive is available via
1.1 dsieger 10821: 230-
10822: 230-HTTP: http://ftp.plig.org/
10823: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10824: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10825: 230-
10826: 230-Please email comments, bug reports and requests for packages to be
10827: 230-mirrored to ftp-admin@plig.org.
10828: 230-
10829: 230-
10830: 230 Logged in anonymously.
10831: Remote system type is UNIX.
10832: Using binary mode to transfer files.
10833: 200 Type okay.
10834: 250 "/pub" is new cwd.
10835: 250-"/pub/figlet" is new cwd.
10836: 250-
10837: 250-Welcome to the figlet archive at ftp.figlet.org
10838: 250-
10839: 250- ftp://ftp.figlet.org/pub/figlet/
10840: 250-
10841: 250-The official FIGlet web page is:
10842: 250- http://www.figlet.org/
10843: 250-
10844: 250-If you have questions, please mailto:info@figlet.org. If you want to
10845: 250-contribute a font or something else, you can email us.
10846: 250
10847: 250 "/pub/figlet/program" is new cwd.
10848: 250 "/pub/figlet/program/unix" is new cwd.
10849: local: figlet221.tar.gz remote: figlet221.tar.gz
10850: 502 Unimplemented command.
10851: 227 Entering Passive Mode (195,40,6,41,246,104)
10852: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10853: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10854: 226 Transfer completed.
10855: 172219 bytes received in 00:02 (75.99 KB/s)
10856: 221 Goodbye.
10857: => Checksum OK for figlet221.tar.gz.
10858: ===> Extracting for figlet-2.2.1nb2
10859: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10860: ===> Patching for figlet-2.2.1nb2
10861: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10862: ===> Overriding tools for figlet-2.2.1nb2
10863: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10864: ===> Configuring for figlet-2.2.1nb2
10865: ===> Building for figlet-2.2.1nb2
10866: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10867: chmod a+x figlet
10868: gcc -O2 -o chkfont chkfont.c
10869: => Unwrapping files-to-be-installed.
10870: <code class="prompt">#</code>
10871: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10872: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10873: ===> Installing for figlet-2.2.1nb2
10874: install -d -o root -g wheel -m 755 /usr/pkg/bin
10875: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10876: mkdir -p /usr/pkg/share/figlet
10877: cp figlet /usr/pkg/bin
10878: cp chkfont /usr/pkg/bin
10879: chmod 555 figlist showfigfonts
10880: cp figlist /usr/pkg/bin
10881: cp showfigfonts /usr/pkg/bin
10882: cp fonts/*.flf /usr/pkg/share/figlet
10883: cp fonts/*.flc /usr/pkg/share/figlet
10884: cp figlet.6 /usr/pkg/man/man6
10885: ===> Registering installation for figlet-2.2.1nb2
10886: <code class="prompt">#</code></pre>
10887: </div>
1.41 asau 10888: <div class="sect1">
1.1 dsieger 10889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10890: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10891: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10892: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10893: ===> Packaging figlet-2.2.1nb2
10894: ===> Building binary package for figlet-2.2.1nb2
10895: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10896: Using SrcDir value of /usr/pkg
10897: Registering depends:.
10898: <code class="prompt">#</code></pre>
10899: </div>
10900: </div>
1.41 asau 10901: <div class="appendix">
10902: <div class="titlepage"><div><div><h1 class="title">
10903: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10904: <div class="toc">
10905: <p><b>Table of Contents</b></p>
1.94 wiz 10906: <dl class="toc">
1.23 wiz 10907: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10908: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10909: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10910: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10911: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10912: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10913: source packages</a></span></dt>
10914: </dl>
10915: </div>
10916: <p>As in other big projects, the directory layout of pkgsrc
10917: is quite complex for newbies. This chapter explains where you
10918: find things on the FTP server. The base directory on
1.10 hubertf 10919: <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.1 dsieger 10920: On other servers it may be different, but inside this directory,
10921: everything should look the same, no matter on which server you
10922: are. This directory contains some subdirectories, which are
10923: explained below.</p>
1.41 asau 10924: <div class="sect1">
1.1 dsieger 10925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10926: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10927: <p>The directory <code class="filename">distfiles</code> contains lots
10928: of archive files from all pkgsrc packages, which are mirrored
10929: here. The subdirectories are called after their package names
10930: and are used when the distributed files have names that don't
10931: explicitly contain a version number or are otherwise too generic
10932: (for example <code class="filename">release.tar.gz</code>).</p>
10933: </div>
1.41 asau 10934: <div class="sect1">
1.1 dsieger 10935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10936: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10937: <p>This directory contains things that individual pkgsrc
10938: developers find worth publishing.</p>
10939: </div>
1.41 asau 10940: <div class="sect1">
1.1 dsieger 10941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10942: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10943: <p>This directory contains binary packages for the various
10944: platforms that are supported by pkgsrc.
10945: 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.41 asau 10946: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10947: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10948: operating system for which the packages have been built. The
1.10 hubertf 10949: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10950: command, so it may differ from the one you are used to
10951: hear.</p></li>
1.23 wiz 10952: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10953: architecture of the platform for which the packages have been
1.10 hubertf 10954: built. It also includes the <code class="varname">ABI</code> (Application
10955: Binary Interface) for platforms that have several of
10956: them.</p></li>
1.23 wiz 10957: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10958: the operating system. For version numbers that change often (for
10959: example NetBSD-current), the often-changing part should be
10960: replaced with an <code class="literal">x</code>, for example
10961: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10962: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10963: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10964: for a stable branch, or <code class="literal">head</code> for packages
10965: built from the HEAD branch. The latter should only be used when
10966: the packages are updated on a regular basis. Otherwise the date
10967: from checking out pkgsrc should be appended, for example
10968: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10969: </ul></div>
10970: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10971: can quickly click through the directories on the
10972: server and find the best binary packages for their machines. Since they
10973: usually know the operating system and the hardware architecture, OPSYS
10974: and ARCH are placed first. After these choices, they can select the
10975: best combination of OSVERSION and TAG together, since it is usually the
10976: case that packages stay compatible between different version of the
10977: operating system.</p>
10978: <p>In each of these directories, there is a
10979: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10980: <code class="filename">All</code> which contains all binary packages.
10981: Besides that, there are various category directories that
10982: contain symbolic links to the real binary packages.</p>
10983: </div>
1.41 asau 10984: <div class="sect1">
1.1 dsieger 10985: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10986: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10987: <p>Here are the reports from bulk builds, for those who want
10988: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10989: 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.8 rillig 10990: </div>
1.41 asau 10991: <div class="sect1">
1.8 rillig 10992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10993: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10994: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10995: source packages</h2></div></div></div>
1.23 wiz 10996: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10997: that is the files that define how to create binary packages from
10998: source archives.</p>
10999: <p>The directory <code class="filename">pkgsrc</code> contains a
11000: snapshot of the CVS repository, which is updated regularly. The
11001: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11002: directory, ready to be downloaded as a whole.</p>
11003: <p>In the directories for the quarterly branches, there is an
11004: additional file called
1.22 jakllsch 11005: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.1 dsieger 11006: which contains the state of pkgsrc when it was branched.</p>
11007: </div>
11008: </div>
1.41 asau 11009: <div class="appendix">
11010: <div class="titlepage"><div><div><h1 class="title">
11011: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 11012: <div class="toc">
11013: <p><b>Table of Contents</b></p>
1.94 wiz 11014: <dl class="toc">
1.1 dsieger 11015: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11016: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11017: </dl>
11018: </div>
11019: <p>This section contains information on editing the pkgsrc
11020: guide itself.</p>
1.41 asau 11021: <div class="sect1">
1.1 dsieger 11022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11023: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11024: <p>The pkgsrc guide's source code is stored in
11025: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11026: are created from it:</p>
1.41 asau 11027: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 11028: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11029: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11030: <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>
11031: <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.1 dsieger 11032: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 11033: <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.1 dsieger 11034: PostScript version of the pkgsrc guide.</p></li>
11035: </ul></div>
11036: </div>
1.41 asau 11037: <div class="sect1">
1.1 dsieger 11038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11039: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11040: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 11041: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 11042: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 11043: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 11044: documentation) installed. These are automatically installed when
1.79 snj 11045: 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.41 asau 11046: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 11047: right directory. All further steps will take place
11048: here.</p></li>
1.41 asau 11049: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 11050: <code class="filename">files/</code>.</p></li>
1.41 asau 11051: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 11052: guide for valid XML and to build the final output files. If you
11053: get any errors at this stage, you can just edit the files, as
11054: there are only symbolic links in the working directory, pointing
11055: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 11056: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 11057: commit)</strong></span></p></li>
1.41 asau 11058: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 11059: regenerate the output files with the proper RCS
11060: Ids.</p></li>
1.41 asau 11061: <li class="step">
1.10 hubertf 11062: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 11063: commit the files in both <code class="filename">pkgsrc/doc</code> and
11064: <code class="filename">htdocs</code>.</p>
1.41 asau 11065: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 11066: <h3 class="title">Note</h3>
11067: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 11068: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11069: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 11070: directory.</p>
11071: </div>
11072: </li>
11073: </ol></div>
11074: </div>
11075: </div>
11076: </div></body>
11077: </html>
CVSweb <webmaster@jp.NetBSD.org>