Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.104
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.100 leot 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.100 leot 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.104 ! sevan 512: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</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.102 ryoon 518: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</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.104 ! sevan 541: <li class="listitem"><p>Tracking of package dependencies automatically, including when
! 542: performing updates, to ensure required packages are installed. The
! 543: configuration files of various packages are handled automatically during
! 544: updates, so local changes 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.104 ! sevan 698: <tr>
! 699: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
! 700: <td align="center">Jun 2014</td>
! 701: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
! 702: </tr>
1.1 dsieger 703: </tbody>
704: </table></div>
705: </div>
706: <br class="table-break">
707: </div>
708: </div>
1.41 asau 709: <div class="sect1">
1.1 dsieger 710: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
711: <a name="overview"></a>1.2. Overview</h2></div></div></div>
712: <p>This document is divided into three parts. The first,
1.10 hubertf 713: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 714: describes how one can use one of the packages in the Package
715: Collection, either by installing a precompiled binary package,
716: or by building one's own copy using the NetBSD package system.
1.10 hubertf 717: 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 718: package so it can be easily built by other NetBSD users without
719: knowing about the package's building details. The third part,
1.10 hubertf 720: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 721: is intended for those who want to understand how pkgsrc is
722: implemented.</p>
723: <p>This document is available in various formats:
1.10 hubertf 724: <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 725: </div>
1.41 asau 726: <div class="sect1">
1.1 dsieger 727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
728: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 729: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
730: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 731: terminology used within this document.</p>
1.41 asau 732: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 733: <dt><span class="term">Package</span></dt>
734: <dd><p>A set of files and building instructions
735: that describe what's necessary
736: to build a certain piece of software using
737: pkgsrc. Packages are traditionally stored under
738: <code class="filename">/usr/pkgsrc</code>.</p></dd>
739: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 740: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 741: is part of the NetBSD operating system and can be bootstrapped
742: to run on non-NetBSD operating systems as well. It handles
743: building (compiling), installing, and removing of
744: packages.</p></dd>
745: <dt><span class="term">Distfile</span></dt>
746: <dd><p>This term describes the file or files that are
747: provided by the author of the piece of software to
748: distribute his work. All the changes necessary to build on
749: NetBSD are reflected in the corresponding package. Usually
750: the distfile is in the form of a compressed tar-archive,
751: but other types are possible, too. Distfiles are usually
752: stored below
753: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
754: <dt><span class="term">Port</span></dt>
755: <dd><p>This is the term used by FreeBSD and OpenBSD people
756: for what we call a package.
1.23 wiz 757: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 758: architecture.</p></dd>
759: <dt><span class="term">Precompiled/binary package</span></dt>
760: <dd>
761: <p>A set of binaries built with pkgsrc from a distfile
762: and stuffed together in a single <code class="filename">.tgz</code>
763: file so it can be installed on machines of the same
764: machine architecture without the need to
765: recompile. Packages are usually generated in
766: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 767: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 768: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 769: especially in the context of precompiled packages.</p>
770: </dd>
771: <dt><span class="term">Program</span></dt>
772: <dd><p>The piece of software to be installed which will be
773: constructed from all the files in the distfile by the
774: actions defined in the corresponding package.</p></dd>
775: </dl></div>
1.41 asau 776: <div class="sect2">
1.1 dsieger 777: <div class="titlepage"><div><div><h3 class="title">
778: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 779: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 780: <dt><span class="term">pkgsrc users</span></dt>
781: <dd>
782: <p>The
783: pkgsrc users are people who use the packages provided by pkgsrc.
784: Typically they are system administrators. The people using the
1.23 wiz 785: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
786: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 787: <p>There are two kinds of pkgsrc users: Some only want to
788: install pre-built binary packages. Others build the pkgsrc
789: packages from source, either for installing them directly or for
1.10 hubertf 790: 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 791: documentation.</p>
792: </dd>
793: <dt><span class="term">package maintainers</span></dt>
794: <dd><p>A
1.10 hubertf 795: 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 796: <dt><span class="term">infrastructure developers</span></dt>
797: <dd><p>These people are involved in all those files
798: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 799: 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 800: too.</p></dd>
801: </dl></div>
802: </div>
803: </div>
1.41 asau 804: <div class="sect1">
1.1 dsieger 805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
806: <a name="typography"></a>1.4. Typography</h2></div></div></div>
807: <p>When giving examples for commands, shell prompts are used to
808: show if the command should/can be issued as root, or if
1.23 wiz 809: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 810: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
811: shell prompt, assuming they use the C-shell or tcsh.</p>
812: </div>
813: </div>
1.41 asau 814: <div class="part">
1.1 dsieger 815: <div class="titlepage"><div><div><h1 class="title">
816: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
817: <div class="toc">
818: <p><b>Table of Contents</b></p>
1.100 leot 819: <dl class="toc">
1.1 dsieger 820: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
821: <dd><dl>
822: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
823: <dd><dl>
1.51 asau 824: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 825: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 826: </dl></dd>
827: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
828: <dd><dl>
829: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
830: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
831: </dl></dd>
832: </dl></dd>
833: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
834: <dd><dl>
835: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
836: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
837: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
838: <dd><dl>
1.45 obache 839: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
840: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
841: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 842: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
843: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
844: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
845: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
846: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
847: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
848: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 849: </dl></dd>
850: </dl></dd>
851: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
852: <dd><dl>
853: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
854: <dd><dl>
855: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
856: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
857: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
858: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
859: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
860: <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>
861: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
862: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
863: </dl></dd>
864: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
865: <dd><dl>
866: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
867: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
868: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
869: </dl></dd>
870: </dl></dd>
871: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
872: <dd><dl>
873: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
874: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 875: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 876: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 877: <dd><dl>
1.4 rillig 878: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 879: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
880: <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 881: </dl></dd>
1.4 rillig 882: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
883: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 884: </dl></dd>
885: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
886: <dd><dl>
887: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
888: <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 889: </dl></dd>
890: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
891: builds)</a></span></dt>
1.1 dsieger 892: <dd><dl>
1.71 wiz 893: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
894: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
895: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
896: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 897: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
898: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 899: </dl></dd>
900: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
901: <dd><dl>
1.23 wiz 902: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
903: <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 904: </dl></dd>
905: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
906: <dd><dl>
907: <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 908: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
909: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
910: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
911: <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>
912: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
913: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
914: <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>
915: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
916: <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 917: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 918: <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>
919: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
920: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
921: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
922: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
923: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
924: <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 925: </dl></dd>
926: </dl>
927: </div>
1.41 asau 928: <div class="chapter">
1.1 dsieger 929: <div class="titlepage"><div><div><h2 class="title">
930: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
931: <div class="toc">
932: <p><b>Table of Contents</b></p>
1.100 leot 933: <dl class="toc">
1.1 dsieger 934: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
935: <dd><dl>
1.51 asau 936: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 937: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 938: </dl></dd>
939: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
940: <dd><dl>
941: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
942: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
943: </dl></dd>
944: </dl>
945: </div>
946: <p>Before you download and extract the files, you need to decide
947: where you want to extract them. When using pkgsrc as root user, pkgsrc
948: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
949: free to install the sources and binary packages wherever you want in
950: your filesystem, provided that the pathname does not contain white-space
951: or other characters that are interpreted specially by the shell and some
952: other programs. A safe bet is to use only letters, digits, underscores
953: and dashes.</p>
1.41 asau 954: <div class="sect1">
1.1 dsieger 955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
956: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
957: <p>Before you download any pkgsrc files, you should decide
958: whether you want the <span class="emphasis"><em>current</em></span> branch or the
959: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
960: quarterly basis from the current branch and only gets modified
961: for security updates. The names of the stable branches are built
962: from the year and the quarter, for example
1.78 snj 963: <code class="literal">2014Q3</code>.</p>
1.1 dsieger 964: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 965: want to download pkgsrc. You can get it as a tar file or via CVS.
966: Both ways are described here.</p>
1.51 asau 967: <p>Note that tar archive contains CVS working copy.
968: Thus you can switch to using CVS at any later time.</p>
1.41 asau 969: <div class="sect2">
1.1 dsieger 970: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 971: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 972: <p>The primary download location for all pkgsrc files is
1.51 asau 973: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
974: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
975: (it points to the same location).
976: There are a number of subdirectories for different purposes,
977: 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>
978: <p>The tar archive for the current branch is in the directory
979: <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 980: It is autogenerated daily.</p>
1.51 asau 981: <p>To save download time we provide bzip2- and
982: xz-compressed archives which are published at
983: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
984: and
985: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
986: respectively.
987: </p>
988: <p>You can fetch the same files using FTP.</p>
1.78 snj 989: <p>The tar file for the stable branch 2014Q3 is in the
990: 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 991: <p>To download a pkgsrc stable tarball, run:</p>
992: <pre class="screen">
1.59 jnemeth 993: <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 994: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 995: stable branch to be downloaded, for example,
1.78 snj 996: <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span>.</p>
997: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 998: or your web browser.</p>
1.12 weinem 999: <p>Then, extract it with:</p>
1.78 snj 1000: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1001: <p>This will create the directory <code class="filename">pkgsrc/</code>
1002: in <code class="filename">/usr/</code> and all the package source will be
1003: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1004: <p>To download pkgsrc-current, run:</p>
1005: <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 1006: </div>
1.41 asau 1007: <div class="sect2">
1.1 dsieger 1008: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 1009: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
1010: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 1011: <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 1012: </pre>
1013: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1.78 snj 1014: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2014Q3</span>”</span></p>
1.23 wiz 1015: <p>This will create the directory <code class="filename">pkgsrc/</code>
1016: in your <code class="filename">/usr/</code> directory and all the package source
1017: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1018: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1019: <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 1020: </pre>
1.78 snj 1021: <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 1022: <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 1023: <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 1024: </pre>
1025: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1026: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1027: or better globally in <code class="filename">/etc/profile</code>:</p>
1028: <pre class="programlisting">
1029: # set CVS remote shell command
1030: CVS_RSH=ssh
1031: export CVS_RSH
1032: </pre>
1033: <p>By default, CVS doesn't do things like most people would expect it to do.
1034: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1035: in your home directory and saving the following lines to it.
1036: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1037: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1038: <pre class="programlisting">
1039: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1040: cvs -q -z2
1.2 rillig 1041: checkout -P
1.4 rillig 1042: update -dP
1043: diff -upN
1.2 rillig 1044: rdiff -u
1.23 wiz 1045: release -d
1.2 rillig 1046: </pre>
1.1 dsieger 1047: </div>
1048: </div>
1.41 asau 1049: <div class="sect1">
1.1 dsieger 1050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1051: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1052: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1053: (which also works if you have first installed it via a tar
1054: file). It saves bandwidth and hard disk activity, compared to
1055: downloading the tar file again.</p>
1.41 asau 1056: <div class="sect2">
1.1 dsieger 1057: <div class="titlepage"><div><div><h3 class="title">
1058: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1059: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1060: <h3 class="title">Warning</h3>
1061: <p>When updating from a tar file, you first need to
1062: completely remove the old pkgsrc directory. Otherwise those
1063: files that have been removed from pkgsrc in the mean time will
1064: not be removed on your local disk, resulting in inconsistencies.
1065: When removing the old files, any changes that you have done to
1066: the pkgsrc files will be lost after updating. Therefore updating
1067: via CVS is strongly recommended.</p>
1068: </div>
1069: <p>Note that by default the distfiles and the binary packages
1070: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1071: before updating. You can also configure pkgsrc to store distfiles
1072: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1073: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1074: 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 1075: <p>To update pkgsrc from a tar file, download the tar file as
1076: explained above. Then, make sure that you have not made any
1077: changes to the files in the pkgsrc directory. Remove the pkgsrc
1078: directory and extract the new tar file. Done.</p>
1079: </div>
1.41 asau 1080: <div class="sect2">
1.1 dsieger 1081: <div class="titlepage"><div><div><h3 class="title">
1082: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1083: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1084: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1085: </pre>
1086: <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>
1087: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1088: </pre>
1.41 asau 1089: <div class="sect3">
1.1 dsieger 1090: <div class="titlepage"><div><div><h4 class="title">
1091: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1092: <p>When updating pkgsrc, the CVS program keeps track of the
1093: branch you selected. But if you, for whatever reason, want to
1094: switch from the stable branch to the current one, you can do it
1.23 wiz 1095: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1096: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1097: back to the stable branch, add the
1.78 snj 1098: <span class="quote">“<span class="quote">-rpkgsrc-2014Q3</span>”</span> option.</p>
1.1 dsieger 1099: </div>
1.41 asau 1100: <div class="sect3">
1.1 dsieger 1101: <div class="titlepage"><div><div><h4 class="title">
1102: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1103: <p>When you update pkgsrc, the CVS program will only touch
1104: those files that are registered in the CVS repository. That
1105: means that any packages that you created on your own will stay
1106: unmodified. If you change files that are managed by CVS, later
1107: updates will try to merge your changes with those that have been
1108: done by others. See the CVS manual, chapter
1.23 wiz 1109: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1110: </div>
1111: </div>
1112: </div>
1113: </div>
1.41 asau 1114: <div class="chapter">
1.1 dsieger 1115: <div class="titlepage"><div><div><h2 class="title">
1116: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1117: <div class="toc">
1118: <p><b>Table of Contents</b></p>
1.100 leot 1119: <dl class="toc">
1.1 dsieger 1120: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1121: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1122: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1123: <dd><dl>
1.45 obache 1124: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1125: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1126: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 1127: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1128: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1129: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1130: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1131: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1132: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1133: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 1134: </dl></dd>
1135: </dl>
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="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1140: <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 1141: </div>
1.41 asau 1142: <div class="sect1">
1.1 dsieger 1143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1144: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1145: <p>pkgsrc can be bootstrapped for use in two different modes:
1146: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1147: to privileged one all programs are installed under one particular user
1.43 asau 1148: and cannot utilise privileged operations (packages don't create
1149: special users and all special file permissions like setuid are ignored).
1150: </p>
1.1 dsieger 1151: <p>Installing the bootstrap kit from source should be as simple as:</p>
1152: <pre class="screen">
1.60 asau 1153: <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 1154: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1155: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1156: </pre>
1.43 asau 1157: <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>
1158: <p>By default, in privileged mode pkgsrc uses
1159: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1160: where programs will be installed in,
1.1 dsieger 1161: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1162: directory where pkgsrc will do its internal bookkeeping,
1163: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1164: where packages install their persistent data.
1165: In unprivileged mode pkgsrc uses
1166: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1167: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1168: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1169: </p>
1170: <p>You can change default layout using command-line arguments.
1171: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1172: </p>
1.41 asau 1173: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1174: <h3 class="title">Note</h3>
1.10 hubertf 1175: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1176: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1177: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1178: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1179: </div>
1.43 asau 1180: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1181: <h3 class="title">Note</h3>
1182: <p>It is possible to bootstrap multiple instances of pkgsrc
1183: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1184: corresponding to the installation you're working with to build
1185: and install packages.
1186: </p>
1187: </div>
1.1 dsieger 1188: </div>
1.41 asau 1189: <div class="sect1">
1.1 dsieger 1190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1191: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1192: <p>Here are some platform-specific notes you should be aware of.</p>
1.41 asau 1193: <div class="sect2">
1.1 dsieger 1194: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1195: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1196: <p>Cygwin 1.7.x and later are supported.</p>
1197: <p>You need to install minimal base packages in `Base' category
1198: plus any of compiler, gcc, gcc4, and/or clang.
1199: For gcc and gcc4, C and C++ compiler will be installed by default,
1200: but you can install Fortran compiler additionally
1201: because it will be required to use libtool.
1202: If it is not installed (or too old), Fortran compiler will be
1203: installed with pkgsrc automatically.</p>
1204: <p>As noted in
1205: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1206: su(1) command has been in Cygwin distribution, but it has never worked.
1207: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1208: </p>
1209: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1210: then pick "Run as administrator".</p></li></ul></div>
1211: </div>
1212: <div class="sect2">
1213: <div class="titlepage"><div><div><h3 class="title">
1214: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.101 sevan 1215: <p>Darwin 8.x and up are supported.</p>
1.41 asau 1216: <p>Before you start, you need to download and install
1217: the Mac OS X Developer Tools from Apple's Developer Connection.
1218: This requires (free) membership. See
1.22 jakllsch 1219: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.41 asau 1220: for details. Also, make sure you install X11 (an optional
1221: package included with the Developer Tools) if you intend
1222: to build packages that use the X11 Window System.
1223: (If you don't want or need the full Xcode GUI,
1224: download and install Command Line Tools for Xcode.)</p>
1.1 dsieger 1225: </div>
1.41 asau 1226: <div class="sect2">
1.1 dsieger 1227: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1228: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.29 dholland 1229: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1 dsieger 1230: other versions may work.</p>
1231: <p>Care should be taken so that the tools that this kit installs do not conflict
1232: with the FreeBSD userland tools. There are several steps:</p>
1.23 wiz 1233: <div class="orderedlist"><ol class="orderedlist" type="1">
1234: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1 dsieger 1235: <code class="filename">/var/db/pkg</code>. It is therefore
1236: recommended that you choose a different location (e.g.
1237: <code class="filename">/usr/pkgdb</code>) by
1238: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1239: <li class="listitem">
1.1 dsieger 1240: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1241: good idea to move them out of the way to avoid confusion, e.g.</p>
1242: <pre class="screen">
1243: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1244: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1245: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1246: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1247: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1248: </pre>
1249: </li>
1.23 wiz 1250: <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 1251: <code class="filename">/etc/mk.conf.example</code> file
1252: when you use the bootstrap script.</p></li>
1253: </ol></div>
1254: </div>
1.41 asau 1255: <div class="sect2">
1.1 dsieger 1256: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1257: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1258: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1259: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1260: <p> You should install ncurses (libncurses and libncurses-dev)
1261: packages.</p>
1262: </div>
1263: <div class="sect2">
1264: <div class="titlepage"><div><div><h3 class="title">
1265: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.1 dsieger 1266: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1267: providing a Unix-like environment with a tighter kernel integration than
1268: available with Cygwin. It is part of the Windows Services for Unix
1269: package, available for free for any licensed copy of Windows 2000, XP
1.10 hubertf 1270: (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 1271: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1272: are not officially supported. (The main difference in 3.0/3.1 is lack
1273: of pthreads, but other parts of libc may also be lacking.)</p>
1.24 wiz 1274: <p>Services for Unix Applications (aka SUA) is an integrated
1275: component of Windows Server 2003 R2 (5.2), Windows Vista and
1276: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1277: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1278: 6.1 (64bit) subsystems have been tested. Other versions may
1279: work as well. The Interix 5.x subsystem has not yet been tested
1280: with pkgsrc.</p>
1.41 asau 1281: <div class="sect3">
1.1 dsieger 1282: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1283: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.1 dsieger 1284: <p>At an absolute minimum, the following packages must be installed from
1285: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.41 asau 1286: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1287: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1288: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1289: <li class="listitem"><p>Remote Connectivity</p></li>
1290: <li class="listitem"><p>Interix SDK</p></li>
1.1 dsieger 1291: </ul></div>
1292: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1293: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1294: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1295: pkgsrc (or from a binary package).</p>
1296: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1297: not need to be installed, but Remote Connectivity itself should be
1298: installed in order to have a working inetd.</p>
1299: <p>During installation you may be asked whether to enable setuid
1300: behavior for Interix programs, and whether to make pathnames default to
1301: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1302: enabled. (Without case-sensitivity, a large number of packages including
1303: perl will not build.)</p>
1304: <p>NOTE: Newer Windows service packs change the way binary execution
1305: works (via the Data Execution Prevention feature). In order to use
1306: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1307: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1308: must be installed. Hotfixes are available from Microsoft through a
1.14 jmcneill 1309: support contract; however, Debian Interix Port has made most Interix
1310: 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 1311: <p>In addition to the hotfix noted above, it may be necessary to
1312: disable Data Execution Prevention entirely to make Interix functional.
1313: This may happen only with certain types of CPUs; the cause is not fully
1314: understood at this time. If gcc or other applications still segfault
1315: repeatedly after installing one of the hotfixes note above, the
1316: following option can be added to the appropriate "boot.ini" line on the
1317: Windows boot drive: /NoExecute=AlwaysOff
1318: (WARNING, this will disable DEP completely, which may be a security
1319: risk if applications are often run as a user in the Administrators
1320: group!)</p>
1321: </div>
1.41 asau 1322: <div class="sect3">
1.1 dsieger 1323: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1324: <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 1325: <p>If SFU is already installed and you wish to alter these settings to work
1326: with pkgsrc, note the following things.</p>
1.41 asau 1327: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1328: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1 dsieger 1329: Windows Services for UNIX, then click Change. In the installer, choose
1330: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.23 wiz 1331: <li class="listitem">
1.1 dsieger 1332: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1333: change the following registry key:</p>
1334: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1335: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1336: </li>
1.23 wiz 1337: <li class="listitem">
1.1 dsieger 1338: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1339: following registry key:</p>
1340: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1341: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1342: </li>
1343: </ul></div>
1344: </div>
1.41 asau 1345: <div class="sect3">
1.1 dsieger 1346: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1347: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.1 dsieger 1348: <p>The package manager (either the pkgsrc "su" user, or the user
1349: running "pkg_add") must be a member of the local Administrators
1350: group. Such a user must also be used to run the bootstrap. This is
1351: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1352: <p>The package manager should use a umask of 002. "make install" will
1353: automatically complain if this is not the case. This ensures that
1354: directories written in /var/db/pkg are Administrators-group writeable.</p>
1355: <p>The popular Interix binary packages from http://www.interopsystems.com/
1356: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1357: NOT be used in conjunction with pkgsrc. If you choose to use them at
1358: the same time as the pkgsrc packages, ensure that you use the proper
1359: pkg_* tools for each type of binary package.</p>
1360: <p>The TERM setting used for DOS-type console windows (including those
1361: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1362: don't have a termcap/terminfo entry for it, but the following .termcap
1363: entry provides adequate emulation in most cases:</p>
1364: <pre class="programlisting">
1365: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1366: </pre>
1367: </div>
1.41 asau 1368: <div class="sect3">
1.1 dsieger 1369: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1370: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.1 dsieger 1371: <p>Though Interix suffices as a familiar and flexible substitute
1372: for a full Unix-like platform, it has some drawbacks that should
1373: be noted for those desiring to make the most of Interix.</p>
1.41 asau 1374: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1375: <li class="listitem">
1.1 dsieger 1376: <p><span class="strong"><strong>X11:</strong></span></p>
1377: <p>Interix comes with the standard set of X11R6 client libraries,
1378: and can run X11 based applications, but it does
1379: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.10 hubertf 1380: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1381: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1 dsieger 1382: (available in a trimmed version for Interix from Interop Systems as the
1.10 hubertf 1383: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1 dsieger 1384: and the free X11 server included with
1.10 hubertf 1385: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1 dsieger 1386: </li>
1.23 wiz 1387: <li class="listitem">
1.1 dsieger 1388: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1389: <p>Because Interix runs in a completely different NT subsystem from
1390: Win32 applications, it does not currently support various X11
1391: protocol extensions for acceleration (such as MIT-SHM or DGA).
1392: Most interactive applications to a local X server will run
1393: reasonably fast, but full motion video and other graphics
1394: intensive applications may require a faster-than-expected CPU.</p>
1395: </li>
1.23 wiz 1396: <li class="listitem">
1.1 dsieger 1397: <p><span class="strong"><strong>Audio:</strong></span></p>
1398: <p>Interix has no native support for audio output. For audio
1.10 hubertf 1399: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1 dsieger 1400: audio system on Interix. Unlike on most platforms, the
1.79 snj 1401: <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 1402: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1 dsieger 1403: server component. To output audio via an Interix host, the
1.79 snj 1404: <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 1405: must also be installed.</p>
1406: </li>
1.23 wiz 1407: <li class="listitem">
1.1 dsieger 1408: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1409: <p>Direct device access is not currently supported in Interix, so it
1410: is not currently possible to access CD/DVD drives, USB devices,
1411: or SCSI devices through non-filesystem means. Among other things,
1412: this makes it impossible to use Interix directly for CD/DVD
1413: burning.</p>
1414: </li>
1.23 wiz 1415: <li class="listitem">
1.1 dsieger 1416: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1417: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1418: drives are also not directly accessible in Interix. However,
1419: support is in work to make tape drive access possible by using
1420: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1421: esound server).</p>
1422: </li>
1423: </ul></div>
1424: </div>
1.41 asau 1425: <div class="sect3">
1.1 dsieger 1426: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1427: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.1 dsieger 1428: <p>It is not necessary, in general, to have a "root" user on the
1429: Windows system; any member of the local Administrators group will
1430: suffice. However, some packages currently assume that the user
1431: named "root" is the privileged user. To accommodate these, you
1432: may create such a user; make sure it is in the local group
1433: Administrators (or your language equivalent).</p>
1.10 hubertf 1434: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1 dsieger 1435: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1436: time being, install packages as the local Administrator (or
1437: your language equivalent), or run the following command after
1438: installing a package to work around the issue:</p>
1439: <pre class="screen">
1440: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1441: </pre>
1442: </div>
1443: </div>
1.41 asau 1444: <div class="sect2">
1.1 dsieger 1445: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1446: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.1 dsieger 1447: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1448: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1449: according to your preference. If you do not have a license for the MIPSpro
1.10 hubertf 1450: 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 1451: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.79 snj 1452: 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 1453: etc.</p>
1454: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1455: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1456: you start out using "abi=n32", that's what all your packages will be built
1457: with.</p>
1458: <p>Therefore, please make sure that you have no conflicting
1459: <code class="varname">CFLAGS</code> in your environment or the
1.10 hubertf 1460: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1461: try to link n32 object files with lib64 or vice versa. Check your
1462: <code class="filename">/etc/compiler.defaults</code>!</p>
1463: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1464: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1465: as it appears that IRIX linker occasionally runs into issues when trying to
1466: link over a network-mounted file system.</p>
1467: <p>The bootstrapping process should set all the right options for programs such
1468: as imake(1), but you may want to set some options depending on your local
1469: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1470: course, your compiler's man pages for details.</p>
1471: <p>If you are using SGI's MIPSPro compiler, please set
1472:
1473: </p>
1474: <pre class="programlisting">
1475: PKGSRC_COMPILER= mipspro
1476: </pre>
1477: <p>
1478:
1.10 hubertf 1479: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1480: are using gcc and may end up passing invalid flags to the compiler. Note that
1481: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1482: default.</p>
1483: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1484: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1485: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1486: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1487: '--preserve-path' flag.</p>
1488: </div>
1.41 asau 1489: <div class="sect2">
1.1 dsieger 1490: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1491: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.1 dsieger 1492: <p>Some versions of Linux (for example Debian GNU/Linux) need
1493: either libtermcap or libcurses (libncurses). Installing the
1494: distributions libncurses-dev package (or equivalent) should fix
1495: the problem.</p>
1496: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1497: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1498: i386 have been tested.</p>
1499: <p>To bootstrap using icc, assuming the default icc installation
1500: directory:</p>
1501: <pre class="programlisting">
1.31 wiz 1502: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1 dsieger 1503: </pre>
1.41 asau 1504: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1505: <h3 class="title">Note</h3>
1.31 wiz 1506: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1507: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1508: <p>For icc 10.1 neither of these appears to be necessary.</p>
1509: </div>
1510: <p>Use a value for ICCBASE that corresponds to the directory
1511: where icc is installed. After bootstrapping, set
1512: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30 wiz 1513: <pre class="programlisting">
1.31 wiz 1514: ICCBASE= /opt/intel/cc/10.1.008
1.1 dsieger 1515: </pre>
1.31 wiz 1516: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1517: <code class="filename">/opt/intel_cc_80</code>. This is the default
1518: install directory for icc 8.0. If you are using a more recent
1519: version, be sure to set the correct path explicitly.
1520: </p>
1.1 dsieger 1521: <p>pkgsrc uses the static linking method of the runtime libraries
1522: provided by icc, so binaries can be run on other systems which do not
1523: have the shared libraries installed.</p>
1524: <p>Libtool, however, extracts a list of libraries from the
1.79 snj 1525: <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 1526: records it, throwing away the -Bstatic and -Bdynamic options
1527: interspersed between the libraries. This means that
1528: libtool-linked C++ shared libraries will have a runtime
1529: dependency on the icc libraries until this is fixed in
1530: libtool.</p>
1531: </div>
1.41 asau 1532: <div class="sect2">
1.1 dsieger 1533: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1534: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.57 bsiegert 1535: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1536: Older versions might also work. Releases before #10 are not
1537: supported.</p>
1538: <p>The package tools of the (older) native ports tree,
1539: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1540: have the same names as the ones used by pkgsrc. Care should be taken
1541: that the right tools are used. When installing packages from source,
1542: use the <code class="filename">bmake</code> command for pkgsrc and
1543: <code class="filename">mmake</code> for MirPorts.</p>
1544: <p>pkgsrc and MirPorts use the same location for the package
1545: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1546: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1547: tree is self-contained. This is also the default setting used in the
1548: binary package builds.</p>
1549: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1550: server. The bootstrap kit there already contains the
1551: <span class="command"><strong>pkgin</strong></span> package manager. See the
1552: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1553: page for more details.</p>
1554: </div>
1555: <div class="sect2">
1556: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1557: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.29 dholland 1558: <p>OpenBSD 5.1 has been tested and supported,
1559: other versions may work.</p>
1.1 dsieger 1560: <p>Care should be taken so that the tools that this kit installs do not conflict
1561: with the OpenBSD userland tools. There are several steps:</p>
1.23 wiz 1562: <div class="orderedlist"><ol class="orderedlist" type="1">
1563: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1 dsieger 1564: <code class="filename">/var/db/pkg</code>. It is therefore
1565: recommended that you choose a different location (e.g.
1566: <code class="filename">/usr/pkgdb</code>) by
1567: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1568: <li class="listitem">
1.1 dsieger 1569: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1570: good idea to move them out of the way to avoid confusion, e.g.</p>
1571: <pre class="screen">
1572: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1573: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1574: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1575: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1576: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1577: </pre>
1578: </li>
1.23 wiz 1579: <li class="listitem">
1.10 hubertf 1580: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1581: <code class="filename">/etc/mk.conf.example</code> file
1582: when you use the bootstrap script. OpenBSD's make program uses
1.10 hubertf 1583: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1584: as well. You can work around this by enclosing all the pkgsrc-specific parts
1585: of the file with:</p>
1586: <pre class="programlisting">
1587: .ifdef BSD_PKG_MK
1588: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1589: .else
1590: # OpenBSD stuff
1591: .endif
1592: </pre>
1593: </li>
1594: </ol></div>
1595: </div>
1.41 asau 1596: <div class="sect2">
1.1 dsieger 1597: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1598: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.35 wiz 1599: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1600: You will need a working C compiler. Both gcc 4.5.3 and
1.1 dsieger 1601: Sun WorkShop 5 have been tested.</p>
1602: <p>The following packages are required on Solaris 8 for the bootstrap
1603: process and to build packages.</p>
1.41 asau 1604: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1605: <li class="listitem"><p>SUNWsprot</p></li>
1606: <li class="listitem"><p>SUNWarc</p></li>
1607: <li class="listitem"><p>SUNWbtool</p></li>
1608: <li class="listitem"><p>SUNWtoo</p></li>
1609: <li class="listitem"><p>SUNWlibm</p></li>
1.1 dsieger 1610: </ul></div>
1611: <p>Please note that the use of GNU binutils on Solaris is
1612: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1613: <p>Whichever compiler you use, please ensure the compiler tools and
1614: your $prefix are in your <code class="varname">PATH</code>. This includes
1615: <code class="filename">/usr/ccs/{bin,lib}</code>
1616: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.41 asau 1617: <div class="sect3">
1.1 dsieger 1618: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1619: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.1 dsieger 1620: <p>It makes life much simpler if you only use the same gcc consistently
1621: for building all packages.</p>
1622: <p>It is recommended that an external gcc be used only for bootstrapping,
1623: then either build gcc from
1.79 snj 1624: <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 1625: package, then remove gcc used during bootstrapping.</p>
1.10 hubertf 1626: <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 1627: </div>
1.41 asau 1628: <div class="sect3">
1.1 dsieger 1629: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1630: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.1 dsieger 1631: <p>You will need at least the following packages installed (from WorkShop
1632: 5.0)</p>
1.41 asau 1633: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1634: <li class="listitem"><p>SPROcc
1.1 dsieger 1635: - Sun WorkShop Compiler C 5.0</p></li>
1.23 wiz 1636: <li class="listitem"><p>SPROcpl
1.1 dsieger 1637: - Sun WorkShop Compiler C++ 5.0</p></li>
1.23 wiz 1638: <li class="listitem"><p>SPROild
1.1 dsieger 1639: - Sun WorkShop Incremental Linker</p></li>
1.23 wiz 1640: <li class="listitem"><p>SPROlang
1.1 dsieger 1641: - Sun WorkShop Compilers common components</p></li>
1642: </ul></div>
1643: <p>You should set the following variables in your
1.10 hubertf 1644: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1645: <pre class="programlisting">
1646: CC= cc
1647: CXX= CC
1648: CPP= cc -E
1649: CXXCPP= CC -E
1650: </pre>
1.41 asau 1651: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1652: <h3 class="title">Note</h3>
1653: <p>The <code class="varname">CPP</code> setting might break some
1654: packages that use the C preprocessor for processing things other
1655: than C source code.</p>
1656: </div>
1657: </div>
1.41 asau 1658: <div class="sect3">
1.1 dsieger 1659: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1660: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.1 dsieger 1661: <p>To build 64-bit packages, you just need to have the
1.10 hubertf 1662: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1663: <pre class="programlisting">
1664: PKGSRC_COMPILER= sunpro
1665: ABI= 64
1666: </pre>
1.41 asau 1667: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1668: <h3 class="title">Note</h3>
1669: <p>This setting has been tested for the SPARC
1670: architecture. Intel and AMD machines need some more
1671: work.</p>
1672: </div>
1673: </div>
1.41 asau 1674: <div class="sect3">
1.1 dsieger 1675: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1676: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.10 hubertf 1677: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1 dsieger 1678: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1679: The workaround is to use another shell for the configure
1.79 snj 1680: 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 1681: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1682: <pre class="programlisting">
1683: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1684: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1685: </pre>
1.79 snj 1686: <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 1687: </div>
1688: </div>
1689: </div>
1690: </div>
1.41 asau 1691: <div class="chapter">
1.1 dsieger 1692: <div class="titlepage"><div><div><h2 class="title">
1693: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1694: <div class="toc">
1695: <p><b>Table of Contents</b></p>
1.100 leot 1696: <dl class="toc">
1.1 dsieger 1697: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1698: <dd><dl>
1699: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1700: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1701: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1702: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1703: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1704: <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>
1705: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1706: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1707: </dl></dd>
1708: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1709: <dd><dl>
1710: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1711: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1712: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1713: </dl></dd>
1714: </dl>
1715: </div>
1716: <p>Basically, there are two ways of using pkgsrc. The first
1717: is to only install the package tools and to use binary packages
1.23 wiz 1718: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1719: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1720: of pkgsrc, too. Then you are able to build your own packages,
1721: and you can still use binary packages from someone else.</p>
1.41 asau 1722: <div class="sect1">
1.1 dsieger 1723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1724: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1725: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1726: server and its mirrors, there are collections of binary packages,
1727: ready to be installed. These binary packages have been built using the
1728: default settings for the directories, that is:</p>
1.41 asau 1729: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1730: <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>
1731: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1732: <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 1733: </ul></div>
1734: <p>If you cannot use these directories for whatever reasons (maybe
1735: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1736: 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 1737: <div class="sect2">
1.1 dsieger 1738: <div class="titlepage"><div><div><h3 class="title">
1739: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1740: <p>To install binary packages, you first need to know from where
1741: to get them. The first place where you should look is on the main
1.10 hubertf 1742: 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 1743: <p>This directory contains binary packages for multiple
1744: platforms. First, select your operating system. (Ignore the
1745: directories with version numbers attached to it, they just exist for
1746: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1747: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1748: <p>In this directory, you often find a file called
1749: <code class="filename">bootstrap.tar.gz</code> which contains the package
1750: management tools. If the file is missing, it is likely that your
1751: operating system already provides those tools. Download the file and
1752: extract it in the <code class="filename">/</code> directory. It will create
1753: the directories <code class="filename">/usr/pkg</code> (containing the tools
1754: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1755: (the database of installed packages).</p>
1.1 dsieger 1756: </div>
1.41 asau 1757: <div class="sect2">
1.1 dsieger 1758: <div class="titlepage"><div><div><h3 class="title">
1759: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1760: <p>In the directory from the last section, there is a
1.85 wiz 1761: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1762: binary packages that are available for the platform, excluding those
1763: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1764: medium you are using).</p>
1.9 rillig 1765: <p>To install packages directly from an FTP or HTTP server, run
1766: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1767: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1768: <pre class="screen">
1769: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85 wiz 1770: <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 1771: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1772: </pre>
1773: <p>Instead of URLs, you can also use local paths, for example if
1774: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1775: repository. If you want to install packages from multiple sources,
1776: you can separate them by a semicolon in
1777: <code class="varname">PKG_PATH</code>.</p>
1778: <p>After these preparations, installing a package is very
1779: easy:</p>
1780: <pre class="screen">
1781: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1782: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1783: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1784: </pre>
1.1 dsieger 1785: <p>Note that any prerequisite packages needed to run the
1786: package in question will be installed, too, assuming they are
1787: present where you install from.</p>
1.23 wiz 1788: <p>Adding packages might install vulnerable packages.
1789: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1790: regularly, especially after installing new packages, and verify
1791: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1792: <p>After you've installed packages, be sure to have
1793: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1794: <code class="varname">PATH</code> so you can actually start the just
1795: installed program.</p>
1796: </div>
1.41 asau 1797: <div class="sect2">
1.1 dsieger 1798: <div class="titlepage"><div><div><h3 class="title">
1799: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1800: <p>To deinstall a package, it does not matter whether it was
1801: installed from source code or from a binary package. The
1.10 hubertf 1802: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1803: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1804: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1805: name can be given with or without version number. Wildcards can
1806: also be used to deinstall a set of packages, for example
1807: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1808: so that the shell does not expand them before
1809: <code class="literal">pkg_delete</code> sees them.</p>
1810: <p>The <code class="option">-r</code> option is very powerful: it
1811: removes all the packages that require the package in question
1812: and then removes the package itself. For example:
1813:
1814: </p>
1815: <pre class="screen">
1816: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1817: </pre>
1818: <p>
1819:
1820: will remove jpeg and all the packages that used it; this allows
1821: upgrading the jpeg package.</p>
1822: </div>
1.41 asau 1823: <div class="sect2">
1.1 dsieger 1824: <div class="titlepage"><div><div><h3 class="title">
1825: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1826: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1827: installed packages or binary package files.</p>
1828: </div>
1.41 asau 1829: <div class="sect2">
1.1 dsieger 1830: <div class="titlepage"><div><div><h3 class="title">
1831: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1832: <p>
1833: The NetBSD Security-Officer and Packages Groups maintain a list of
1834: known security vulnerabilities to packages which are (or have been)
1835: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1836: 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 1837: </p>
1838: <p>
1.22 jakllsch 1839: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1840: this list can be downloaded
1841: automatically, and a security audit of all packages installed on a system
1842: can take place.
1843: </p>
1844: <p>
1.22 jakllsch 1845: There are two components to auditing. The first
1846: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1847: is for downloading
1.1 dsieger 1848: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1849: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1850: installed packages are vulnerable. If a package is vulnerable, you
1851: will see output similar to the following:
1852: </p>
1853: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1854: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1855: <p>
1.22 jakllsch 1856: You may wish to have the
1.10 hubertf 1857: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1858: file downloaded daily so that
1859: it remains current. This may be done by adding an appropriate entry
1.79 snj 1860: 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 1861: </p>
1862: <pre class="screen">
1863: # download vulnerabilities file
1864: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1865: </pre>
1866: <p>
1867: will update the vulnerability list every day at 3AM. You may wish to do
1868: this more often than once a day.
1869:
1870: In addition, you may wish to run the package audit from the daily
1871: security script. This may be accomplished by adding the following
1872: line to <code class="filename">/etc/security.local</code>:
1873: </p>
1874: <pre class="screen">
1875: /usr/sbin/pkg_admin audit
1876: </pre>
1877: <p>
1.1 dsieger 1878: </p>
1879: </div>
1.41 asau 1880: <div class="sect2">
1.1 dsieger 1881: <div class="titlepage"><div><div><h3 class="title">
1882: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1883: <p>
1.79 snj 1884: 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 1885: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1886: argument to check if your packages are up-to-date, e.g.
1887: </p>
1888: <pre class="screen">
1889: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1890: ...
1891: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1892: </pre>
1.10 hubertf 1893: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1894: package on your system and rebuild any dependencies.
1895: </p>
1896: </div>
1.41 asau 1897: <div class="sect2">
1.1 dsieger 1898: <div class="titlepage"><div><div><h3 class="title">
1899: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1900: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1901: administrative functions on the package system.</p>
1902: </div>
1.41 asau 1903: <div class="sect2">
1.1 dsieger 1904: <div class="titlepage"><div><div><h3 class="title">
1905: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1906: <p>Please pay very careful attention to the warnings
1.79 snj 1907: 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 1908: inherent dangers of installing binary packages which you did
1909: not create yourself, and the security holes that can be
1910: introduced onto your system by indiscriminate adding of such
1911: files.</p>
1912: <p>The same warning of course applies to every package you
1913: install from source when you haven't completely read and
1914: understood the source code of the package, the compiler that
1915: is used to build the package and all the other tools that are
1916: involved.</p>
1917: </div>
1918: </div>
1.41 asau 1919: <div class="sect1">
1.1 dsieger 1920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1921: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1922: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1923: directory now contains a set of packages, organized into
1924: categories. You can browse the online index of packages, or run
1.10 hubertf 1925: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1926: directory to build local <code class="filename">README.html</code> files for
1.79 snj 1927: 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 1928: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1929: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1930: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1931: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1932: different <code class="varname">LOCALBASE</code> definitions on the same
1933: system (inside a chroot is an exception). </p>
1934: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1935: 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 1936: instructions how to create your own packages.</p>
1.41 asau 1937: <div class="sect2">
1.1 dsieger 1938: <div class="titlepage"><div><div><h3 class="title">
1939: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1940: <p>To build packages from source, you need a working C
1941: compiler. On NetBSD, you need to install the
1.23 wiz 1942: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1943: sets. If you want to build X11-related packages, the
1.23 wiz 1944: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1945: sets are required, too.</p>
1946: </div>
1.41 asau 1947: <div class="sect2">
1.1 dsieger 1948: <div class="titlepage"><div><div><h3 class="title">
1949: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1950: <p>The first step for building a package is downloading the
1951: distfiles (i.e. the unmodified source). If they have not yet been
1952: downloaded, pkgsrc will fetch them automatically.</p>
1953: <p>If you have all files that you need in the
1954: <code class="filename">distfiles</code> directory,
1955: you don't need to connect. If the distfiles are on CD-ROM, you can
1956: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1957: </p>
1958: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1959: <p>
1.10 hubertf 1960: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1961: <p>By default a list of distribution sites will be randomly
1962: intermixed to prevent huge load on servers which holding popular
1963: packages (for example, SourceForge.net mirrors). Thus, every
1964: time when you need to fetch yet another distfile all the mirrors
1965: will be tried in new (random) order. You can turn this feature
1966: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1967: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1968: <p>You can overwrite some of the major distribution sites to
1969: fit to sites that are close to your own. By setting one or two
1970: variables you can modify the order in which the master sites are
1971: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1972: delimited list of domain suffixes.
1973: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1974: contains a whitespace delimited list of regular expressions. It
1975: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1976: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1977: some examples. This may save some of your bandwidth and
1978: time.</p>
1979: <p>You can change these settings either in your shell's environment, or,
1980: if you want to keep the settings, by editing the
1.10 hubertf 1981: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1982: and adding the definitions there.</p>
1983: <p>
1984: If a package depends on many other packages (such as
1.79 snj 1985: <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 1986: alternate between periods of
1987: downloading source, and compiling. To ensure you have all the source
1988: downloaded initially you can run the command:
1989: </p>
1990: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1991: <p>
1992: which will output and run a set of shell commands to fetch the
1993: necessary files into the <code class="filename">distfiles</code> directory. You can
1994: also choose to download the files manually.
1995: </p>
1996: </div>
1.41 asau 1997: <div class="sect2">
1.1 dsieger 1998: <div class="titlepage"><div><div><h3 class="title">
1999: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
2000: <p>
2001: Once the software has downloaded, any patches will be applied, then it
2002: will be compiled for you. This may take some time depending on your
2003: computer, and how many other packages the software depends on and their
2004: compile time.
2005: </p>
1.41 asau 2006: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 2007: <h3 class="title">Note</h3>
2008: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 2009: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 2010: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 2011: </div>
2012: <p>For example, type</p>
2013: <pre class="screen">
2014: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2015: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2016: </pre>
2017: <p>at the shell prompt to build the various components of the
2018: package.</p>
2019: <p>The next stage is to actually install the newly compiled
2020: program onto your system. Do this by entering:
2021:
2022: </p>
2023: <pre class="screen">
2024: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2025: </pre>
2026: <p>
2027:
2028: while you are still in the directory for whatever package you
2029: are installing.</p>
2030: <p>Installing the package on your system may require you to
2031: be root. However, pkgsrc has a
2032: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2033: to only become root for the actual installation step.</p>
2034: <p>That's it, the software should now be installed and setup for use.
2035: You can now enter:
2036:
2037: </p>
2038: <pre class="screen">
2039: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2040: </pre>
2041: <p>
2042:
2043: to remove the compiled files in the work directory, as you shouldn't need
2044: them any more. If other packages were also added to your system
2045: (dependencies) to allow your program to compile, you can tidy these up
2046: also with the command:</p>
2047: <pre class="screen">
2048: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2049: </pre>
2050: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 2051: 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 2052: <p>The program is installed under the default root of the
2053: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2054: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2055: variable in your environment, and it will use that value as the
2056: root of your packages tree. So, to use
2057: <code class="filename">/usr/local</code>, set
2058: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2059: Please note that you should use a directory which is dedicated to
2060: packages and not shared with other programs (i.e., do not try and
2061: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2062: to add any of your own files or directories (such as
2063: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2064: <code class="filename">pkgsrc/</code>) below the
2065: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2066: conflicts between programs and other files installed by the
2067: package system and whatever else may have been installed
2068: there.</p>
1.10 hubertf 2069: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2070: alter some configuration options at build time. Have a look at
2071: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2072: of what will be set there by default. Environment variables such
2073: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 2074: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2075: set them each time you want to use pkgsrc.</p>
1.23 wiz 2076: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2077: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 2078: or being installed. This may be for debugging purposes, or out of
2079: simple curiosity. A number of utility values have been added to
2080: help with this.</p>
1.23 wiz 2081: <div class="orderedlist"><ol class="orderedlist" type="1">
2082: <li class="listitem">
1.79 snj 2083: <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 2084: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2085: information will be displayed. For example,</p>
2086: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2087: <p>will show all the commands that are invoked, up to and
1.23 wiz 2088: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 2089: </li>
1.23 wiz 2090: <li class="listitem">
1.79 snj 2091: <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 2092: definition, then the <code class="varname">VARNAME</code> definition
2093: should be used, in conjunction with the show-var
1.79 snj 2094: 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 2095: variable <code class="varname">LOCALBASE</code>:</p>
2096: <pre class="screen">
2097: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2098: /usr/pkg
2099: <code class="prompt">%</code>
2100: </pre>
2101: </li>
2102: </ol></div>
2103: <p>If you want to install a binary package that you've either
2104: created yourself (see next section), that you put into
2105: pkgsrc/packages manually or that is located on a remote FTP
2106: server, you can use the "bin-install" target. This target will
1.79 snj 2107: 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 2108: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 2109: sites searched is kept in the variable
2110: <code class="varname">BINPKG_SITES</code>, which defaults to
1.79 snj 2111: 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 2112: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2113: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2114: details.</p>
2115: <p>A final word of warning: If you set up a system that has a
2116: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2117: set that before any packages are installed, as you cannot use
2118: several directories for the same purpose. Doing so will result in
2119: pkgsrc not being able to properly detect your installed packages,
2120: and fail miserably. Note also that precompiled binary packages are
2121: usually built with the default <code class="varname">LOCALBASE</code> of
2122: <code class="filename">/usr/pkg</code>, and that you should
2123: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2124: <code class="varname">LOCALBASE</code>.</p>
2125: </div>
2126: </div>
2127: </div>
1.41 asau 2128: <div class="chapter">
1.1 dsieger 2129: <div class="titlepage"><div><div><h2 class="title">
2130: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2131: <div class="toc">
2132: <p><b>Table of Contents</b></p>
1.100 leot 2133: <dl class="toc">
1.1 dsieger 2134: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2135: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 2136: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 2137: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2138: <dd><dl>
1.4 rillig 2139: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 2140: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2141: <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 2142: </dl></dd>
1.4 rillig 2143: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2144: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2145: </dl>
2146: </div>
1.4 rillig 2147: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2148: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2149: that file depends on the installation. On NetBSD, when you use
1.79 snj 2150: <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 2151: <code class="filename">/etc/</code>. In all other cases the default location is
2152: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2153: bootstrap program to install the binary packages.</p>
2154: <p>During the bootstrap, an example configuration file is created. To
2155: use that, you have to create the directory
2156: <code class="filename">${PREFIX}/etc</code> and copy the example file
2157: there.</p>
2158: <p>The format of the configuration file is that of the usual
2159: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2160: is done by setting variables in this file. Note that you can define all
2161: kinds of variables, and no special error checking (for example for
2162: spelling mistakes) takes place, so you have to try it out to see if it
2163: works.</p>
1.41 asau 2164: <div class="sect1">
1.1 dsieger 2165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2166: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2167: <p>In this section, you can find some variables that apply to all
2168: pkgsrc packages. A complete list of the variables that can be
2169: configured by the user is available in
2170: <code class="filename">mk/defaults/mk.conf</code>, together with some
2171: comments that describe each variable's intent.</p>
1.41 asau 2172: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2173: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 2174: packages will be installed. The default is
2175: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2176: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 2177: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2178: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 2179: installed. The default is
2180: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 2181: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 2182: X11 is installed on the system. The default is
1.84 wiz 2183: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 2184: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 2185: downloaded copies of the original source distributions used
2186: for building pkgsrc packages. The default is
2187: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 2188: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 2189: database about installed packages is stored. The default is
2190: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 2191: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 2192: If set, override the packages'
2193: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 2194: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 2195: Backup location(s) for distribution files and patch files
2196: if not found locally or in
2197: <code class="filename">${MASTER_SITES}</code> or
2198: <code class="filename">${PATCH_SITES}</code> respectively.
2199: The defaults are
1.25 spz 2200: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 2201: and
2202: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 2203: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 2204: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2205: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 2206: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2207: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2208: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 2209: List of acceptable licenses. License names are case-sensitive.
2210: Whenever you try to build a package whose license is not in this
2211: list, you will get an error message. If the license condition is
2212: simple enough, the error message will include specific
2213: instructions on how to change this variable.</p></li>
1.1 dsieger 2214: </ul></div>
2215: </div>
1.41 asau 2216: <div class="sect1">
1.1 dsieger 2217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2218: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2219: <p>XXX
2220: </p>
1.41 asau 2221: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2222: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 2223: directory for the binary packages. The default is
2224: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 2225: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 2226: The top level directory where, if defined, the separate
2227: working directories will get created, and symbolically
2228: linked to from <code class="filename">${WRKDIR}</code> (see below).
2229: This is useful for building packages on several
2230: architectures, then <code class="filename">${PKGSRCDIR}</code>
2231: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2232: is local to every architecture. (It should be noted that
2233: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 2234: — it is an internal definition which refers to the
1.1 dsieger 2235: root of the pkgsrc tree. It is possible to have many
2236: pkgsrc tree instances.)</p></li>
1.23 wiz 2237: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 2238: Directory for local patches that aren't part of pkgsrc.
1.10 hubertf 2239: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2240: information.</p></li>
1.23 wiz 2241: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 2242: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2243: BSD-style Makefile. If this is not set,
2244: <code class="varname">MAKECONF</code> is set to
2245: <code class="filename">/dev/null</code> to avoid picking up
2246: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 2247: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 2248: By default, dependencies are only installed, and no binary
2249: package is created for them. You can set this variable to
1.66 asau 2250: <code class="literal">package-install</code> to automatically create binary
1.80 wiz 2251: packages after installing dependencies. Please note that the
1.84 wiz 2252: <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80 wiz 2253: <code class="literal">yes</code> to preserve binary packages when
2254: using the <code class="literal">install</code> as well.</p></li>
1.1 dsieger 2255: </ul></div>
2256: </div>
1.41 asau 2257: <div class="sect1">
1.1 dsieger 2258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 2259: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24 wiz 2260: <p>Most packages support installation into a
1.4 rillig 2261: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2262: to be built, before the actual filesystem is touched. DESTDIR
2263: support exists in two variations:</p>
1.41 asau 2264: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2265: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 2266: installation and packaging is still run as root.</p></li>
2267: <li class="listitem"><p>Full DESTDIR support can run the complete
2268: build, installation and packaging as normal user. Root
2269: privileges are only needed to add packages.</p></li>
2270: </ul></div>
2271: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2272: you can set
2273: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2274: so it's preferable to convert a package to DESTDIR instead.</p>
1.4 rillig 2275: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2276: clean</code></strong> needs to be run as root.</p>
1.17 imil 2277: <p>Considering the <code class="filename">foo/bar</code> package,
2278: DESTDIR full support can be tested using the following commands
2279:
2280: </p>
2281: <pre class="programlisting">
2282: <code class="prompt">$</code> id
2283: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2284: <code class="prompt">$</code> mkdir $HOME/packages
2285: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2286: </pre>
2287: <p>
2288:
2289: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2290: should be needed
2291:
2292: </p>
2293: <pre class="programlisting">
1.66 asau 2294: <code class="prompt">$</code> make stage-install
1.17 imil 2295: </pre>
2296: <p>
2297:
2298: Create a package without root privileges
2299:
2300: </p>
2301: <pre class="programlisting">
1.66 asau 2302: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 2303: </pre>
2304: <p>
2305:
2306: For the following command, you must be able to gain root
1.79 snj 2307: 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 2308:
2309: </p>
2310: <pre class="programlisting">
1.66 asau 2311: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 2312: </pre>
2313: <p>
2314:
2315: Then, as a simple user
2316:
2317: </p>
2318: <pre class="programlisting">
2319: <code class="prompt">$</code> make clean
2320: </pre>
2321: <p>
2322:
2323: </p>
1.4 rillig 2324: </div>
1.41 asau 2325: <div class="sect1">
1.4 rillig 2326: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2327: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 2328: <div class="sect2">
1.1 dsieger 2329: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2330: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2331: <p>By default, pkgsrc will use GCC to build packages. This may be
2332: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 2333: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2334: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2335: <dd>
2336: <p>This is a list of values specifying the chain of
2337: compilers to invoke when building packages. Valid values
2338: are:</p>
1.41 asau 2339: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 2340: <li class="listitem"><p><code class="varname">ccc</code>:
2341: Compaq C Compilers (Tru64)</p></li>
2342: <li class="listitem"><p><code class="varname">ccache</code>:
2343: compiler cache (chainable)</p></li>
2344: <li class="listitem"><p><code class="varname">clang</code>:
2345: Clang C and Objective-C compiler</p></li>
1.23 wiz 2346: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 2347: distributed C/C++ (chainable)</p></li>
1.66 asau 2348: <li class="listitem"><p><code class="varname">f2c</code>:
2349: Fortran 77 to C compiler (chainable)</p></li>
2350: <li class="listitem"><p><code class="varname">icc</code>:
2351: Intel C++ Compiler (Linux)</p></li>
2352: <li class="listitem"><p><code class="varname">ido</code>:
2353: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 2354: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 2355: GNU C/C++ Compiler</p></li>
1.66 asau 2356: <li class="listitem"><p><code class="varname">hp</code>:
2357: HP-UX C/aC++ compilers</p></li>
1.23 wiz 2358: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2359: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 2360: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 2361: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 2362: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 2363: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 2364: <li class="listitem"><p><code class="varname">xlc</code>:
2365: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 2366: </ul></div>
2367: <p>The default is
1.23 wiz 2368: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 2369: <code class="varname">ccache</code> and/or
2370: <code class="varname">distcc</code> with an appropriate
2371: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 2372: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 2373: variable should always be terminated with a value for
2374: a real compiler. Note that only one real compiler
1.23 wiz 2375: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 2376: is not allowed).</p>
2377: </dd>
2378: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2379: <dd><p>This specifies the minimum version of GCC to use
2380: when building packages. If the system GCC doesn't
2381: satisfy this requirement, then pkgsrc will build and
2382: install one of the GCC packages to use instead.</p></dd>
2383: </dl></div>
2384: </div>
1.41 asau 2385: <div class="sect2">
1.1 dsieger 2386: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2387: <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 2388: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2389: please make sure to use the <code class="literal">+=</code> operator
2390: instead of the <code class="literal">=</code> operator:</p>
2391: <pre class="programlisting">
2392: CFLAGS+= -your -flags
2393: </pre>
2394: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2395: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2396: need to add their own flags. You may want to take a look
1.79 snj 2397: 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 2398: package if you're interested in optimization specifically
2399: for the current CPU. </p>
1.1 dsieger 2400: </div>
1.41 asau 2401: <div class="sect2">
1.1 dsieger 2402: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2403: <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 2404: <p>If you want to pass flags to the linker, both in the configure
2405: step and the build step, you can do this in two ways. Either set
2406: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2407: between the two is that <code class="varname">LIBS</code> will be appended to
2408: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2409: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2410: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2411: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2412: <code class="varname">CFLAGS</code>, if you do not wish to override these
2413: settings, use the <code class="literal">+=</code> operator:</p>
2414: <pre class="programlisting">
2415: LDFLAGS+= -your -linkerflags
2416: </pre>
2417: </div>
2418: </div>
1.41 asau 2419: <div class="sect1">
1.1 dsieger 2420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2421: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 2422: <p>
1.1 dsieger 2423: </p>
1.41 asau 2424: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2425: <li class="listitem">
1.1 dsieger 2426: <p><code class="varname">PKG_DEVELOPER</code>:
2427: Run some sanity checks that package developers want:
2428: </p>
1.41 asau 2429: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2430: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 2431: fuzz</p></li>
1.23 wiz 2432: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 2433: binaries will find their shared libs.</p></li>
2434: </ul></div>
2435: <p>
2436: </p>
2437: </li>
1.23 wiz 2438: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 2439: of debugging output which is displayed whilst making and
2440: installing the package. The default value for this is 0,
2441: which will not display the commands as they are executed
2442: (normal, default, quiet operation); the value 1 will display
2443: all shell commands before their invocation, and the value 2
2444: will display both the shell commands before their invocation,
1.10 hubertf 2445: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 2446: -x</strong></span> will be displayed.</p></li>
2447: </ul></div>
2448: <p>
2449: </p>
2450: </div>
1.41 asau 2451: <div class="sect1">
1.1 dsieger 2452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2453: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2454: <p>Some packages have build time options, usually to select
2455: between different dependencies, enable optional support for big
2456: dependencies or enable experimental features.</p>
2457: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2458: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2459: show-options</strong></span>, for example:</p>
2460: <pre class="programlisting">
2461: The following options are supported by this package:
2462: ssl Enable SSL support.
2463: Exactly one of the following gecko options is required:
2464: firefox Use firefox as gecko rendering engine.
2465: mozilla Use mozilla as gecko rendering engine.
2466: At most one of the following database options may be selected:
2467: mysql Enable support for MySQL database.
2468: pgsql Enable support for PostgreSQL database.
2469:
2470: These options are enabled by default: firefox
2471: These options are currently enabled: mozilla ssl
2472: </pre>
2473: <p>The following variables can be defined in
1.10 hubertf 2474: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2475: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2476: which can be used to select or disable options for all packages
2477: that support them, and
2478: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2479: which can be used to select or disable options specifically for
2480: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2481: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2482: are disabled. A few examples:</p>
2483: <pre class="screen">
1.10 hubertf 2484: <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 2485: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2486: PKG_OPTIONS.kdebase= debug -sasl
2487: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2488: <p>It is important to note that options that were specifically
1.18 snj 2489: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2490: you do not wish to include the option. If you are unsure you can view
2491: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2492: <p>The following settings are consulted in the order given, and
2493: the last setting that selects or disables an option is
2494: used:</p>
1.23 wiz 2495: <div class="orderedlist"><ol class="orderedlist" type="1">
2496: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2497: maintainer</p></li>
1.23 wiz 2498: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2499: variables (see below)</p></li>
1.23 wiz 2500: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2501: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2502: </ol></div>
2503: <p>For groups of mutually exclusive options, the last option
2504: selected is used, all others are automatically disabled. If an
2505: option of the group is explicitly disabled, the previously
2506: selected option, if any, is used. It is an error if no option
2507: from a required group of options is selected, and building the
2508: package will fail.</p>
2509: <p>Before the options framework was introduced, build options
2510: were selected by setting a variable (often named
2511: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2512: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2513: transition to the options framework for the user, these legacy
2514: variables are converted to the appropriate options setting
2515: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2516: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2517: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2518: directly. Support for the legacy variables will be removed
2519: eventually.</p>
2520: </div>
2521: </div>
1.41 asau 2522: <div class="chapter">
1.1 dsieger 2523: <div class="titlepage"><div><div><h2 class="title">
2524: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2525: <div class="toc">
2526: <p><b>Table of Contents</b></p>
1.100 leot 2527: <dl class="toc">
1.1 dsieger 2528: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2529: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2530: </dl>
2531: </div>
1.41 asau 2532: <div class="sect1">
1.1 dsieger 2533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2534: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2535: <p>Once you have built and installed a package, you can create
2536: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.79 snj 2537: 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 2538: the same package on a group of hosts and wasting CPU time. It also
2539: provides a simple means for others to install your package, should
2540: you distribute it.</p>
2541: <p>To create a binary package, change into the appropriate
1.10 hubertf 2542: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2543: package</strong></span>:</p>
2544: <pre class="screen">
2545: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2546: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2547: </pre>
2548: <p>This will build and install your package (if not already done),
2549: and then build a binary package from what was installed. You can
1.10 hubertf 2550: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2551: it. Binary packages are created by default in
2552: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2553: 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 2554: 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 2555: <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 2556: such a binary package.</p>
2557: </div>
1.41 asau 2558: <div class="sect1">
1.1 dsieger 2559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2560: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2561: <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 2562: </div>
2563: </div>
1.41 asau 2564: <div class="chapter">
1.6 rillig 2565: <div class="titlepage"><div><div><h2 class="title">
2566: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2567: builds)</h2></div></div></div>
2568: <div class="toc">
2569: <p><b>Table of Contents</b></p>
1.100 leot 2570: <dl class="toc">
1.71 wiz 2571: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2572: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2573: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2574: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2575: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2576: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2577: </dl>
2578: </div>
1.71 wiz 2579: <p>For a number of reasons you may want to build binary packages
2580: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2581: For instance, when you have multiple machines that should run the same software,
2582: it is wasted time if they all build their packages themselves from source.
2583: Or you may want to build a list of packages you want and check them before
2584: deploying onto production system.
2585: There is a way of getting a set of binary packages:
1.66 asau 2586: The bulk build system, or pbulk ("p" stands for "parallel).
2587: This chapter describes how to set it up so that the packages
1.6 rillig 2588: are most likely to be usable later.</p>
1.41 asau 2589: <div class="sect1">
1.6 rillig 2590: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2591: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2592: <p>First of all, you have to decide whether you build all packages
2593: or a limited set of them. Full bulk builds usually consume a lot more resources,
2594: both space and time, than builds for some practical sets of packages.
2595: There exists a number of particularly heavy packages that are not actually
2596: interesting to a wide audience.
2597:
2598: For a limited bulk builds you need to make a list of packages you want to build.
2599: Note, that all their dependencies will be built, so you don't need to track them manually.
2600: </p>
2601: <p>During bulk builds various packages are installed and deinstalled
2602: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2603: so make sure that you don't need any package during the builds.
2604: Essentially, you should provide fresh system, either a chroot environment
2605: or something even more restrictive, depending on what the operating system provides,
2606: or dedicate the whole physical machine.
2607: As a useful side effect this makes sure that bulk builds cannot
2608: break anything in your system. There have been numerous cases where
1.6 rillig 2609: certain packages tried to install files outside the
2610: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2611: <code class="filename">/etc</code>.
2612: </p>
1.6 rillig 2613: </div>
1.41 asau 2614: <div class="sect1">
1.6 rillig 2615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2616: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2617: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2618: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2619: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2620: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2621: </ul></div>
1.41 asau 2622: <div class="sect2">
1.15 rillig 2623: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2624: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.68 asau 2625: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2626: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2627: Configure network access to fetch distribution files.
2628: Create user with name "pbulk".</p>
2629: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2630: <pre class="screen">
1.72 wiz 2631: <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>
2632: <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>
2633: <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 2634: </pre>
2635: <p>Or any other way that fits (e.g., curl, wget).</p>
2636: <p>Deploy and configure pbulk tools, e.g.:</p>
2637: <pre class="screen">
2638: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2639: <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>
2640: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2641: </pre>
2642: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2643: <h3 class="title">Note</h3>
2644: <p><code class="filename">mk.conf.frag</code> is a fragment of
2645: <code class="filename">mk.conf</code> that contains settings you want to
2646: apply to packages you build. For instance,</p>
2647: <pre class="programlisting">
2648: PKG_DEVELOPER= yes # perform more checks
2649: X11_TYPE= modular # use pkgsrc X11
2650: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2651: </pre>
2652: </div>
2653: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2654: with your list of packages one per line without empty lines or comments. E.g.:</p>
2655: <pre class="programlisting">
2656: www/firefox
2657: mail/thunderbird
2658: misc/libreoffice4
2659: </pre>
1.69 asau 2660: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2661: and make final amendments, if wanted.</p>
1.68 asau 2662: <p>Start it:</p>
2663: <pre class="screen">
2664: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2665: </pre>
2666: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2667: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2668: </p>
2669: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2670: <h3 class="title">Note</h3>
2671: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2672: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2673: The script is kept small enough for better understanding.</p>
2674: </div>
2675: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2676: <h3 class="title">Note</h3>
2677: <p>The <code class="filename">pbulk.sh</code> script supports running
2678: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2679: </div>
1.6 rillig 2680: </div>
2681: </div>
1.41 asau 2682: <div class="sect1">
1.6 rillig 2683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2684: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2685: <p>A complete bulk build requires lots of disk space. Some of the
2686: disk space can be read-only, some other must be writable. Some can be on
2687: remote filesystems (such as NFS) and some should be local. Some can be
2688: temporary filesystems, others must survive a sudden reboot.</p>
2689: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2690: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2691: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2692: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2693: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2694: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2695: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2696: </ul></div>
2697: </div>
2698: <div class="sect1">
2699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2700: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2701: <p>After your pkgsrc bulk-build has completed, you may wish to
2702: create a CD-ROM set of the resulting binary packages to assist
2703: in installing packages on other machines. The
1.79 snj 2704: <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 2705: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2706: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2707: way that keeps all the dependencies for a given package on the same
2708: CD as that package.</p>
1.41 asau 2709: <div class="sect2">
1.1 dsieger 2710: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2711: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2712: <p>Complete documentation for cdpack is found in the cdpack(1)
2713: man page. The following short example assumes that the binary
2714: packages are left in
2715: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2716: sufficient disk space exists in <code class="filename">/u2</code> to
2717: hold the ISO 9660 images.</p>
2718: <pre class="screen">
2719: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2720: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2721: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2722: </pre>
2723: <p>If you wish to include a common set of files
2724: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2725: etc.) on each CD in the collection, then you need to create a
2726: directory which contains these files. e.g.</p>
2727: <pre class="screen">
2728: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2729: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2730: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2731: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2732: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2733: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2734: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2735: </pre>
2736: <p>Now create the images:</p>
2737: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2738: <p>Each image will contain <code class="filename">README</code>,
2739: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2740: in their root directories.</p>
2741: </div>
2742: </div>
2743: </div>
1.41 asau 2744: <div class="chapter">
1.1 dsieger 2745: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2746: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2747: <div class="toc">
2748: <p><b>Table of Contents</b></p>
1.100 leot 2749: <dl class="toc">
1.23 wiz 2750: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2751: <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 2752: </dl>
2753: </div>
2754: <p>The files that are installed by pkgsrc are organized in a way that
2755: is similar to what you find in the <code class="filename">/usr</code> directory
2756: of the base system. But some details are different. This is because
2757: pkgsrc initially came from FreeBSD and had adopted its file system
2758: hierarchy. Later it was largely influenced by NetBSD. But no matter
2759: which operating system you are using pkgsrc with, you can expect the
2760: same layout for pkgsrc.</p>
2761: <p>There are mainly four root directories for pkgsrc, which are all
2762: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2763: When pkgsrc has been installed as root, the default locations
2764: are:</p>
2765: <pre class="programlisting">
2766: LOCALBASE= /usr/pkg
2767: PKG_SYSCONFBASE= /usr/pkg/etc
2768: VARBASE= /var
2769: PKG_DBDIR= /var/db/pkg
2770: </pre>
2771: <p>In unprivileged mode (when pkgsrc has been installed as any other
2772: user), the default locations are:</p>
2773: <pre class="programlisting">
2774: LOCALBASE= ${HOME}/pkg
2775: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2776: VARBASE= ${HOME}/pkg/var
2777: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2778: </pre>
2779: <p>What these four directories are for, and what they look like is
2780: explained below.</p>
1.41 asau 2781: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2782: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2783: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2784: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2785: the well-known subdirectories like <code class="filename">bin</code>,
2786: <code class="filename">include</code>, <code class="filename">lib</code>,
2787: <code class="filename">share</code> and
2788: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2789: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2790: <code class="filename">/var</code> in the base system. Some programs (especially
2791: games, network daemons) need write access to it during normal
2792: operation.</p></li>
1.23 wiz 2793: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2794: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2795: 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 2796: itself.</p></li>
2797: </ul></div>
1.41 asau 2798: <div class="sect1">
1.1 dsieger 2799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2800: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2801: </h2></div></div></div>
2802: <p>The following directories exist in a typical pkgsrc installation
2803: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2804: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2805: <dt><span class="term"><code class="filename">bin</code></span></dt>
2806: <dd><p>Contains executable programs that are intended to be
2807: directly used by the end user.</p></dd>
2808: <dt><span class="term"><code class="filename">emul</code></span></dt>
2809: <dd><p>Contains files for the emulation layers of various other
2810: operating systems, especially for
2811: NetBSD.</p></dd>
2812: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2813: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2814: <dd><p>Contains
2815: the configuration files.</p></dd>
2816: <dt><span class="term"><code class="filename">include</code></span></dt>
2817: <dd><p>Contains headers for the C and C++ programming
2818: languages.</p></dd>
2819: <dt><span class="term"><code class="filename">info</code></span></dt>
2820: <dd><p>Contains GNU info files of various
2821: packages.</p></dd>
2822: <dt><span class="term"><code class="filename">lib</code></span></dt>
2823: <dd><p>Contains shared and static
2824: libraries.</p></dd>
2825: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2826: <dd><p>Contains data files that don't change after
2827: installation. Other data files belong into
2828: <code class="filename">${VARBASE}</code>.</p></dd>
2829: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2830: <dd><p>Contains programs that are not intended to be used by
2831: end users, such as helper programs or network
2832: daemons.</p></dd>
2833: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2834: <dd><p>Contains programs that are intended to be executed as
2835: CGI scripts by a web server.</p></dd>
2836: <dt><span class="term"><code class="filename">man</code> (the usual value of
2837: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2838: <dd><p>Contains brief
2839: documentation in form of manual pages.</p></dd>
2840: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2841: <dd><p>Contains programs that are intended to be used only by
2842: the super-user.</p></dd>
2843: <dt><span class="term"><code class="filename">share</code></span></dt>
2844: <dd><p>Contains platform-independent data files that don't
2845: change after installation.</p></dd>
2846: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2847: <dd><p>Contains documentation files provided by the
2848: packages.</p></dd>
2849: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2850: <dd><p>Contains example files provided by the packages. Among
2851: others, the original configuration files are saved here and copied to
2852: <code class="filename">${PKG_SYSCONFDIR}</code> during
2853: installation.</p></dd>
2854: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2855: <dd><p>Contains the original files for rc.d
2856: scripts.</p></dd>
2857: <dt><span class="term"><code class="filename">var</code> (the usual location of
2858: <code class="filename">${VARBASE}</code>)</span></dt>
2859: <dd><p>Contains files
2860: that may be modified after
2861: installation.</p></dd>
2862: </dl></div>
2863: </div>
1.41 asau 2864: <div class="sect1">
1.1 dsieger 2865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2866: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2867: </h2></div></div></div>
1.41 asau 2868: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2869: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2870: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2871: <dd><p>Contains
2872: information about the currently installed
2873: packages.</p></dd>
2874: <dt><span class="term"><code class="filename">games</code></span></dt>
2875: <dd><p>Contains highscore
2876: files.</p></dd>
2877: <dt><span class="term"><code class="filename">log</code></span></dt>
2878: <dd><p>Contains log files.</p></dd>
2879: <dt><span class="term"><code class="filename">run</code></span></dt>
2880: <dd><p>Contains informational files about daemons that are
2881: currently running.</p></dd>
2882: </dl></div>
2883: </div>
2884: </div>
1.41 asau 2885: <div class="chapter">
1.1 dsieger 2886: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2887: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2888: <div class="toc">
2889: <p><b>Table of Contents</b></p>
1.100 leot 2890: <dl class="toc">
1.6 rillig 2891: <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 2892: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
2893: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
2894: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
2895: <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>
2896: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
2897: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
2898: <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>
2899: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
2900: <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 2901: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.84 wiz 2902: <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>
2903: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
2904: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
2905: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
2906: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2907: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
2908: <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 2909: </dl>
2910: </div>
2911: <p>This section contains hints, tips & tricks on special things in
2912: pkgsrc that we didn't find a better place for in the previous chapters, and
2913: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2914: <div class="sect1">
1.1 dsieger 2915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2916: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2917: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2918: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2919: <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 2920: This is a general purpose list for most issues regarding
2921: pkgsrc, regardless of platform, e.g. soliciting user help
2922: for pkgsrc configuration, unexpected build failures, using
2923: particular packages, upgrading pkgsrc installations,
2924: questions regarding the pkgsrc release branches, etc. General announcements or
2925: proposals for changes that impact the pkgsrc user community,
2926: e.g. major infrastructure changes, new features, package
2927: removals, etc., may also be posted.</p></li>
1.23 wiz 2928: <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 2929: A list where the results of pkgsrc bulk builds are sent and
2930: discussed.</p></li>
1.23 wiz 2931: <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 2932: This list is for those who are interested in getting a
2933: commit message for every change committed to pkgsrc. It is
2934: also available in digest form, meaning one daily message
2935: containing all commit messages for changes to the package
2936: source tree in that 24 hour period.</p></li>
2937: </ul></div>
2938: <p>To subscribe, do:</p>
2939: <pre class="programlisting">
2940: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2941: </pre>
2942: <p>Archives for all these mailing lists are available from
1.10 hubertf 2943: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2944: </div>
1.41 asau 2945: <div class="sect1">
1.1 dsieger 2946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 2947: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2948: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2949: a number of useful utilities for both users and developers of pkgsrc. This
2950: section attempts only to make the reader aware of the utilities and when
2951: they might be useful, and not to duplicate the documentation that comes
2952: with each package.</p>
2953: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.79 snj 2954: <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 2955: Symlinks for use by buildlink.</p></li></ul></div>
2956: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2957: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2958: <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 2959: Calculates various kinds of checksums (including SHA1).</p></li>
1.79 snj 2960: <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 2961: Compatibility library for pkgsrc tools.</p></li>
1.79 snj 2962: <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 2963: non-BSD systems due to lack of native mtree.</p></li>
1.79 snj 2964: <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 2965: Up-to-date replacement for
2966: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2967: systems where pkg_install is not present.</p></li>
2968: </ul></div>
2969: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2970: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2971: <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 2972: Create a binary package from an
1.10 hubertf 2973: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2974: save the old package.</p></li>
1.79 snj 2975: <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 2976: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2977: from multiple locations. It currently supports the following
2978: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.79 snj 2979: <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 2980: the best compiler flags to optimise code for your current
1.23 wiz 2981: CPU and compiler. </p></li>
1.1 dsieger 2982: </ul></div>
2983: <p>Utilities for keeping track of installed packages, being up to date,
2984: etc:</p>
1.41 asau 2985: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 2986: <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 2987: update tool similar to apt(1). Download, install, and upgrade
2988: binary packages easily.</p></li>
1.79 snj 2989: <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 2990: packages whose installed versions do not match the latest pkgsrc
2991: entries.</p></li>
1.79 snj 2992: <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 2993: dependency graphs of packages, to aid in choosing a strategy for
2994: updating.</p></li>
1.79 snj 2995: <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
2996: 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>
2997: <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 2998: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.79 snj 2999: <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 3000: does various checks on the complete pkgsrc system.</p></li>
1.79 snj 3001: <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 3002: packages you have installed.</p></li>
3003: </ul></div>
3004: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 3005: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 3006: <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 3007: making and maintaining patches for a package (includes pkgdiff,
3008: pkgvi, mkpatches, etc.).</p></li>
1.79 snj 3009: <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 3010: converting to pkgsrc.</p></li>
3011: </ul></div>
3012: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3013: utilities)</p>
1.41 asau 3014: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 3015: <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 3016: packages in a chrooted area.</p></li>
1.79 snj 3017: <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 3018: kernel version for chrooted cross builds.</p></li>
3019: </ul></div>
3020: </div>
1.41 asau 3021: <div class="sect1">
1.1 dsieger 3022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3023: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3024: <p>If you want to use pkgsrc as non-root user, you can set some
3025: variables to make pkgsrc work under these conditions. At the very least,
1.23 wiz 3026: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.1 dsieger 3027: will turn on unprivileged mode and set multiple related variables to allow
3028: installation of packages as non-root.</p>
3029: <p>In case the defaults are not enough, you may want to tune some other
3030: variables used. For example, if the automatic user/group detection leads
3031: to incorrect values (or not the ones you would like to use), you can change
3032: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3033: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3034: <p>As regards bootstrapping, please note that the
1.10 hubertf 3035: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23 wiz 3036: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.1 dsieger 3037: use multiple default directories under <code class="filename">~/pkg</code> as the
3038: installation targets. These directories can be overridden by the
1.23 wiz 3039: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.1 dsieger 3040: that allow finer tuning of the tree layout.</p>
3041: </div>
1.41 asau 3042: <div class="sect1">
1.1 dsieger 3043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3044: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3045: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3046: enable this feature by adding the option
3047: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 3048: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3049: distfile is found, pkgsrc will try to resume it.</p>
3050: <p>You can also
1.61 wiz 3051: use a different program than the platform default program by changing the
1.16 jnemeth 3052: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3053: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3054: by using the value manual. A value of custom disables the system defaults
3055: and dependency tracking for the fetch program. In that case you have to
3056: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3057: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3058: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 3059: <p>For example, if you want to use
1.16 jnemeth 3060: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 3061: like:</p>
3062: <pre class="programlisting">
1.16 jnemeth 3063: FETCH_USING= wget
1.1 dsieger 3064: </pre>
3065: </div>
1.41 asau 3066: <div class="sect1">
1.1 dsieger 3067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3068: <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 3069: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3070: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3071: you will have to add the following line into
1.10 hubertf 3072: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3073: <pre class="programlisting">
1.4 rillig 3074: X11_TYPE=modular
1.1 dsieger 3075: </pre>
1.41 asau 3076: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 3077: <h3 class="title">Note</h3>
1.4 rillig 3078: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3079: </p>
1.1 dsieger 3080: </div>
3081: </div>
1.41 asau 3082: <div class="sect1">
1.1 dsieger 3083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3084: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3085: <p>If you are sitting behind a firewall which does not allow direct
3086: connections to Internet hosts (i.e. non-NAT), you may specify the
3087: relevant proxy hosts. This is done using an environment variable in the
3088: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 3089: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3090: port 80 as the proxy port number. So the proxy environment variables
3091: are:</p>
3092: <pre class="programlisting">
3093: ftp_proxy=ftp://orpheus.amdahl.com:80/
3094: http_proxy=http://orpheus.amdahl.com:80/
3095: </pre>
3096: </div>
1.41 asau 3097: <div class="sect1">
1.1 dsieger 3098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3099: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 3100: <p>Some fetch tools are not prepared to support HTTPS by default
3101: (for example, the one in NetBSD 6.0), or the one installed by the
3102: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3103: dependency graph).</p>
3104: <p>Usually you won't notice, because distribution files are
3105: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3106: be often enough if you are following pkgsrc-current. In that case, set
3107: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3108: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3109: with HTTPS support by default. Of course, these tools need to be
3110: installed before you can use them this way.</p>
3111: </div>
3112: <div class="sect1">
3113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3114: <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 3115: <p>This depends on which utility is used to retrieve distfiles. From
3116: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3117: the first available command from the following list:</p>
1.41 asau 3118: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3119: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3120: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3121: </ul></div>
3122: <p>On a default NetBSD installation, this will be
3123: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3124: connections first, and falls back to active connections if the server
3125: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3126: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3127: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3128: <p>Having that option present will prevent
3129: <code class="filename">/usr/bin/ftp</code> from falling back to active
3130: transfers.</p>
3131: </div>
1.41 asau 3132: <div class="sect1">
1.1 dsieger 3133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3134: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3135: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3136: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3137: 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 3138: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3139: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3140: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3141: resulting list to your machine at work/school and use it there. If you
1.79 snj 3142: 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 3143: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3144: URL:</p>
3145: <p>At home:</p>
3146: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3147: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3148: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3149: <p>At work:</p>
3150: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3151: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3152: home.</p>
3153: <p>If you have a machine running NetBSD, and you want to get
3154: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3155: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3156: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3157: directly by running:</p>
3158: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3159: <p>If you even decide to ignore
3160: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3161: by running:</p>
3162: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3163: </div>
1.41 asau 3164: <div class="sect1">
1.1 dsieger 3165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3166: <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 3167: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.79 snj 3168: <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 3169: package, you get the error from make that it doesn't know how to make
3170: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3171: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3172: the NetBSD base distribution on your machine. It is recommended to do
3173: that to format man pages.</p>
1.79 snj 3174: <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 3175: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3176: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3177: </div>
1.41 asau 3178: <div class="sect1">
1.1 dsieger 3179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3180: <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 3181: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3182: when you installed your NetBSD machine. Please get and install it, by
3183: extracting it in <code class="filename">/</code>:</p>
3184: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3185: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3186: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3187: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3188: -r</strong></span>).</p>
3189: </div>
1.41 asau 3190: <div class="sect1">
1.1 dsieger 3191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3192: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3193: <p>When installing packages as non-root user and using the just-in-time
1.79 snj 3194: <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 3195: password for each required package installed. To avoid this, the sudo
3196: package can be used, which does password caching over a limited time. To
3197: use it, install sudo (either as binary package or from
1.79 snj 3198: <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 3199: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3200: <span class="emphasis"><em>after</em></span> the definition of the
3201: <code class="varname">LOCALBASE</code> variable:</p>
3202: <pre class="programlisting">
3203: .if exists(${LOCALBASE}/bin/sudo)
3204: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3205: .endif
3206: </pre>
3207: </div>
1.41 asau 3208: <div class="sect1">
1.1 dsieger 3209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3210: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3211: <p>As the system administrator, you can choose where configuration files
3212: are installed. The default settings make all these files go into
3213: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3214: be suboptimal depending on your expectations (e.g., a read-only,
3215: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3216: configuration of the provided packages).</p>
3217: <p>In order to change the defaults, you can modify the
3218: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3219: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3220: directory; some common examples include <code class="filename">/etc</code> or
3221: <code class="filename">/etc/pkg</code>.</p>
3222: <p>Furthermore, you can change this value on a per-package basis by
3223: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3224: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3225: package you would like to modify, that is, the contents of
3226: <code class="varname">PKGBASE</code>.</p>
3227: <p>Note that after changing these settings, you must rebuild and
3228: reinstall any affected packages.</p>
3229: </div>
1.41 asau 3230: <div class="sect1">
1.1 dsieger 3231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3232: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3233: <p>Please be aware that there can often be bugs in third-party software,
3234: and some of these bugs can leave a machine vulnerable to exploitation by
3235: attackers. In an effort to lessen the exposure, the NetBSD packages team
3236: maintains a database of known-exploits to packages which have at one time
3237: been included in pkgsrc. The database can be downloaded automatically, and
3238: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3239: do this, refer to the following two tools (installed as part of the
1.79 snj 3240: <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 3241: <div class="orderedlist"><ol class="orderedlist" type="1">
3242: <li class="listitem">
1.20 snj 3243: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3244: download a list of the security vulnerabilities information. This list
1.25 spz 3245: is kept up to date by the pkgsrc security team, and is distributed
3246: from the NetBSD ftp server:</p>
3247: <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 3248: </li>
1.23 wiz 3249: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3250: current machine, checking each known vulnerability. If a
1.1 dsieger 3251: vulnerable package is installed, it will be shown by output to stdout,
3252: including a description of the type of vulnerability, and a URL
3253: containing more information.</p></li>
3254: </ol></div>
1.14 jmcneill 3255: <p>Use of these tools is strongly recommended! After
1.23 wiz 3256: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 3257: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 3258: pkg_install</code></strong>.</p>
1.1 dsieger 3259: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 3260: 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 3261: check.</p>
3262: </div>
1.41 asau 3263: <div class="sect1">
1.1 dsieger 3264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3265: <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 3266: <p>When you add your own preferences to the
3267: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3268: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3269: environment variables to the <code class="filename">./configure</code>
1.79 snj 3270: 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 3271: <code class="varname">CFLAGS</code> from the environment variable by
3272: overriding them in the <code class="filename">Makefile</code>s of their
3273: package.</p>
3274: <p>Currently there is no solution to this problem. If you
3275: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3276: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3277: directory and then inspect any <code class="filename">Makefile</code> and
3278: <code class="filename">Makefile.in</code> for whether they define
3279: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3280: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3281: programmers write so bad code that it only works for the
3282: specific combination of <code class="varname">CFLAGS</code> they have
3283: chosen.</p>
3284: </div>
1.41 asau 3285: <div class="sect1">
1.1 dsieger 3286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3287: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3288: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3289: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3290: case that occurs often is that people only update pkgsrc in
3291: parts, because of performance reasons. Since pkgsrc is one large
3292: system, not a collection of many small systems, there are
3293: sometimes changes that only work when the whole pkgsrc tree is
3294: updated.</p></li>
1.41 asau 3295: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3296: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3297: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3298: files.</p></li>
1.41 asau 3299: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3300: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3301: verify this.</p></li>
1.41 asau 3302: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3303: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3304: </ol></div>
3305: </div>
1.41 asau 3306: <div class="sect1">
1.1 dsieger 3307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84 wiz 3308: <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 3309: <p>You have modified a file from pkgsrc, and someone else has
3310: modified that same file afterwards in the CVS repository. Both changes
3311: are in the same region of the file, so when you updated pkgsrc, the
3312: <code class="literal">cvs</code> command marked the conflicting changes in the
3313: file. Because of these markers, the file is no longer a valid
3314: <code class="filename">Makefile</code>.</p>
3315: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3316: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3317: -dP</strong></span> in that directory to download the current version.</p>
3318: </div>
3319: </div>
3320: </div>
1.41 asau 3321: <div class="part">
1.1 dsieger 3322: <div class="titlepage"><div><div><h1 class="title">
3323: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3324: <div class="partintro">
1.1 dsieger 3325: <div></div>
3326: <p>This part of the book deals with creating and
1.23 wiz 3327: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3328: guide on creating a new package. The remaining chapters are more
3329: like a reference manual for pkgsrc.</p>
3330: <div class="toc">
3331: <p><b>Table of Contents</b></p>
1.100 leot 3332: <dl class="toc">
1.6 rillig 3333: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3334: <dd><dl>
1.6 rillig 3335: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3336: <dd><dl>
1.6 rillig 3337: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3338: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3339: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3340: </dl></dd>
1.6 rillig 3341: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3342: <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>
3343: </dl></dd>
3344: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3345: <dd><dl>
1.23 wiz 3346: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3347: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3348: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3349: <dd><dl>
3350: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3351: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3352: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3353: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3354: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3355: </dl></dd>
3356: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3357: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3358: <dd><dl>
3359: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3360: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3361: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3362: </dl></dd>
1.23 wiz 3363: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3364: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3365: </dl></dd>
1.23 wiz 3366: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3367: <dd><dl>
3368: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 3369: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 3370: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3371: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3372: <dd><dl>
3373: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3374: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3375: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3376: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3377: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3378: </dl></dd>
3379: </dl></dd>
3380: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3381: <dd><dl>
3382: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 3383: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3384: <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 3385: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3386: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 3387: <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 3388: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 3389: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
3390: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3391: </dl></dd>
3392: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3393: <dd><dl>
3394: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 3395: <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 3396: <dd><dl>
3397: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 3398: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3399: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3400: and
3401: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3402: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3403: </dl></dd>
1.23 wiz 3404: <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 3405: <dd><dl>
1.23 wiz 3406: <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 3407: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3408: </dl></dd>
3409: </dl></dd>
3410: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3411: <dd><dl>
3412: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3413: <dd><dl>
3414: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3415: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3416: </dl></dd>
3417: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3418: <dd><dl>
1.23 wiz 3419: <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 3420: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3421: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3422: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3423: </dl></dd>
3424: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3425: <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>
3426: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3427: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3428: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3429: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3430: <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>
3431: </dl></dd>
3432: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3433: <dd><dl>
3434: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 3435: <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 3436: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3437: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3438: </dl></dd>
3439: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3440: <dd><dl>
3441: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3442: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3443: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3444: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 3445: <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 3446: <dd><dl>
3447: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3448: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3449: </dl></dd>
1.23 wiz 3450: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3451: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3452: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3453: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3454: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3455: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3456: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3457: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3458: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3459: <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 3460: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3461: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3462: </dl></dd>
3463: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3464: <dd><dl>
3465: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3466: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3467: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3468: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3469: </dl></dd>
3470: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3471: <dd><dl>
3472: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3473: <dd><dl>
3474: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 3475: <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 3476: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3477: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3478: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3479: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3480: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3481: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3482: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3483: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3484: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3485: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3486: </dl></dd>
1.23 wiz 3487: <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 3488: <dd><dl>
3489: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3490: <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 3491: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 3492: </dl></dd>
1.23 wiz 3493: <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 3494: <dd><dl>
3495: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3496: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3497: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3498: </dl></dd>
3499: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3500: <dd><dl>
3501: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3502: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3503: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 3504: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3505: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 3506: </dl></dd>
1.23 wiz 3507: <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 3508: <dd><dl>
3509: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3510: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 3511: <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 3512: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3513: </dl></dd>
1.23 wiz 3514: <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 3515: <dd><dl>
3516: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3517: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3518: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3519: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3520: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3521: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3522: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3523: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3524: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 3525: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 3526: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3527: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3528: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3529: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3530: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3531: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3532: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3533: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3534: emulation</a></span></dt>
1.6 rillig 3535: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3536: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3537: </dl></dd>
1.6 rillig 3538: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3539: </dl></dd>
1.6 rillig 3540: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3541: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3542: <dd><dl>
1.6 rillig 3543: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3544: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3545: <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 3546: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 3547: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 3548: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3549: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 3550: </dl></dd>
3551: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3552: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3553: <dd><dl>
3554: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3555: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3556: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3557: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3558: </dl></dd>
3559: </dl>
3560: </div>
3561: </div>
1.41 asau 3562: <div class="chapter">
1.1 dsieger 3563: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3564: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3565: <div class="toc">
3566: <p><b>Table of Contents</b></p>
1.100 leot 3567: <dl class="toc">
1.6 rillig 3568: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3569: <dd><dl>
1.6 rillig 3570: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3571: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3572: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3573: </dl></dd>
1.6 rillig 3574: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3575: <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 3576: </dl>
3577: </div>
3578: <p>When you find a package that is not yet in pkgsrc, you
3579: most likely have a URL from where you can download the source
3580: code. Starting with this URL, creating a package involves only a
3581: few steps.</p>
1.23 wiz 3582: <div class="procedure"><ol class="procedure" type="1">
1.79 snj 3583: <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 3584: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3585: category in which you want to place your package. You can also create a
3586: directory of your own (maybe called <code class="filename">local</code>). In that
3587: category directory, create another directory for your package and change
3588: into it.</p></li>
1.41 asau 3589: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3590: you for a URL. Enter the URL of the distribution file (in most cases a
3591: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3592: of your package are created automatically. The distribution file is
3593: extracted automatically to fill in some details in the
3594: <code class="filename">Makefile</code> that would otherwise have to be done
3595: manually.</p></li>
1.41 asau 3596: <li class="step">
1.1 dsieger 3597: <p>Examine the extracted files to determine the dependencies of
3598: your package. Ideally, this is mentioned in some
3599: <code class="filename">README</code> file, but things may differ. For each of
3600: these dependencies, look where it exists in pkgsrc, and if there is a
3601: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3602: line to your package <code class="filename">Makefile</code> which includes that
3603: file just before the last line. If the
1.25 spz 3604: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3605: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3606: <p>If you just need binaries from a package, add a
1.1 dsieger 3607: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3608: version of the dependency and where it can be found in pkgsrc. This line
3609: should be placed in the third paragraph. If the dependency is only
3610: needed for building the package, but not when using it, use
3611: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3612: Your package may then look like this:</p>
3613: <pre class="programlisting">
3614: [...]
3615:
1.66 asau 3616: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3617: DEPENDS+= screen-[0-9]*:../../misc/screen
3618: DEPENDS+= screen>=4.0:../../misc/screen
3619:
3620: [...]
3621:
3622: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3623: .include "../../devel/glib2/buildlink3.mk"
3624: .include "../../mk/bsd.pkg.mk"
3625: </pre>
3626: </li>
1.41 asau 3627: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3628: 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 3629: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3630: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3631: -e</strong></span>, which outputs additional
3632: explanations.</p></li>
1.41 asau 3633: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3634: 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 3635: over there, you can hopefully continue here.</p></li>
1.41 asau 3636: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3637: directory from the extracted files. Besides these files, a lot of cache
3638: files and other system information has been saved in the working
3639: directory, which may become wrong after you edited the
3640: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3641: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3642: 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 3643: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3644: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3645: everything works.</p></li>
1.41 asau 3646: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3647: contains a list of the files that are installed by the package, is
1.10 hubertf 3648: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3649: >PLIST</strong></span> to generate a probably correct list. Check
3650: the file using your preferred text editor to see if the list of
3651: files looks plausible.</p></li>
1.41 asau 3652: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3653: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3654: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3655: has been registered in the database of installed files, but with an
1.10 hubertf 3656: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3657: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3658: registered with the list of files from
3659: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3660: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3661: package from the set of installed files.</p></li>
3662: </ol></div>
1.41 asau 3663: <div class="sect1">
1.1 dsieger 3664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3665: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3666: <div class="sect2">
1.1 dsieger 3667: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3668: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3669: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3670: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3671: </div>
1.41 asau 3672: <div class="sect2">
1.1 dsieger 3673: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 3674: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3675: <p>KDE3 applications should always include
1.1 dsieger 3676: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 asau 3677: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3678: </div>
1.41 asau 3679: <div class="sect2">
1.17 imil 3680: <div class="titlepage"><div><div><h3 class="title">
3681: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3682: <p>Python modules and programs packages are easily created using a
3683: set of predefined variables.</p>
3684: <p>
1.63 wiz 3685: If some Python versions are not supported by the software, set the
3686: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3687: that are not supported, e.g.
1.17 imil 3688: </p>
3689: <pre class="programlisting">
1.93 sevan 3690: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3691: </pre>
3692: <p>
1.103 wiz 3693: If the packaged software is a Python module, include one of
3694: <code class="filename">../../lang/python/egg.mk</code>,
3695: <code class="filename">../../lang/python/distutils.mk</code>, or
3696: <code class="filename">../../lang/python/extension.mk</code>.</p>
3697: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3698: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3699: if the packaged software is using setuptools, you only need
3700: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3701: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3702: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3703: so pkgsrc will use this framework.
3704: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3705: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3706: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3707: to the name of the script.</p>
3708: <p>Either way, the package directory should be called
1.23 wiz 3709: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3710: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3711: </p>
3712: <pre class="programlisting">
3713: DISTNAME= foopymodule-1.2.10
3714: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3715: </pre>
1.63 wiz 3716: <p>If it is an application, include
3717: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3718: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3719: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3720: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3721: For example:
1.17 imil 3722: </p>
3723: <pre class="programlisting">
1.35 wiz 3724: REPLACE_PYTHON= *.py
1.17 imil 3725: </pre>
1.63 wiz 3726: <p>Some Python modules have separate distributions for Python-2.x
3727: and Python-3.x support. In pkgsrc this is handled by the
3728: <code class="filename">versioned_dependencies.mk</code> file. Set
3729: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3730: packages that should be depended upon and include
3731: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3732: then the pkgsrc infrastructure will depend on the appropriate package
3733: version. For example:
3734: </p>
3735: <pre class="programlisting">
3736: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3737: </pre>
3738: <p>
3739: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3740: of supported packages.</p>
1.17 imil 3741: </div>
1.1 dsieger 3742: </div>
1.41 asau 3743: <div class="sect1">
1.1 dsieger 3744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3745: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3746: <div class="sect2">
1.1 dsieger 3747: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3748: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3749: <div class="sect3">
1.1 dsieger 3750: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3751: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3752: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3753: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3754: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3755: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3756: <pre class="programlisting">
3757: <code class="prompt">$</code> mkdir www/nvu
3758: <code class="prompt">$</code> cd www/nvu
3759: </pre>
3760: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3761: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3762: <pre class="programlisting">
3763: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3764: </pre>
3765: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3766: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3767: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3768: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3769: <code class="varname">COMMENT</code> fields. Then the package
3770: <code class="filename">Makefile</code> looked like that:</p>
3771: <pre class="programlisting">
3772: # $NetBSD$
3773: #
3774:
3775: DISTNAME= nvu-1.0-sources
3776: PKGNAME= nvu-1.0
3777: CATEGORIES= www
3778: MASTER_SITES= http://cvs.nvu.com/download/
3779: EXTRACT_SUFX= .tar.bz2
3780:
3781: MAINTAINER= rillig@NetBSD.org
3782: HOMEPAGE= http://cvs.nvu.com/
3783: COMMENT= Web Authoring System
3784:
3785: # url2pkg-marker (please do not remove this line.)
3786: .include "../../mk/bsd.pkg.mk"
3787: </pre>
3788: <p>Then, I quit the editor and watched pkgsrc downloading a large
3789: source archive:</p>
3790: <pre class="programlisting">
3791: url2pkg> Running "make makesum" ...
3792: => Required installed package digest>=20010302: digest-20060826 found
3793: => Fetching nvu-1.0-sources.tar.bz2
3794: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3795: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3796: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3797: url2pkg> Running "make extract" ...
3798: => Required installed package digest>=20010302: digest-20060826 found
3799: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3800: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3801: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3802: ===> Installing dependencies for nvu-1.0
3803: ===> Overriding tools for nvu-1.0
3804: ===> Extracting for nvu-1.0
3805: url2pkg> Adjusting the Makefile.
3806:
3807: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3808:
3809: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3810: </pre>
3811: </div>
1.41 asau 3812: <div class="sect3">
1.1 dsieger 3813: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3814: <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 3815: <p>Now that the package has been extracted, let's see what's inside
3816: it. The package has a <code class="filename">README.txt</code>, but that only
3817: says something about mozilla, so it's probably useless for seeing what
3818: dependencies this package has. But since there is a GNU configure script
3819: in the package, let's hope that it will complain about everything it
3820: needs.</p>
3821: <pre class="programlisting">
3822: <code class="prompt">$</code> bmake
3823: => Required installed package digest>=20010302: digest-20060826 found
3824: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3825: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3826: ===> Patching for nvu-1.0
3827: ===> Creating toolchain wrappers for nvu-1.0
3828: ===> Configuring for nvu-1.0
3829: [...]
3830: configure: error: Perl 5.004 or higher is required.
3831: [...]
3832: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3833: [...]
3834: </pre>
3835: <p>That worked quite well. So I opened the package Makefile in my
3836: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3837: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3838: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3839: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3840: from scratch.</p>
3841: <pre class="programlisting">
3842: <code class="prompt">$</code> bmake clean
3843: ===> Cleaning for nvu-1.0
3844: <code class="prompt">$</code> bmake
3845: [...]
3846: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3847: GNU Make. You will not be able to build Mozilla without GNU Make.
3848: [...]
3849: </pre>
1.23 wiz 3850: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3851: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3852: <pre class="programlisting">
3853: [...]
3854: checking for GTK - version >= 1.2.0... no
3855: *** Could not run GTK test program, checking why...
3856: [...]
3857: </pre>
3858: <p>Now to the other dependencies. The first question is: Where is the
3859: GTK package hidden in pkgsrc?</p>
3860: <pre class="programlisting">
3861: <code class="prompt">$</code> echo ../../*/gtk*
3862: [many packages ...]
3863: <code class="prompt">$</code> echo ../../*/gtk
3864: ../../x11/gtk
3865: <code class="prompt">$</code> echo ../../*/gtk2
3866: ../../x11/gtk2
3867: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3868: ../../x11/gtk2/buildlink3.mk
3869: </pre>
3870: <p>The first try was definitely too broad. The second one had exactly
3871: one result, which is very good. But there is one pitfall with GNOME
3872: packages. Before GNOME 2 had been released, there were already many
3873: GNOME 1 packages in pkgsrc. To be able to continue to use these
3874: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3875: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3876: whether this was the case here, and indeed it was.</p>
3877: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3878: file, adding the dependency is very easy. I just inserted an
3879: <code class="literal">.include</code> line before the last line of the package
3880: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3881: <pre class="programlisting">
3882: [...]
3883: .include "../../x11/gtk2/buildlink3.mk"
3884: .include "../../mk/bsd.pkg.mk
3885: </pre>
1.10 hubertf 3886: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3887: was:</p>
3888: <pre class="programlisting">
3889: [...]
3890: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3891: checking for GTK - version >= 1.2.0... no
3892: *** Could not run GTK test program, checking why...
3893: *** The test program failed to compile or link. See the file config.log for the
3894: *** exact error that occured. This usually means GTK was incorrectly installed
3895: *** or that you have moved GTK since it was installed. In the latter case, you
3896: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3897: configure: error: Test for GTK failed.
3898: [...]
3899: </pre>
1.23 wiz 3900: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3901: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3902: told me that this package really wanted to have the GNOME 1 version of
3903: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3904: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3905: So I changed the <code class="literal">x11/gtk2</code> to
3906: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3907: and tried again.</p>
3908: <pre class="programlisting">
3909: [...]
1.59 jnemeth 3910: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3911: In file included from xpidl.c:42:
3912: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3913: In file included from xpidl.c:42:
3914: xpidl.h:132: error: parse error before "IDL_ns"
3915: [...]
3916: </pre>
3917: <p>The package still does not find all of its dependencies. Now the
3918: question is: Which package provides the
3919: <code class="filename">libIDL/IDL.h</code> header file?</p>
3920: <pre class="programlisting">
3921: <code class="prompt">$</code> echo ../../*/*idl*
3922: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3923: <code class="prompt">$</code> echo ../../*/*IDL*
3924: ../../net/libIDL
3925: </pre>
3926: <p>Let's take the one from the second try. So I included the
3927: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3928: again. But the error didn't change. After digging through some of the
3929: code, I concluded that the build process of the package was broken and
3930: couldn't have ever worked, but since the Mozilla source tree is quite
3931: large, I didn't want to fix it. So I added the following to the package
3932: <code class="filename">Makefile</code> and tried again:</p>
3933: <pre class="programlisting">
3934: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3935: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3936: </pre>
3937: <p>The latter line is needed because the package expects the library
3938: <code class="filename">libIDL.so</code>, but only
3939: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3940: wrapper to rewrite that on the fly.</p>
3941: <p>The next problem was related to a recent change of the FreeType
1.79 snj 3942: 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 3943: which patch files were relevant for this issue and copied them to the
3944: <code class="filename">patches</code> directory. Then I retried, fixed the
3945: patches so that they applied cleanly and retried again. This time,
3946: everything worked.</p>
3947: </div>
1.41 asau 3948: <div class="sect3">
1.1 dsieger 3949: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3950: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3951: <pre class="programlisting">
3952: <code class="prompt">$</code> bmake CHECK_FILES=no install
3953: [...]
3954: <code class="prompt">$</code> bmake print-PLIST >PLIST
3955: <code class="prompt">$</code> bmake deinstall
3956: <code class="prompt">$</code> bmake install
3957: </pre>
3958: </div>
3959: </div>
3960: </div>
3961: </div>
1.41 asau 3962: <div class="chapter">
1.1 dsieger 3963: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3964: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3965: <div class="toc">
3966: <p><b>Table of Contents</b></p>
1.100 leot 3967: <dl class="toc">
1.23 wiz 3968: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3969: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3970: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3971: <dd><dl>
3972: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3973: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3974: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3975: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3976: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3977: </dl></dd>
3978: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3979: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3980: <dd><dl>
3981: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3982: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3983: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3984: </dl></dd>
1.23 wiz 3985: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3986: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3987: </dl>
3988: </div>
3989: <p>Whenever you're preparing a package, there are a number of
3990: files involved which are described in the following
3991: sections.</p>
1.41 asau 3992: <div class="sect1">
1.1 dsieger 3993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3994: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3995: </h2></div></div></div>
3996: <p>Building, installation and creation of a binary package are all
3997: controlled by the package's <code class="filename">Makefile</code>.
3998: The <code class="filename">Makefile</code> describes various things about
3999: a package, for example from where to get it, how to configure,
4000: build, and install it.</p>
4001: <p>A package <code class="filename">Makefile</code> contains several
4002: sections that describe the package.</p>
4003: <p>In the first section there are the following variables, which
4004: should appear exactly in the order given here. The order and
4005: grouping of the variables is mostly historical and has no further
4006: meaning.</p>
1.41 asau 4007: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4008: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 4009: distribution file to be downloaded from the package's
4010: website.</p></li>
1.23 wiz 4011: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 4012: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 4013: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 4014: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
4015: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 4016: directory name together with the version number. It must match the
4017: regular expression
4018: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4019: starts with a letter or digit, and contains only letters, digits,
4020: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 4021: <li class="listitem">
1.1 dsieger 4022: <p><code class="varname">CATEGORIES</code> is a list of categories
4023: which the package fits in. You can choose any of the top-level
4024: directories of pkgsrc for it.</p>
4025: <p>Currently the following values are available for
4026: <code class="varname">CATEGORIES</code>. If more than
4027: one is used, they need to be separated by spaces:</p>
4028: <pre class="programlisting">
4029: archivers cross geography meta-pkgs security
4030: audio databases graphics misc shells
4031: benchmarks devel ham multimedia sysutils
4032: biology editors inputmethod net textproc
4033: cad emulators lang news time
4034: chat finance mail parallel wm
4035: comms fonts math pkgtools www
4036: converters games mbone print x11
4037: </pre>
4038: </li>
1.23 wiz 4039: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 4040: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4041: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4042: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 4043: <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 4044: </ul></div>
4045: <p>The second section contains information about separately
4046: downloaded patches, if any.
4047: </p>
1.41 asau 4048: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 4049: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 4050: Name(s) of additional files that contain distribution patches.
4051: There is no default. pkgsrc will look for them at
4052: <code class="varname">PATCH_SITES</code>.
4053: They will automatically be uncompressed before patching if
4054: the names end with <code class="filename">.gz</code> or
4055: <code class="filename">.Z</code>.</p></li>
1.23 wiz 4056: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 4057: Primary location(s) for distribution patch files (see
1.80 wiz 4058: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
4059: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
4060: 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
4061: help find the correct files to patch. It defaults to
4062: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 4063: </ul></div>
4064: <p>The third section contains the following variables.
4065: </p>
1.41 asau 4066: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4067: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 4068: address of the person who feels responsible for this package,
4069: and who is most likely to look at problems or questions regarding
1.79 snj 4070: 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 4071: Other developers may contact the <code class="varname">MAINTAINER</code>
4072: before making changes to the package, but are not required to
4073: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4074: to yourself. If you really can't maintain the package for future
4075: updates, set it to
1.10 hubertf 4076: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 4077: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 4078: of <code class="varname">MAINTAINER</code> when you do not want other
4079: developers to update or change the package without contacting
4080: you first. A package Makefile should contain one of
4081: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4082: not both. </p></li>
1.23 wiz 4083: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 4084: find more information about the package.</p></li>
1.23 wiz 4085: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 4086: description of the package (should not include the package
4087: name).</p></li>
4088: </ul></div>
4089: <p>Other variables that affect the build:
4090: </p>
1.41 asau 4091: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4092: <p><code class="varname">WRKSRC</code>: The directory where the
4093: interesting distribution files of the package are found. The
4094: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4095: works for most packages.</p>
4096: <p>If a package doesn't create a subdirectory for itself
4097: (most GNU software does, for instance), but extracts itself in
4098: the current directory, you should set
4099: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4100: <p>If a package doesn't create a subdirectory with the
4101: name of <code class="varname">DISTNAME</code> but some different name,
4102: set <code class="varname">WRKSRC</code> to point to the proper name in
4103: <code class="filename">${WRKDIR}</code>, for example
4104: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.79 snj 4105: <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 4106: <p>The name of the working directory created by pkgsrc is
4107: taken from the <code class="varname">WRKDIR_BASENAME</code>
4108: variable. By default, its value is
4109: <code class="filename">work</code>. If you want to use the same
4110: pkgsrc tree for building different kinds of binary packages,
4111: you can change the variable according to your needs. Two
4112: other variables handle common cases of setting
4113: <code class="varname">WRKDIR_BASENAME</code> individually. If
4114: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 4115: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4116: the host's name is attached to the directory name. If
4117: <code class="varname">OBJMACHINE</code> is defined, the platform name
4118: is attached, which might look like
4119: <code class="filename">work.i386</code> or
4120: <code class="filename">work.sparc</code>.</p>
4121: </li></ul></div>
4122: <p>Please pay attention to the following gotchas:</p>
1.41 asau 4123: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4124: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 4125: installed in compressed form by the package. For packages using
4126: BSD-style makefiles which honor MANZ, there is
4127: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 4128: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4129: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 4130: below).</p></li>
1.23 wiz 4131: <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 4132: </ul></div>
4133: </div>
1.41 asau 4134: <div class="sect1">
1.1 dsieger 4135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4136: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4137: </h2></div></div></div>
4138: <p>The <code class="filename">distinfo</code> file contains the message
4139: digest, or checksum, of each distfile needed for the package. This
4140: ensures that the distfiles retrieved from the Internet have not been
4141: corrupted during transfer or altered by a malign force to introduce
4142: a security hole. Due to recent rumor about weaknesses of digest
4143: algorithms, all distfiles are protected using both SHA1 and RMD160
4144: message digests, as well as the file size.</p>
4145: <p>The <code class="filename">distinfo</code> file also contains the
4146: checksums for all the patches found in the
1.10 hubertf 4147: <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 4148: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10 hubertf 4149: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 4150: command.</p>
4151: <p>Some packages have different sets of distfiles depending on
1.79 snj 4152: 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 4153: <code class="filename">distinfo</code> file and care should be taken when
4154: upgrading such a package to ensure distfile information is not
4155: lost.</p>
4156: </div>
1.41 asau 4157: <div class="sect1">
1.1 dsieger 4158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4159: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4160: <p>Many packages still don't work out-of-the box on the various
4161: platforms that are supported by pkgsrc. Therefore, a number of custom
4162: patch files are needed to make the package work. These patch files are
4163: found in the <code class="filename">patches/</code> directory.</p>
4164: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4165: applied to the files in <code class="varname">WRKSRC</code> directory after
1.10 hubertf 4166: 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 4167: order</a>.</p>
1.41 asau 4168: <div class="sect2">
1.1 dsieger 4169: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4170: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4171: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 4172: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 4173: problems. (To force patches to apply with fuzz you can set
4174: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4175: should contain only changes for a single file, and no file should be
4176: patched by more than one patch file. This helps to keep future
4177: modifications simple.</p>
4178: <p>Each patch file is structured as follows: In the first line,
4179: there is the RCS Id of the patch itself. The second line should be
4180: empty for aesthetic reasons. After that, there should be a comment for
4181: each change that the patch does. There are a number of standard
4182: cases:</p>
1.41 asau 4183: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4184: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 4185: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 4186: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 4187: platform and other environment (for example, the compiler) that the
4188: patch is needed for.</p></li>
4189: </ul></div>
1.24 wiz 4190: <p>In all, the patch should be commented so that any
1.1 dsieger 4191: developer who knows the code of the application can make some use of
4192: the patch. Special care should be taken for the upstream developers,
4193: since we generally want that they accept our patches, so we have less
4194: work in the future.</p>
4195: </div>
1.41 asau 4196: <div class="sect2">
1.1 dsieger 4197: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4198: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4199: <p>One important thing to mention is to pay attention that no RCS
4200: IDs get stored in the patch files, as these will cause problems when
4201: later checked into the NetBSD CVS tree. Use the
1.79 snj 4202: <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 4203: problems.</p>
4204: <p>For even more automation, we recommend using
1.10 hubertf 4205: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4206: whole set of patches. You just have to backup files before you
4207: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4208: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4209: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4210: you upgrade a package this way, you can easily compare the new
4211: set of patches with the previously existing one with
1.24 wiz 4212: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4213: are replaced by new files, so carefully check if you want to take all
4214: the changes.</p>
1.1 dsieger 4215: <p>When you have finished a package, remember to generate
1.10 hubertf 4216: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 4217: 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 4218: <p>When adding a patch that corrects a problem in the
4219: distfile (rather than e.g. enforcing pkgsrc's view of where
4220: man pages should go), send the patch as a bug report to the
4221: maintainer. This benefits non-pkgsrc users of the package,
4222: and usually makes it possible to remove the patch in future
4223: version.</p>
1.2 rillig 4224: <p>The file names of the patch files are usually of the form
1.24 wiz 4225: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4226: Many packages still use the previous convention
4227: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4228: but new patches should be of the form containing the filename.
1.79 snj 4229: <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 4230: automatically.</p>
1.1 dsieger 4231: </div>
1.41 asau 4232: <div class="sect2">
1.1 dsieger 4233: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4234: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4235: <p>If you want to share patches between multiple packages
4236: in pkgsrc, e.g. because they use the same distfiles, set
4237: <code class="varname">PATCHDIR</code> to the path where the patch files
4238: can be found, e.g.:</p>
4239: <pre class="programlisting">
4240: PATCHDIR= ${.CURDIR}/../xemacs/patches
4241: </pre>
4242: <p>Patch files that are distributed by the author or other
4243: maintainers can be listed in
4244: <code class="varname">PATCHFILES</code>.</p>
4245: <p>If it is desired to store any patches that should not be
4246: committed into pkgsrc, they can be kept outside the pkgsrc
4247: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4248: directory tree there is expected to have the same
1.23 wiz 4249: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 4250: patches are expected to be stored inside these dirs (also
4251: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4252: example, if you want to keep a private patch for
4253: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4254: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4255: files in the named directory are expected to be patch files,
4256: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4257: applied</em></span>.</p>
4258: </div>
1.41 asau 4259: <div class="sect2">
1.1 dsieger 4260: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4261: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4262: <p>When fixing a portability issue in the code do not use
4263: preprocessor magic to check for the current operating system nor
4264: platform. Doing so hurts portability to other platforms because
4265: the OS-specific details are not abstracted appropriately.</p>
4266: <p>The general rule to follow is: instead of checking for the
4267: operating system the application is being built on, check for the
4268: specific <span class="emphasis"><em>features</em></span> you need. For example,
4269: instead of assuming that kqueue is available under NetBSD and
4270: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 4271: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4272: yes, this generally involves patching the
1.10 hubertf 4273: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4274: that prevents some OSes from adopting interfaces from other OSes
4275: (e.g. Linux implementing kqueue), something that the above checks
4276: cannot take into account.</p>
4277: <p>Of course, checking for features generally involves more
4278: work on the developer's side, but the resulting changes are
4279: cleaner and there are chances they will work on many other
4280: platforms. Not to mention that there are higher chances of being
4281: later integrated into the mainstream sources. Remember:
4282: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4283: <p>Some typical examples:</p>
4284: <div class="table">
1.6 rillig 4285: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4286: <div class="table-contents"><table summary="Patching examples" border="1">
4287: <colgroup>
4288: <col>
4289: <col>
4290: <col>
4291: </colgroup>
4292: <thead><tr>
4293: <th>Where</th>
4294: <th>Incorrect</th>
4295: <th>Correct</th>
4296: </tr></thead>
4297: <tbody>
4298: <tr>
4299: <td>configure script</td>
4300: <td>
4301: <pre class="programlisting">
4302: case ${target_os} in
4303: netbsd*) have_kvm=yes ;;
4304: *) have_kvm=no ;;
4305: esac
4306: </pre>
4307: </td>
4308: <td>
4309: <pre class="programlisting">
4310: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4311: </pre>
4312: </td>
4313: </tr>
4314: <tr>
4315: <td>C source file</td>
4316: <td>
4317: <pre class="programlisting">
4318: #if defined(__NetBSD__)
4319: # include <sys/event.h>
4320: #endif
4321: </pre>
4322: </td>
4323: <td>
4324: <pre class="programlisting">
4325: #if defined(HAVE_SYS_EVENT_H)
4326: # include <sys/event.h>
4327: #endif
4328: </pre>
4329: </td>
4330: </tr>
4331: <tr>
4332: <td>C source file</td>
4333: <td>
4334: <pre class="programlisting">
4335: int
4336: monitor_file(...)
4337: {
4338: #if defined(__NetBSD__)
4339: int fd = kqueue();
4340: ...
4341: #else
4342: ...
4343: #endif
4344: }
4345: </pre>
4346: </td>
4347: <td>
4348: <pre class="programlisting">
4349: int
4350: monitor_file(...)
4351: {
4352: #if defined(HAVE_KQUEUE)
4353: int fd = kqueue();
4354: ...
4355: #else
4356: ...
4357: #endif
4358: }
4359: </pre>
4360: </td>
4361: </tr>
4362: </tbody>
4363: </table></div>
4364: </div>
4365: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 4366: 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
4367: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 4368: 2</a>). It summarizes multiple details on how to make
4369: software easier to package; all the suggestions in it were
4370: collected from our experience in pkgsrc work, so they are possibly
4371: helpful when creating patches too.</p>
4372: </div>
1.41 asau 4373: <div class="sect2">
1.1 dsieger 4374: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4375: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4376: <p>Always, always, <span class="strong"><strong>always</strong></span>
4377: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4378: improvements you do to a package to the mainstream developers.
4379: This is the only way to get their attention on portability issues
4380: and to ensure that future versions can be built out-of-the box on
4381: NetBSD. Furthermore, any user that gets newer distfiles will get
4382: the fixes straight from the packaged code.</p>
4383: <p>This generally involves cleaning up the patches
4384: (because sometimes the patches that are
1.40 wiz 4385: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 4386: appropriate trackers for the projects and working with the
4387: mainstream authors to accept your changes. It is
4388: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4389: the packages in pkgsrc are kept simple and thus further changes
4390: can be done without much hassle.</p>
1.24 wiz 4391: <p>When you have done this, please add a URL to the upstream
4392: bug report to the patch comment.</p>
1.1 dsieger 4393: <p>Support the idea of free software!</p>
4394: </div>
4395: </div>
1.41 asau 4396: <div class="sect1">
1.1 dsieger 4397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4398: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 4399: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4400: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4401: <dd><p>A multi-line description of the piece of software. This should include
4402: any credits where they are due. Please bear in mind that others do not
4403: share your sense of humour (or spelling idiosyncrasies), and that others
4404: will read everything that you write here.</p></dd>
4405: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4406: <dd><p>This file governs the files that are installed on your
4407: system: all the binaries, manual pages, etc. There are other
4408: directives which may be entered in this file, to control the
4409: creation and deletion of directories, and the location of
1.10 hubertf 4410: 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 4411: information.</p></dd>
4412: </dl></div>
4413: </div>
1.41 asau 4414: <div class="sect1">
1.1 dsieger 4415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4416: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 4417: <div class="sect2">
1.1 dsieger 4418: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4419: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4420: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4421: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4422: <dd>
1.79 snj 4423: <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 4424: First time after package extraction and before files are
4425: moved in place, the second time after the files to install
4426: are moved in place. This can be used to do any custom
4427: procedures not possible with @exec commands in
1.79 snj 4428: <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
4429: <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 4430: Please note that you can modify variables in it easily by using
4431: <code class="varname">FILES_SUBST</code> in the package's
4432: <code class="filename">Makefile</code>:</p>
4433: <pre class="programlisting">
4434: FILES_SUBST+= SOMEVAR="somevalue"
4435: </pre>
4436: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4437: <code class="filename">INSTALL</code>. By default, substitution is
4438: performed for <code class="varname">PREFIX</code>,
4439: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4440: <code class="varname">VARBASE</code>, and a few others, type
4441: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4442: complete list.</p>
4443: </dd>
1.1 dsieger 4444: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4445: <dd><p>This script is executed before and after any files are removed. It is
4446: this script's responsibility to clean up any additional messy details
4447: around the package's installation, since all pkg_delete knows is how to
4448: delete the files created in the original distribution.
1.79 snj 4449: 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>
4450: 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 4451: The same methods to replace variables can be used as for
4452: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4453: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4454: <dd>
4455: <p>This file is displayed after installation of the package.
4456: Useful for things like legal notices on almost-free
4457: software and hints for updating config files after
4458: installing modules for apache, PHP etc.
4459: Please note that you can modify variables in it easily by using
4460: <code class="varname">MESSAGE_SUBST</code> in the package's
4461: <code class="filename">Makefile</code>:</p>
4462: <pre class="programlisting">
4463: MESSAGE_SUBST+= SOMEVAR="somevalue"
4464: </pre>
1.23 wiz 4465: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4466: <code class="filename">MESSAGE</code>. By default, substitution is
4467: performed for <code class="varname">PKGNAME</code>,
4468: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 4469: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 4470: <code class="varname">PKG_SYSCONFDIR</code>,
4471: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4472: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4473: <p>You can display a different or additional files by
4474: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4475: default is <code class="filename">MESSAGE</code>, if the file
4476: exists.</p>
4477: </dd>
4478: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 4479: <dd>
4480: <p>This file is used by the alternatives framework.
4481: It creates, configures, and destroys generic wrappers used to
4482: run programs with similar interfaces.
4483: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4484: for more information.</p>
4485: <p>Each line of the file contains two filenames, first
4486: the wrapper and then the alternative provided by the package.
4487: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4488: </dd>
1.1 dsieger 4489: </dl></div>
4490: </div>
1.41 asau 4491: <div class="sect2">
1.1 dsieger 4492: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4493: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4494: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4495: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4496: <dd><p>This file contains arbitrary things that could
4497: also go into a <code class="filename">Makefile</code>, but its purpose is
4498: to be used by more than one package. This file should only be
4499: used when the packages that will use the file are known in
4500: advance. For other purposes it is often better to write a
4501: <code class="filename">*.mk</code> file and give it a good name that
4502: describes what it does.</p></dd>
4503: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4504: <dd><p>This file contains the dependency information
1.10 hubertf 4505: 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 4506: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4507: <dd><p>This file contains workarounds for compiler bugs
4508: and similar things. It is included automatically by the pkgsrc
4509: infrastructure, so you don't need an extra
4510: <code class="literal">.include</code> line for
4511: it.</p></dd>
4512: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4513: <dd><p>This file contains the code for the
1.10 hubertf 4514: 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 4515: selected by the user. If a package has only one or two options,
4516: it is equally acceptable to put the code directly into the
4517: <code class="filename">Makefile</code>.</p></dd>
4518: </dl></div>
4519: </div>
1.41 asau 4520: <div class="sect2">
1.1 dsieger 4521: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4522: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4523: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4524: <dt><span class="term"><code class="filename">README*</code></span></dt>
4525: <dd><p>These files do not take place in the creation of
4526: a package and thus are purely informative to the package
4527: developer.</p></dd>
4528: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4529: <dd><p>This file contains things that need to be done
4530: to make the package even
4531: better.</p></dd>
4532: </dl></div>
4533: </div>
4534: </div>
1.41 asau 4535: <div class="sect1">
1.1 dsieger 4536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4537: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4538: </h2></div></div></div>
1.10 hubertf 4539: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4540: unpacked into the directory denoted by
4541: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4542: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4543: directory is also used to keep various timestamp files.
4544: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4545: The default is <code class="filename">${.CURDIR}/work</code>
4546: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4547: if <code class="varname">OBJMACHINE</code> is set.</p>
4548: </div>
1.41 asau 4549: <div class="sect1">
1.1 dsieger 4550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4551: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4552: </h2></div></div></div>
4553: <p>If you have any files that you wish to be placed in the package prior
4554: to configuration or building, you could place these files here and use
1.10 hubertf 4555: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4556: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4557: this. Alternatively, you could simply diff the file against
4558: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4559: the creation of this file.</p>
4560: <p>If you want to share files in this way with other
4561: packages, set the <code class="varname">FILESDIR</code> variable to point
4562: to the other package's <code class="filename">files</code> directory,
4563: e.g.:</p>
4564: <pre class="programlisting">
4565: FILESDIR=${.CURDIR}/../xemacs/files
4566: </pre>
4567: </div>
4568: </div>
1.41 asau 4569: <div class="chapter">
1.1 dsieger 4570: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4571: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4572: <div class="toc">
4573: <p><b>Table of Contents</b></p>
1.100 leot 4574: <dl class="toc">
1.6 rillig 4575: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4576: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4577: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4578: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4579: <dd><dl>
4580: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4581: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4582: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4583: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4584: <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 4585: </dl></dd>
4586: </dl>
4587: </div>
4588: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4589: each of which forms a well-defined part of the pkgsrc system. Using
1.79 snj 4590: 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 4591: like pkgsrc requires some discipline to keep the code correct and
4592: understandable.</p>
4593: <p>The basic ingredients for <code class="filename">Makefile</code>
4594: programming are variables (which are actually macros) and shell
4595: commands. Among these shell commands may even be more complex ones
1.79 snj 4596: 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 4597: as intended it is necessary to quote all variables correctly when they
4598: are used.</p>
4599: <p>This chapter describes some patterns, that appear quite often in
4600: <code class="filename">Makefile</code>s, including the pitfalls that come along
4601: with them.</p>
1.41 asau 4602: <div class="sect1">
1.1 dsieger 4603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4604: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4605: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4606: <p>When you are creating a file as a
4607: target of a rule, always write the data to a temporary file first
4608: and finally rename that file. Otherwise there might occur an error
4609: in the middle of generating the file, and when the user runs
1.79 snj 4610: <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 4611: regenerated properly. Example:</p>
4612: <pre class="programlisting">
4613: wrong:
4614: @echo "line 1" > ${.TARGET}
4615: @echo "line 2" >> ${.TARGET}
4616: @false
4617:
4618: correct:
4619: @echo "line 1" > ${.TARGET}.tmp
4620: @echo "line 2" >> ${.TARGET}.tmp
4621: @false
4622: @mv ${.TARGET}.tmp ${.TARGET}
4623: </pre>
1.10 hubertf 4624: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4625: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4626: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4627: correct</strong></span> gives an error message twice, as expected.</p>
1.79 snj 4628: <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 4629: <code class="literal">${.TARGET}</code> in case of error, but this only
4630: happens when it is interrupted, for example by pressing
4631: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.79 snj 4632: 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 4633: </li></ul></div>
4634: </div>
1.41 asau 4635: <div class="sect1">
1.1 dsieger 4636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4637: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4638: <p><code class="filename">Makefile</code> variables contain strings that
4639: can be processed using the five operators ``='', ``+='', ``?='',
1.79 snj 4640: ``:='', 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 4641: page.</p>
4642: <p>When a variable's value is parsed from a
4643: <code class="filename">Makefile</code>, the hash character ``#'' and the
4644: backslash character ``\'' are handled specially. If a backslash is
4645: followed by a newline, any whitespace immediately in front of the
4646: backslash, the backslash, the newline, and any whitespace
4647: immediately behind the newline are replaced with a single space. A
4648: backslash character and an immediately following hash character are
4649: replaced with a single hash character. Otherwise, the backslash is
4650: passed as is. In a variable assignment, any hash character that is
4651: not preceded by a backslash starts a comment that continues upto the
4652: end of the logical line.</p>
4653: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4654: the only way to create a variable consisting of a single backslash
4655: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4656: <p>So far for defining variables. The other thing you can do with
4657: variables is evaluating them. A variable is evaluated when it is
4658: part of the right side of the ``:='' or the ``!='' operator, or
4659: directly before executing a shell command which the variable is part
1.79 snj 4660: 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 4661: is, variables are not evaluated until there's no other way. The
4662: ``modifiers'' mentioned in the man page also evaluate the
4663: variable.</p>
4664: <p>Some of the modifiers split the string into words and then
4665: operate on the words, others operate on the string as a whole. When
4666: a string is split into words, it is split as you would expect
1.79 snj 4667: 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 4668: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.1 dsieger 4669: loop does not follow the shell quoting rules but splits at sequences
4670: of whitespace.</p>
4671: <p>There are several types of variables that should be handled
4672: differently. Strings and two types of lists.</p>
1.41 asau 4673: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4674: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4675: characters. Nevertheless, you should restrict yourself to only
4676: using printable characters. Examples are
4677: <code class="varname">PREFIX</code> and
4678: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4679: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4680: are never exported to any shell command. Their elements are
4681: separated by whitespace. Therefore, the elements themselves cannot
4682: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4683: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4684: Examples are <code class="varname">DEPENDS</code> and
4685: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4686: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4687: may be exported to a shell command. Their elements can contain any
4688: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4689: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4690: <code class="varname">DISTFILES</code> and
4691: <code class="varname">MASTER_SITES</code>.</p></li>
4692: </ul></div>
1.41 asau 4693: <div class="sect2">
1.1 dsieger 4694: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4695: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4697: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4698: are reserved for use by the pkgsrc infrastructure. They shall
4699: not be used by package
4700: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4701: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4702: lowercase variable names for the iteration
4703: variables.</p></li>
1.23 wiz 4704: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4705: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4706: <code class="varname">DISTFILES</code>.</p></li>
4707: </ul></div>
4708: </div>
4709: </div>
1.41 asau 4710: <div class="sect1">
1.1 dsieger 4711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4712: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 4713: <p>This section presents you with some code snippets you should
4714: use in your own code. If you don't find anything appropriate here,
4715: you should test your code and add it here.</p>
1.41 asau 4716: <div class="sect2">
1.1 dsieger 4717: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4718: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 4719: <pre class="programlisting">
4720: STRING= foo * bar `date`
4721: INT_LIST= # empty
4722: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4723: EXT_LIST= # empty
4724: ANOTHER_EXT_LIST= a=b c=d
4725:
4726: INT_LIST+= ${STRING} # 1
4727: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4728: EXT_LIST+= ${STRING:Q} # 3
4729: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
4730: </pre>
4731: <p>When you add a string to an external list (example 3), it
4732: must be quoted. In all other cases, you must not add a quoting
4733: level. You must not merge internal and external lists, unless you
4734: are sure that all entries are correctly interpreted in both
4735: lists.</p>
4736: </div>
1.41 asau 4737: <div class="sect2">
1.1 dsieger 4738: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4739: <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 4740: <pre class="programlisting">
4741: EXT_LIST= # empty
4742: .for i in ${INT_LIST}
4743: EXT_LIST+= ${i:Q}""
4744: .endfor
4745: </pre>
4746: <p>This code converts the internal list
4747: <code class="varname">INT_LIST</code> into the external list
4748: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4749: are unquoted they must be quoted here. The reason for appending
4750: <code class="varname">""</code> is explained below.</p>
4751: </div>
1.41 asau 4752: <div class="sect2">
1.1 dsieger 4753: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4754: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 4755: <p>Sometimes you may want to print an arbitrary string. There
4756: are many ways to get it wrong and only few that can handle every
4757: nastiness.</p>
4758: <pre class="programlisting">
4759: STRING= foo bar < > * `date` $$HOME ' "
4760: EXT_LIST= string=${STRING:Q} x=second\ item
4761:
4762: all:
4763: echo ${STRING} # 1
4764: echo "${STRING}" # 2
4765: echo "${STRING:Q}" # 3
4766: echo ${STRING:Q} # 4
4767: echo x${STRING:Q} | sed 1s,.,, # 5
4768: printf "%s\\n" ${STRING:Q}"" # 6
4769: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
4770: </pre>
4771: <p>Example 1 leads to a syntax error in the shell, as the
4772: characters are just copied.</p>
4773: <p>Example 2 leads to a syntax error too, and if you leave out
4774: the last " character from <code class="varname">${STRING}</code>,
1.79 snj 4775: <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 4776: variable would be evaluated, too.</p>
4777: <p>Example 3 outputs each space character preceded by a
4778: backslash (or not), depending on the implementation of the
1.79 snj 4779: <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 4780: <p>Example 4 handles correctly every string that does not start
4781: with a dash. In that case, the result depends on the
1.79 snj 4782: 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 4783: guarantee that your input does not start with a dash, this form is
4784: appropriate.</p>
4785: <p>Example 5 handles even the case of a leading dash
4786: correctly.</p>
4787: <p>Example 6 also works with every string and is the
4788: light-weight solution, since it does not involve a pipe, which has
4789: its own problems.</p>
4790: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4791: because the quoting has already been done when adding elements to
4792: the list.</p>
4793: <p>As internal lists shall not be passed to the shell, there is
4794: no example for it.</p>
4795: </div>
1.41 asau 4796: <div class="sect2">
1.1 dsieger 4797: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4798: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 4799: <p>There are many possible sources of wrongly quoted variables.
4800: This section lists some of the commonly known ones.</p>
1.41 asau 4801: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4802: <li class="listitem">
1.1 dsieger 4803: <p>Whenever you use the value of a list, think
4804: about what happens to leading or trailing whitespace. If the
4805: list is a well-formed shell expression, you can apply the
4806: <code class="varname">:M*</code> modifier to strip leading and trailing
4807: whitespace from each word. The <code class="varname">:M</code> operator
4808: first splits its argument according to the rules of the shell,
4809: and then creates a new list consisting of all words that match
4810: the shell glob expression <code class="varname">*</code>, that is: all.
4811: One class of situations where this is needed is when adding a
4812: variable like <code class="varname">CPPFLAGS</code> to
4813: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4814: invokes other configure scripts, it strips the leading and
4815: trailing whitespace from the variable and then passes it to the
4816: other configure scripts. But these configure scripts expect the
4817: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4818: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4819: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4820: here is how we do it:</p>
4821: <pre class="programlisting">
4822: CPPFLAGS= # empty
4823: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4824: CPPFLAGS+= ${MY_CPPFLAGS}
4825:
4826: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4827:
4828: all:
4829: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4830: echo x${CONFIGURE_ARGS}x # properly trimmed
4831: </pre>
4832: </li>
1.23 wiz 4833: <li class="listitem"><p>The example above contains one bug: The
1.1 dsieger 4834: <code class="varname">${PREFIX}</code> is a properly quoted shell
4835: expression, but there is the C compiler after it, which also
4836: expects a properly quoted string (this time in C syntax). The
4837: version above is therefore only correct if
4838: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4839: or double quotes. If you want to allow these, you have to add
4840: another layer of quoting to each variable that is used as a C
4841: string literal. You cannot use the <code class="varname">:Q</code>
4842: operator for it, as this operator only works for the
4843: shell.</p></li>
1.23 wiz 4844: <li class="listitem">
1.1 dsieger 4845: <p>Whenever a variable can be empty, the
4846: <code class="varname">:Q</code> operator can have surprising results. Here
4847: are two completely different cases which can be solved with the
4848: same trick.</p>
4849: <pre class="programlisting">
4850: EMPTY= # empty
4851: empty_test:
4852: for i in a ${EMPTY:Q} c; do \
4853: echo "$$i"; \
4854: done
4855:
4856: for_test:
4857: .for i in a:\ a:\test.txt
4858: echo ${i:Q}
4859: echo "foo"
4860: .endfor
4861: </pre>
4862: <p>The first example will only print two of the three lines
4863: we might have expected. This is because
4864: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4865: the shell cannot see. The workaround is to write
4866: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4867: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4868: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4869: <p>The second example will only print three lines instead of
4870: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4871: This is because the backslash of the value
4872: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.79 snj 4873: <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
4874: <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 4875: <code class="varname">${i:Q}""</code>.</p>
4876: </li>
4877: </ul></div>
4878: </div>
1.41 asau 4879: <div class="sect2">
1.1 dsieger 4880: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4881: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 4882: <p>The pkgsrc bmake program does not handle the following
4883: assignment correctly. In case <code class="varname">_othervar_</code>
4884: contains a ``-'' character, one of the closing braces is included
4885: in <code class="varname">${VAR}</code> after this code executes.</p>
4886: <pre class="programlisting">
4887: VAR:= ${VAR:N${_othervar_:C/-//}}
4888: </pre>
4889: <p>For a more complex code snippet and a workaround, see the
1.79 snj 4890: 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 4891: <code class="varname">bug1</code>.</p>
4892: </div>
4893: </div>
4894: </div>
1.41 asau 4895: <div class="chapter">
1.1 dsieger 4896: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4897: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4898: <div class="toc">
4899: <p><b>Table of Contents</b></p>
1.100 leot 4900: <dl class="toc">
1.6 rillig 4901: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4902: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4903: <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 4904: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4905: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4906: <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 4907: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86 wiz 4908: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
4909: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4910: </dl>
4911: </div>
4912: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4913: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4914: the package (relative to the <code class="filename">${PREFIX}</code>
4915: directory it's been installed in) plus some additional statements
1.79 snj 4916: - 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 4917: This chapter addresses some issues that need attention when
4918: dealing with the <code class="filename">PLIST</code> file (or files, see
4919: below!).</p>
1.41 asau 4920: <div class="sect1">
1.1 dsieger 4921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4922: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4923: <p>Be sure to add a RCS ID line as the first thing in any
4924: <code class="filename">PLIST</code> file you write:</p>
4925: <pre class="programlisting">
4926: @comment $NetBSD$
4927: </pre>
4928: </div>
1.41 asau 4929: <div class="sect1">
1.1 dsieger 4930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4931: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4932: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4933: to output a PLIST that matches any new files since the package
1.10 hubertf 4934: 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 4935: more information on this target.</p>
4936: </div>
1.41 asau 4937: <div class="sect1">
1.1 dsieger 4938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4939: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4940: </h2></div></div></div>
4941: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4942: of AWK patterns and actions that are used to filter the output of
4943: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4944: scripting you like to it, but be careful with quoting.</p>
4945: <p>For example, to get all files inside the
4946: <code class="filename">libdata/foo</code> directory removed from the
4947: resulting PLIST:</p>
4948: <pre class="programlisting">
4949: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
4950: </pre>
4951: </div>
1.41 asau 4952: <div class="sect1">
1.1 dsieger 4953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4954: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4955: <p>A number of variables are substituted automatically in
4956: PLISTs when a package is installed on a system. This includes the
4957: following variables:</p>
1.41 asau 4958: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4959: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4960: <dd>
4961: <p>Some packages like emacs and perl embed information
4962: about which architecture they were built on into the
4963: pathnames where they install their files. To handle this
4964: case, PLIST will be preprocessed before actually used, and
4965: the symbol
1.23 wiz 4966: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4967: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4968: same is done if the string
4969: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4970: PLIST somewhere - use this on packages that have GNU
4971: autoconf-created configure scripts.</p>
1.41 asau 4972: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4973: <h3 class="title">Legacy note</h3>
4974: <p>There used to be a symbol
1.23 wiz 4975: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4976: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4977: -m</strong></span>, but that's no longer supported and has
4978: been removed.</p>
4979: </div>
4980: </dd>
4981: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4982: <dd>
4983: <p>Some packages want to embed the OS name and version
4984: into some paths. To do this, use these variables in the
4985: <code class="filename">PLIST</code>:
4986: </p>
1.41 asau 4987: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4988: <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>
4989: <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>
4990: <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 4991: </ul></div>
4992: </dd>
4993: </dl></div>
1.88 tnn 4994: <p>For a list of values which are replaced by
4995: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4996: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4997: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4998: <p>If you want to change other variables not listed above, you
4999: can add variables and their expansions to this variable in the
1.10 hubertf 5000: 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 5001: <pre class="programlisting">
5002: PLIST_SUBST+= SOMEVAR="somevalue"
5003: </pre>
1.23 wiz 5004: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 5005: in the <code class="filename">PLIST</code> with
1.23 wiz 5006: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 5007: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
5008: the common case of conditionally including some
5009: <code class="filename">PLIST</code> entries. It can be done by adding
5010: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
5011: setting the corresponding <code class="varname">PLIST.foo</code> variable
5012: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 5013: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 5014: in the <code class="filename">PLIST</code> with either
1.23 wiz 5015: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5016: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 5017: For example, in <code class="filename">Makefile</code>:</p>
5018: <pre class="programlisting">
5019: PLIST_VARS+= foo
5020: .if <em class="replaceable"><code>condition</code></em>
5021: PLIST.foo= yes
5022: .else
5023: </pre>
5024: <p>And then in <code class="filename">PLIST</code>:</p>
5025: <pre class="programlisting">
5026: @comment $NetBSD$
5027: bin/bar
5028: man/man1/bar.1
5029: ${PLIST.foo}bin/foo
5030: ${PLIST.foo}man/man1/foo.1
5031: ${PLIST.foo}share/bar/foo.data
5032: </pre>
1.1 dsieger 5033: </div>
1.41 asau 5034: <div class="sect1">
1.1 dsieger 5035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5036: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5037: <p>Man pages should be installed in compressed form if
5038: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5039: and uncompressed otherwise. To handle this in the
1.23 wiz 5040: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 5041: appended/removed automatically for man pages according to
5042: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5043: or not, see above for details. This modification of the
5044: <code class="filename">PLIST</code> file is done on a copy of it, not
5045: <code class="filename">PLIST</code> itself.</p>
5046: </div>
1.41 asau 5047: <div class="sect1">
1.1 dsieger 5048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5049: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5050: </h2></div></div></div>
5051: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5052: in generating the binary package, set the variable
5053: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.79 snj 5054: 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 5055: important. The default for <code class="varname">PLIST_SRC</code> is
5056: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5057: </div>
1.41 asau 5058: <div class="sect1">
1.1 dsieger 5059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5060: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5061: <p>Some packages decide to install a different set of files based on
5062: the operating system being used. These differences can be
5063: automatically handled by using the following files:</p>
1.41 asau 5064: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5065: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5066: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5067: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5068: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5069: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 5070: </ul></div>
5071: </div>
1.41 asau 5072: <div class="sect1">
1.1 dsieger 5073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86 wiz 5074: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
5075: <p>Some packages decide to generate hard-to-guess file names
5076: during installation that are hard to wire down.</p>
5077: <p>In such cases, you can set the
5078: <code class="varname">GENERATE_PLIST</code> variable to shell code
5079: terminated (with a semicolon) that will output PLIST entries which
5080: will be appended to the PLIST</p>
5081: <p>You can find one example in editors/xemacs:</p>
5082: <pre class="programlisting">
5083: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
5084: </pre>
5085: <p>which will append something like
5086: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
5087: <code class="filename">PLIST</code>.
5088: </p>
5089: </div>
5090: <div class="sect1">
5091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5092: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 5093: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 5094: multiple (and unrelated) packages install files. These
1.22 jakllsch 5095: directories were problematic because you had to add special
5096: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 5097: centralized package handle them.</p>
1.22 jakllsch 5098: <p>In pkgsrc, it is now easy: Each package should create
5099: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5100: will remove any directories left empty after uninstalling a
5101: package.</p>
5102: <p>If a package needs an empty directory to work, create
5103: the directory during installation as usual, and also add an
5104: entry to the PLIST:
5105: </p>
1.1 dsieger 5106: <pre class="programlisting">
1.22 jakllsch 5107: @pkgdir path/to/empty/directory
1.1 dsieger 5108: </pre>
1.22 jakllsch 5109: <p>
1.86 wiz 5110: or take a look at <code class="varname">MAKE_DIRS</code> and
5111: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 5112: </p>
1.1 dsieger 5113: </div>
5114: </div>
1.41 asau 5115: <div class="chapter">
1.1 dsieger 5116: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5117: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5118: <div class="toc">
5119: <p><b>Table of Contents</b></p>
1.100 leot 5120: <dl class="toc">
1.6 rillig 5121: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 5122: <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 5123: <dd><dl>
1.6 rillig 5124: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 5125: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5126: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5127: and
5128: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5129: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5130: </dl></dd>
1.23 wiz 5131: <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 5132: <dd><dl>
1.23 wiz 5133: <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 5134: <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 5135: </dl></dd>
5136: </dl>
5137: </div>
5138: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5139: are seen by a package's configure and build processes. This is implemented
5140: in a two step process:</p>
1.23 wiz 5141: <div class="orderedlist"><ol class="orderedlist" type="1">
5142: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 5143: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5144: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 5145: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 5146: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5147: <code class="option">-L${LOCALBASE}/lib</code> into references to
5148: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5149: native compiler on some operating systems look like GCC, so that
5150: packages that expect GCC won't require modifications to build with
5151: those native compilers.</p></li>
5152: </ol></div>
5153: <p>This normalizes the environment in which a package is built so that the
5154: package may be built consistently despite what other software may be
5155: installed. Please note that the normal system header and library paths,
5156: e.g. <code class="filename">/usr/include</code>,
5157: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5158: designed to insulate the package build from non-system-supplied
5159: software.</p>
1.41 asau 5160: <div class="sect1">
1.1 dsieger 5161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5162: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5163: <p>The process of converting packages to use the buildlink3
1.23 wiz 5164: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 5165: The things to keep in mind are:</p>
1.23 wiz 5166: <div class="orderedlist"><ol class="orderedlist" type="1">
5167: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 5168: instead of the actual toolchain. Some packages are tricky,
5169: and the only way to know for sure is the check
5170: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5171: wrappers are being invoked.</p></li>
1.23 wiz 5172: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 5173: the package Makefile, e.g. Java VMs, standalone shells,
5174: etc., because the code to symlink files into
5175: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 5176: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 5177: </p></li>
1.23 wiz 5178: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 5179: <code class="filename">buildlink3.mk</code> files that you list in a
5180: package's Makefile are added as dependencies for that package.
5181: </p></li>
5182: </ol></div>
5183: <p>If a dependency on a particular package is required for its libraries and
5184: headers, then we replace:</p>
5185: <pre class="programlisting">
5186: DEPENDS+= foo>=1.1.0:../../category/foo
5187: </pre>
5188: <p>with</p>
5189: <pre class="programlisting">
5190: .include "../../category/foo/buildlink3.mk"
5191: </pre>
5192: <p>The buildlink3.mk files usually define the required dependencies.
5193: If you need a newer version of the dependency when using buildlink3.mk
5194: files, then you can define it in your Makefile; for example:</p>
5195: <pre class="programlisting">
5196: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5197: .include "../../category/foo/buildlink3.mk"
5198: </pre>
5199: <p>There are several <code class="filename">buildlink3.mk</code>
5200: files in <code class="filename">pkgsrc/mk</code>
5201: that handle special package issues:</p>
1.41 asau 5202: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5203: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 5204: the native or a pkgsrc Berkeley DB implementation based on
5205: the values of <code class="varname">BDB_ACCEPTED</code> and
5206: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 5207: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 5208: comes with neither Curses nor NCurses, this will take care
1.79 snj 5209: 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 5210: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 5211: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5212: adding a dependency on Heimdal or MIT-krb5 for packages that
5213: require a Kerberos 5 implementation.</p></li>
1.23 wiz 5214: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 5215: system-provided Motif installation or adds a dependency on
1.79 snj 5216: <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 5217: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 5218: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5219: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 5220: which Motif version will be used.</p></li>
1.55 ryoon 5221: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 5222: system-provided GNU readline or editline (libedit) installation,
1.79 snj 5223: 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>,
5224: <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 5225: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5226: If your package really needs GNU readline library, its Makefile
5227: should include <code class="filename">devel/readline/buildlink3.mk</code>
5228: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 5229: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 5230: variables that may be used by packages that use the
5231: Open Sound System (OSS) API.</p></li>
1.23 wiz 5232: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 5233: any of the Postgres versions in the variable
5234: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5235: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 5236: the file for more information.</p></li>
1.23 wiz 5237: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 5238: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.79 snj 5239: 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 5240: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 5241: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5242: library.</p></li>
5243: </ul></div>
5244: <p>The comments in those <code class="filename">buildlink3.mk</code>
5245: files provide a more complete
5246: description of how to use them properly.</p>
5247: </div>
1.41 asau 5248: <div class="sect1">
1.1 dsieger 5249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5250: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5251: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5252: included by Makefiles to indicate the need to compile and link
5253: against header files and libraries provided by the package. A
5254: <code class="filename">buildlink3.mk</code> file should always provide
5255: enough information to add the correct type of dependency
5256: relationship and include any other
5257: <code class="filename">buildlink3.mk</code> files that it needs to find
5258: headers and libraries that it needs in turn.</p>
5259: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.79 snj 5260: 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 5261: package is highly recommended. For most packages, the following
5262: command will generate a good starting point for
5263: <code class="filename">buildlink3.mk</code> files:</p>
5264: <pre class="screen">
5265: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5266: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5267: </pre>
1.41 asau 5268: <div class="sect2">
1.1 dsieger 5269: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5270: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5271: <p>The following real-life example
5272: <code class="filename">buildlink3.mk</code> is taken
5273: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5274: <pre class="programlisting">
1.18 snj 5275: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5276:
1.18 snj 5277: BUILDLINK_TREE+= tiff
1.1 dsieger 5278:
1.18 snj 5279: .if !defined(TIFF_BUILDLINK3_MK)
5280: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5281:
1.18 snj 5282: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5283: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5284: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5285:
5286: .include "../../devel/zlib/buildlink3.mk"
5287: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 5288: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5289:
1.18 snj 5290: BUILDLINK_TREE+= -tiff
1.1 dsieger 5291: </pre>
5292: <p>The header and footer manipulate
1.18 snj 5293: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 5294: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 5295: the dependency tree.</p>
5296: <p>The main section is protected from multiple inclusion
1.1 dsieger 5297: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5298: added. Several important variables are set in the section:</p>
1.41 asau 5299: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5300: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5301: is the actual dependency recorded in the installed
5302: package; this should always be set using
1.10 hubertf 5303: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5304: we're appending to any pre-existing list of values. This
5305: variable should be set to the first version of the
1.26 wiz 5306: package that had an backwards-incompatible API change.
1.1 dsieger 5307: </p></li>
1.23 wiz 5308: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5309: is the location of the <em class="replaceable"><code>pkg</code></em>
5310: pkgsrc directory.</p></li>
1.23 wiz 5311: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5312: (not shown above) controls whether we use
5313: <code class="varname">BUILD_DEPENDS</code> or
5314: <code class="varname">DEPENDS</code> to add the dependency on
5315: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5316: selected by setting
5317: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5318: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 5319: used.</p></li>
1.23 wiz 5320: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5321: and
5322: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5323: (not shown above) are lists of subdirectories of
5324: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5325: to add to the header and library search paths. These
1.23 wiz 5326: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 5327: respectively.</p></li>
1.23 wiz 5328: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5329: (not shown above) is the list of preprocessor flags to add
5330: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 5331: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 5332: should be avoided and instead be handled using
5333: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5334: above.</p></li>
5335: </ul></div>
5336: <p>The following variables are all optionally defined within
5337: this second section (protected against multiple inclusion) and
5338: control which package files are symlinked into
5339: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5340: transformed during the symlinking:</p>
1.41 asau 5341: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5342: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5343: (not shown above) is a shell glob pattern relative to
5344: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5345: to be symlinked into
5346: <code class="filename">${BUILDLINK_DIR}</code>,
5347: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 5348: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5349: (not shown above) is a shell pipeline that
5350: outputs to stdout a list of files relative to
5351: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5352: The resulting files are to be symlinked
5353: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5354: this takes the <code class="filename">+CONTENTS</code> of a
5355: <em class="replaceable"><code>pkg</code></em> and filters it through
5356: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 5357: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5358: (not shown above) is a filter command that filters
5359: <code class="filename">+CONTENTS</code> input into a list of files
5360: relative to
5361: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 5362: on stdout. By default,
1.1 dsieger 5363: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5364: outputs the contents of the <code class="filename">include</code>
5365: and <code class="filename">lib</code> directories in the package
1.84 wiz 5366: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 5367: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5368: (not shown above) is a list of sed arguments used to
5369: transform the name of the source filename into a
1.10 hubertf 5370: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5371: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5372: </ul></div>
1.18 snj 5373: <p>This section can additionally include any
1.1 dsieger 5374: <code class="filename">buildlink3.mk</code> needed for
5375: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5376: Including these <code class="filename">buildlink3.mk</code> files
5377: means that the headers and libraries for these
5378: dependencies are also symlinked into
5379: <code class="filename">${BUILDLINK_DIR}</code>
5380: whenever the <em class="replaceable"><code>pkg</code></em>
5381: <code class="filename">buildlink3.mk</code>
1.18 snj 5382: file is included. Dependencies are only added for directly
5383: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 5384: <p>When providing a <code class="filename">buildlink3.mk</code> and
5385: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 5386: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 5387: header files are automatically exposed when the package is
5388: use.</p>
5389: <p>In particular, if only an executable
5390: (<code class="filename">bin/foo</code>) is linked against a library, that
5391: library does not need to be propagated in the
5392: <code class="filename">buildlink3.mk</code> file.</p>
5393: <p>The following steps should help you decide if a
5394: <code class="filename">buildlink3.mk</code> file needs to be included:
5395: </p>
5396: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5397: <li class="listitem"><p>Look at the installed header files: What
5398: headers do they include? The packages providing these files
5399: must be buildlinked.</p></li>
1.49 wiz 5400: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5401: libraries and look against what other libraries they link.
5402: Some of the packages providing these probably need to be
5403: buildlinked; however, it's not automatic, since e.g. GTK on
5404: some systems pulls in the X libraries, so they will show up in
5405: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 5406: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 5407: used as a hint.</p></li>
1.47 wiz 5408: </ul></div>
5409: <p>
5410: </p>
1.1 dsieger 5411: </div>
1.41 asau 5412: <div class="sect2">
1.1 dsieger 5413: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 5414: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 5415: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5416: and
5417: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5418: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5419: <p>These two variables differ in that one describes source
5420: compatibility (API) and the other binary compatibility (ABI).
5421: The difference is that a change in the API breaks compilation of
5422: programs while changes in the ABI stop compiled programs from
5423: running.</p>
5424: <p>Changes to the
1.27 wiz 5425: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5426: variable in a <code class="filename">buildlink3.mk</code> file happen
5427: very rarely. One possible reason is that all packages depending
5428: on this already need a newer version. In case it is bumped see
5429: the description below.</p>
5430: <p>The most common example of an ABI change is that the major
5431: version of a shared library is increased. In this case,
5432: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5433: should be adjusted to require at least the new package version.
5434: Then the packages that depend on this package need their
5435: <code class="varname">PKGREVISION</code>s increased and, if they have
5436: <code class="filename">buildlink3.mk</code> files, their
5437: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5438: adjusted, too. This is needed so pkgsrc will require the correct
5439: package dependency and not settle for an older one when building
5440: the source.</p>
1.10 hubertf 5441: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.26 wiz 5442: more information about dependencies on other packages,
5443: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 5444: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5445: <p>Please take careful consideration before adjusting
5446: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5447: or
5448: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5449: as we don't want to cause unneeded package deletions and
5450: rebuilds. In many cases, new versions of packages work just
5451: fine with older dependencies.</p>
5452: <p>Also it is not needed to set
1.26 wiz 5453: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5454: when it is identical to
1.1 dsieger 5455: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5456: </div>
5457: </div>
1.41 asau 5458: <div class="sect1">
1.1 dsieger 5459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5460: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5461: <p>Some packages in pkgsrc install headers and libraries that
5462: coincide with headers and libraries present in the base system.
5463: Aside from a <code class="filename">buildlink3.mk</code> file, these
5464: packages should also include a <code class="filename">builtin.mk</code>
5465: file that includes the necessary checks to decide whether using
5466: the built-in software or the pkgsrc software is
5467: appropriate.</p>
5468: <p>The only requirements of a builtin.mk file for
5469: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 5470: <div class="orderedlist"><ol class="orderedlist" type="1">
5471: <li class="listitem"><p>It should set
1.1 dsieger 5472: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5473: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 5474: after it is included.</p></li>
1.23 wiz 5475: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 5476: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5477: which is already set before the
5478: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 5479: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 5480: is <span class="emphasis"><em>very</em></span> important and takes careful
5481: attention to <code class="filename">Makefile</code> coding.</p></li>
5482: </ol></div>
1.41 asau 5483: <div class="sect2">
1.1 dsieger 5484: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5485: <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 5486: <p>The following is the recommended template for builtin.mk
5487: files:</p>
5488: <pre class="programlisting">
5489: .if !defined(IS_BUILTIN.foo)
5490: #
5491: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5492: # genuinely exists in the system or not.
5493: #
5494: IS_BUILTIN.foo?= no
5495:
5496: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5497: # version can be determined.
5498: #
5499: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5500: BUILTIN_PKG.foo?= foo-1.0
5501: . endif
5502: .endif # IS_BUILTIN.foo
5503:
5504: .if !defined(USE_BUILTIN.foo)
5505: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5506: . if defined(BUILTIN_PKG.foo)
5507: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5508: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5509: USE_BUILTIN.foo!= \
5510: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5511: && ${ECHO} "yes" || ${ECHO} "no"
5512: . endif
5513: . endfor
5514: . endif
5515: .endif # USE_BUILTIN.foo
5516:
5517: CHECK_BUILTIN.foo?= no
5518: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5519: #
5520: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5521: # "yes" or "no".
5522: #
5523: .endif # CHECK_BUILTIN.foo
5524: </pre>
5525: <p>The first section sets
5526: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5527: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5528: in the base system. This should not be a base system software
5529: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5530: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5531: included as part of the base system. This variable is only
5532: used internally within the <code class="filename">builtin.mk</code>
5533: file.</p>
5534: <p>The second section sets
5535: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5536: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5537: system if it exists (if
5538: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5539: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5540: within the <code class="filename">builtin.mk</code> file.</p>
5541: <p>The third section sets
5542: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5543: and is <span class="emphasis"><em>required</em></span> in all
5544: <code class="filename">builtin.mk</code> files. The code in this
5545: section must make the determination whether the built-in
5546: software is adequate to satisfy the dependencies listed in
5547: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5548: This is typically done by comparing
5549: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5550: against each of the dependencies in
5551: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5552: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5553: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5554: end of the <code class="filename">builtin.mk</code> file. Note that
5555: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5556: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5557: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5558: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5559: that the built-in version of the software is similar enough to
5560: be used as a replacement.</p>
5561: <p>The last section is guarded by
5562: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5563: and includes code that uses the value of
5564: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5565: set in the previous section. This typically includes, e.g.,
5566: adding additional dependency restrictions and listing additional
5567: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5568: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5569: </div>
1.41 asau 5570: <div class="sect2">
1.1 dsieger 5571: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5572: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5573: <p>When building packages, it's possible to choose whether to set
5574: a global preference for using either the built-in (native)
5575: version or the pkgsrc version of software to satisfy a
5576: dependency. This is controlled by setting
5577: <code class="varname">PREFER_PKGSRC</code> and
5578: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5579: 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 5580: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5581: use the pkgsrc versions of software, while
5582: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5583: built-in versions. Preferences are determined by the most
5584: specific instance of the package in either
5585: <code class="varname">PREFER_PKGSRC</code> or
5586: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5587: in neither or in both variables, then
5588: <code class="varname">PREFER_PKGSRC</code> has precedence over
5589: <code class="varname">PREFER_NATIVE</code>. For example, to require
5590: using pkgsrc versions of software for all but the most basic
5591: bits on a NetBSD system, you can set:</p>
5592: <pre class="programlisting">
5593: PREFER_PKGSRC= yes
5594: PREFER_NATIVE= getopt skey tcp_wrappers
5595: </pre>
5596: <p>A package <span class="emphasis"><em>must</em></span> have a
5597: <code class="filename">builtin.mk</code>
5598: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5599: otherwise it is simply ignored in that list.</p>
5600: </div>
5601: </div>
5602: </div>
1.41 asau 5603: <div class="chapter">
1.1 dsieger 5604: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5605: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5606: <div class="toc">
5607: <p><b>Table of Contents</b></p>
1.100 leot 5608: <dl class="toc">
1.6 rillig 5609: <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 5610: <dd><dl>
1.6 rillig 5611: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5612: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5613: </dl></dd>
1.6 rillig 5614: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5615: <dd><dl>
1.23 wiz 5616: <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 5617: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5618: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5619: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5620: </dl></dd>
5621: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5622: <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>
5623: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5624: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5625: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5626: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5627: <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 5628: </dl>
5629: </div>
5630: <p>This chapter describes the framework known as
5631: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5632: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5633: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5634: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5635: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5636: provided that packages are correctly designed.</p></li>
1.23 wiz 5637: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5638: <li class="listitem"><p>Registration of system users and groups.</p></li>
5639: <li class="listitem"><p>Registration of system shells.</p></li>
5640: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5641: </ul></div>
5642: <p>The following sections inspect each of the above points in detail.</p>
5643: <p>You may be thinking that many of the things described here could be
5644: easily done with simple code in the package's post-installation target
5645: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5646: as the code in them is only executed when building from source. Machines
5647: using binary packages could not benefit from it at all (as the code itself
5648: could be unavailable). Therefore, the only way to achieve any of the items
5649: described above is by means of the installation scripts, which are
5650: automatically generated by pkginstall.</p>
1.41 asau 5651: <div class="sect1">
1.1 dsieger 5652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5653: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5654: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5655: of files and directories that belong to a package. The names used in it
5656: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5657: which means that it cannot register files outside this directory (absolute
5658: path names are not allowed). Despite this restriction, some packages need
5659: to install files outside this location; e.g., under
5660: <code class="filename">${VARBASE}</code> or
5661: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5662: is to create such files during installation time by using
5663: installation scripts.</p>
5664: <p>The generic installation scripts are shell scripts that can
5665: contain arbitrary code. The list of scripts to execute is taken from
5666: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5667: <code class="filename">INSTALL</code>. A similar variable exists for package
5668: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5669: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5670: commands, so they have the potential to create and manage files
5671: anywhere in the file system.</p>
5672: <p>Using these general installation files is not recommended, but
5673: may be needed in some special cases. One reason for avoiding them is
5674: that the user has to trust the packager that there is no unwanted or
5675: simply erroneous code included in the installation script. Also,
5676: previously there were many similar scripts for the same functionality,
5677: and fixing a common error involved finding and changing all of
5678: them.</p>
5679: <p>The pkginstall framework offers another, standardized way. It
5680: provides generic scripts to abstract the manipulation of such files
5681: and directories based on variables set in the package's
5682: <code class="filename">Makefile</code>. The rest of this section describes
5683: these variables.</p>
1.41 asau 5684: <div class="sect2">
1.1 dsieger 5685: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5686: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5687: <p>The following variables can be set to request the creation of
5688: directories anywhere in the file system:</p>
1.41 asau 5689: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5690: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5691: contain a list of directories that should be created and should attempt
5692: to be destroyed by the installation scripts. The difference between
5693: the two is that the latter prompts the administrator to remove any
5694: directories that may be left after deinstallation (because they were
5695: not empty), while the former does not.</p></li>
1.23 wiz 5696: <li class="listitem">
1.1 dsieger 5697: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5698: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5699: which directories should be created and should attempt to be destroyed
5700: by the installation scripts. Each tuple holds the following values,
5701: separated by spaces: the directory name, its owner, its group and its
5702: numerical mode. For example:</p>
5703: <pre class="programlisting">
5704: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5705: </pre>
5706: <p>The difference between the two is exactly the same as their
5707: non-<code class="varname">PERMS</code> counterparts.</p>
5708: </li>
5709: </ul></div>
5710: </div>
1.41 asau 5711: <div class="sect2">
1.1 dsieger 5712: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5713: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5714: <p>Creating non-empty files outside the installation prefix is tricky
5715: because the <code class="filename">PLIST</code> forces all files to be inside it.
5716: To overcome this problem, the only solution is to extract the file in the
5717: known place (i.e., inside the installation prefix) and copy it to the
5718: appropriate location during installation (done by the installation scripts
5719: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5720: file</em></span> in the following paragraphs, which describe the variables
5721: that can be used to automatically and consistently handle files outside the
5722: installation prefix:</p>
1.41 asau 5723: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5724: <li class="listitem">
1.1 dsieger 5725: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5726: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5727: During installation time, the master file is copied to the target one
5728: if and only if the latter does not exist. Upon deinstallation, the
5729: target file is removed provided that it was not modified by the
5730: installation.</p>
5731: <p>The difference between the two is that the latter prompts the
5732: administrator to remove any files that may be left after
5733: deinstallation (because they were not empty), while the former does
5734: not.</p>
5735: </li>
1.23 wiz 5736: <li class="listitem">
1.1 dsieger 5737: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5738: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5739: files as well as their target locations. For each of them, it also
5740: specifies their owner, their group and their numeric permissions, in
5741: this order. For example:</p>
5742: <pre class="programlisting">
1.30 wiz 5743: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 dsieger 5744: </pre>
5745: <p>The difference between the two is exactly the same as their
5746: non-<code class="varname">PERMS</code> counterparts.</p>
5747: </li>
5748: </ul></div>
5749: </div>
5750: </div>
1.41 asau 5751: <div class="sect1">
1.1 dsieger 5752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5753: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5754: <p>Configuration files are special in the sense that they are installed
5755: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5756: need special treatment during installation (most of which is automated by
5757: pkginstall). The main concept you must bear in mind is that files marked
5758: as configuration files are automatically copied to the right place (somewhere
5759: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5760: and only if</em></span> they didn't exist before. Similarly, they will not
5761: be removed if they have local modifications. This ensures that
5762: administrators never lose any custom changes they may have made.</p>
1.41 asau 5763: <div class="sect2">
1.1 dsieger 5764: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5765: <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 5766: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5767: specifies where configuration files shall be installed. Its contents are
5768: set based upon the following variables:</p>
1.41 asau 5769: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5770: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5771: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5772: be overridden by the user to point to his preferred location (e.g.,
5773: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5774: Packages must not use it directly.</p></li>
1.23 wiz 5775: <li class="listitem">
1.1 dsieger 5776: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5777: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5778: for the package being built shall be installed. The definition of this
5779: variable only makes sense in the package's
5780: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5781: <p>As an example, consider the Apache package,
1.79 snj 5782: <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 5783: configuration files under the
5784: <code class="filename">httpd/</code> subdirectory of
5785: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5786: Makefile.</p>
5787: </li>
1.23 wiz 5788: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5789: variable that holds this package's configuration directory (if
5790: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5791: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5792: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5793: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5794: directory where the configuration files for the package identified by
5795: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5796: </ul></div>
5797: <p>Based on the above variables, pkginstall determines the value of
5798: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5799: variable that can be used within a package to refer to its configuration
5800: directory. The algorithm used to set its value is basically the
5801: following:</p>
1.23 wiz 5802: <div class="orderedlist"><ol class="orderedlist" type="1">
5803: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5804: its value is used.</p></li>
1.23 wiz 5805: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5806: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5807: <code class="filename">Makefile</code>, the resulting value is
5808: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5809: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5810: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5811: </ol></div>
5812: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5813: 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
5814: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5815: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5816: </div>
1.41 asau 5817: <div class="sect2">
1.1 dsieger 5818: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5819: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5820: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5821: known place, you need to teach each package where it shall install its
5822: files. In some cases you will have to patch the package Makefiles to
5823: achieve it. If you are lucky, though, it may be as easy as passing an
5824: extra flag to the configuration script; this is the case of GNU Autoconf-
5825: generated files:</p>
5826: <pre class="programlisting">
5827: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5828: </pre>
5829: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5830: for</em></span> its configuration files, not where they will be originally
5831: installed (although the difference is never explicit,
5832: unfortunately).</p>
5833: </div>
1.41 asau 5834: <div class="sect2">
1.1 dsieger 5835: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5836: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5837: <p>As said before, pkginstall automatically handles configuration files.
5838: This means that <span class="strong"><strong>the packages themselves must not
5839: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5840: directly</strong></span>. Bad news is that many software installation scripts
5841: will, out of the box, mess with the contents of that directory. So what is
5842: the correct procedure to fix this issue?</p>
5843: <p>You must teach the package (usually by manually patching it) to
5844: install any configuration files under the examples hierarchy,
5845: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5846: <code class="filename">PLIST</code> registers them and the administrator always
5847: has the original copies available.</p>
5848: <p>Once the required configuration files are in place (i.e., under the
5849: examples hierarchy), the pkginstall framework can use them as master copies
5850: during the package installation to update what is in
5851: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5852: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5853: 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 5854: about their syntax and their purpose. Here is an example, taken from the
1.79 snj 5855: <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 5856: <pre class="programlisting">
5857: EGDIR= ${PREFIX}/share/doc/mutt/samples
5858: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5859: </pre>
5860: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5861: package and has no meaning outside it.</p>
5862: </div>
1.41 asau 5863: <div class="sect2">
1.1 dsieger 5864: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5865: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5866: <p>The automatic copying of config files can be toggled by setting the
5867: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5868: installation.</p>
5869: </div>
5870: </div>
1.41 asau 5871: <div class="sect1">
1.1 dsieger 5872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5873: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5874: <p>System startup scripts are special files because they must be
5875: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5876: 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 5877: can be used. However, pkginstall provides a special mechanism to handle
5878: these files.</p>
5879: <p>In order to provide system startup scripts, the package has
5880: to:</p>
1.23 wiz 5881: <div class="orderedlist"><ol class="orderedlist" type="1">
5882: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5883: the <code class="literal">.sh</code> suffix appended. Considering the
1.79 snj 5884: <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 5885: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5886: <li class="listitem">
1.1 dsieger 5887: <p>Tell pkginstall to handle it, appending the name of the script,
5888: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5889: Continuing the previous example:</p>
5890: <pre class="programlisting">
5891: RCD_SCRIPTS+= cupsd
5892: </pre>
5893: </li>
5894: </ol></div>
5895: <p>Once this is done, pkginstall will do the following steps for each
5896: script in an automated fashion:</p>
1.23 wiz 5897: <div class="orderedlist"><ol class="orderedlist" type="1">
5898: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5899: substitutions described in the <code class="filename">FILES_SUBST</code>
5900: variable.</p></li>
1.23 wiz 5901: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5902: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5903: that this master file must be explicitly registered in the
5904: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5905: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5906: from the examples hierarchy into the system-wide startup scripts
5907: directory.</p></li>
5908: </ol></div>
1.41 asau 5909: <div class="sect2">
1.1 dsieger 5910: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5911: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5912: <p>The automatic copying of config files can be toggled by setting the
5913: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5914: installation. Note that the scripts will be always copied inside the
5915: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5916: matter what the value of this variable is.</p>
5917: </div>
5918: </div>
1.41 asau 5919: <div class="sect1">
1.1 dsieger 5920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5921: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5922: <p>If a package needs to create special users and/or groups during
5923: installation, it can do so by using the pkginstall framework.</p>
5924: <p>Users can be created by adding entries to the
5925: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5926: syntax:</p>
5927: <pre class="programlisting">
5928: user:group
5929: </pre>
5930: <p>Further specification of user details may be done by setting
5931: per-user variables.
5932: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5933: numeric UID for the user.
5934: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5935: user's description or comment.
5936: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5937: user's home directory, and defaults to
5938: <code class="filename">/nonexistent</code> if not specified.
5939: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5940: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5941: not specified.</p>
5942: <p>Similarly, groups can be created by adding entries to the
5943: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5944: <pre class="programlisting">
5945: group
5946: </pre>
5947: <p>The numeric GID of the group may be set by defining
5948: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5949: <p>If a package needs to create the users and groups at an earlier
5950: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5951: either <code class="literal">configure</code> or <code class="literal">build</code> to
5952: indicate the phase before which the users and groups are created. In
5953: this case, the numeric UIDs and GIDs of the created users and groups
5954: are automatically hardcoded into the final installation scripts.</p>
5955: </div>
1.41 asau 5956: <div class="sect1">
1.1 dsieger 5957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5958: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5959: <p>Packages that install system shells should register them in the shell
5960: database, <code class="filename">/etc/shells</code>, to make things easier to the
5961: administrator. This must be done from the installation scripts to keep
5962: binary packages working on any system. pkginstall provides an easy way to
5963: accomplish this task.</p>
5964: <p>When a package provides a shell interpreter, it has to set the
5965: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5966: add some hooks to the installation scripts to handle it. Consider the
1.79 snj 5967: 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 5968: <pre class="programlisting">
5969: PKG_SHELL= ${PREFIX}/bin/zsh
5970: </pre>
1.41 asau 5971: <div class="sect2">
1.1 dsieger 5972: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5973: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5974: <p>The automatic registration of shell interpreters can be disabled by
5975: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5976: environment variable to <code class="literal">NO</code>.</p>
5977: </div>
5978: </div>
1.41 asau 5979: <div class="sect1">
1.1 dsieger 5980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5981: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5982: <p>Packages that install X11 fonts should update the database files
5983: that index the fonts within each fonts directory. This can easily be
5984: accomplished within the pkginstall framework.</p>
5985: <p>When a package installs X11 fonts, it must list the directories in
5986: which fonts are installed in the
5987: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5988: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5989: <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 5990: installation scripts to run the appropriate commands to update the fonts
5991: database files within each of those directories. For convenience, if the
5992: directory path is relative, it is taken to be relative to the package's
1.79 snj 5993: 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 5994: <pre class="programlisting">
1.67 wiz 5995: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5996: </pre>
1.41 asau 5997: <div class="sect2">
1.1 dsieger 5998: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5999: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 6000: <p>The automatic update of fonts databases can be disabled by
6001: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6002: environment variable to <code class="literal">NO</code>.</p>
6003: </div>
6004: </div>
6005: </div>
1.41 asau 6006: <div class="chapter">
1.1 dsieger 6007: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6008: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 6009: <div class="toc">
6010: <p><b>Table of Contents</b></p>
1.100 leot 6011: <dl class="toc">
1.6 rillig 6012: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 6013: <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 6014: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 6015: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 6016: </dl>
6017: </div>
6018: <p>Many packages have the ability to be built to support different
6019: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6020: in pkgsrc that provides generic handling of those options that
6021: determine different ways in which the packages can be built. It's
6022: possible for the user to specify exactly which sets of options will be
6023: built into a package or to allow a set of global default options
6024: apply.</p>
1.7 rillig 6025: <p>There are two broad classes of behaviors that one might want to
6026: control via options. One is whether some particular feature is
6027: enabled in a program that will be built anyway, often by including or
6028: not including a dependency on some other package. The other is
6029: whether or not an additional program will be built as part of the
6030: package. Generally, it is better to make a split package for such
6031: additional programs instead of using options, because it enables
6032: binary packages to be built which can then be added separately. For
6033: example, the foo package might have minimal dependencies (those
6034: packages without which foo doesn't make sense), and then the foo-gfoo
6035: package might include the GTK frontend program gfoo. This is better
6036: than including a gtk option to foo that adds gfoo, because either that
6037: option is default, in which case binary users can't get foo without
6038: gfoo, or not default, in which case they can't get gfoo. With split
6039: packages, they can install foo without having GTK, and later decide to
6040: install gfoo (pulling in GTK at that time). This is an advantage to
6041: source users too, avoiding the need for rebuilds.</p>
6042: <p>Plugins with widely varying dependencies should usually be split
6043: instead of options.</p>
6044: <p>It is often more work to maintain split packages, especially if
6045: the upstream package does not support this. The decision of split
6046: vs. option should be made based on the likelihood that users will want
6047: or object to the various pieces, the size of the dependencies that are
6048: included, and the amount of work.</p>
6049: <p>A further consideration is licensing. Non-free parts, or parts
6050: that depend on non-free dependencies (especially plugins) should
6051: almost always be split if feasible.</p>
1.41 asau 6052: <div class="sect1">
1.1 dsieger 6053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6054: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6055: <p>Global default options are listed in
6056: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6057: that should be built into every package if that option is supported.
1.10 hubertf 6058: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6059: </div>
1.41 asau 6060: <div class="sect1">
1.1 dsieger 6061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6062: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6063: </h2></div></div></div>
6064: <p>The following example shows how
6065: <code class="filename">bsd.options.mk</code> should be used
6066: by the hypothetical ``wibble'' package, either in the package
6067: <code class="filename">Makefile</code>, or in a file,
6068: e.g. <code class="filename">options.mk</code>, that is included by the
6069: main package <code class="filename">Makefile</code>.</p>
6070: <pre class="programlisting">
6071: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6072: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6073: PKG_OPTIONS_OPTIONAL_GROUPS= database
6074: PKG_OPTIONS_GROUP.database= mysql pgsql
6075: PKG_SUGGESTED_OPTIONS= wibble-foo
6076: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6077: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6078:
6079: .include "../../mk/bsd.prefs.mk"
6080:
6081: # this package was previously named wibble2
6082: .if defined(PKG_OPTIONS.wibble2)
6083: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6084: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6085: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6086: .endif
6087:
6088: .include "../../mk/bsd.options.mk"
6089:
6090: # Package-specific option-handling
6091:
6092: ###
6093: ### FOO support
6094: ###
6095: .if !empty(PKG_OPTIONS:Mwibble-foo)
6096: CONFIGURE_ARGS+= --enable-foo
6097: .endif
6098:
6099: ###
6100: ### LDAP support
6101: ###
6102: .if !empty(PKG_OPTIONS:Mldap)
6103: . include "../../databases/openldap-client/buildlink3.mk"
6104: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6105: .endif
6106:
6107: ###
6108: ### database support
6109: ###
6110: .if !empty(PKG_OPTIONS:Mmysql)
6111: . include "../../mk/mysql.buildlink3.mk"
6112: .endif
6113: .if !empty(PKG_OPTIONS:Mpgsql)
6114: . include "../../mk/pgsql.buildlink3.mk"
6115: .endif
6116: </pre>
6117: <p>The first section contains the information about which build
6118: options are supported by the package, and any default options settings
6119: if needed.</p>
1.23 wiz 6120: <div class="orderedlist"><ol class="orderedlist" type="1">
6121: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.79 snj 6122: <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 6123: options. It should be set to
6124: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6125: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6126: at the point where the options are processed.</p></li>
1.23 wiz 6127: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 6128: build options supported by the package.</p></li>
1.23 wiz 6129: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 6130: list of names of groups of mutually exclusive options. The options in
6131: each group are listed in
6132: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6133: The most specific setting of any option from the group takes
6134: precedence over all other options in the group. Options from the
6135: groups will be automatically added to
6136: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 6137: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 6138: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6139: packages will fail if no option from the group is
6140: selected.</p></li>
1.23 wiz 6141: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 6142: of names of sets of options. At least one option from each set must
6143: be selected. The options in each set are listed in
6144: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6145: Options from the sets will be automatically added to
6146: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6147: fail if no option from the set is selected.</p></li>
1.23 wiz 6148: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 6149: build options which are enabled by default.</p></li>
1.23 wiz 6150: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 6151: of
1.23 wiz 6152: <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 6153: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6154: their option counterparts. Pairs should be added with
1.23 wiz 6155: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 6156: warning will be issued if the user uses a legacy
6157: variable.</p></li>
1.23 wiz 6158: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 6159: of
1.23 wiz 6160: <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 6161: pairs that map options that have been renamed to their new
1.23 wiz 6162: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 6163: the listing of global legacy options. A warning will be issued if
6164: the user uses a legacy option.</p></li>
1.23 wiz 6165: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 6166: options implied by deprecated variables used. This can be used for
6167: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6168: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6169: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 6170: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 6171: a list of warnings about deprecated variables or options used, and
6172: what to use instead.</p></li>
6173: </ol></div>
6174: <p>A package should never modify
6175: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6176: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6177: To suggest a default set of options, use
6178: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6179: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6180: including <code class="filename">bsd.options.mk</code>. If none of
6181: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6182: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6183: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6184: happen with platform-specific options if none of them is supported on
6185: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6186: empty list and the package is otherwise treated as not using the
6187: options framework.</p>
6188: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6189: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6190: build options, properly filtered to remove unsupported and duplicate
6191: options.</p>
6192: <p>The remaining sections contain the logic that is specific to
6193: each option. The correct way to check for an option is to check
6194: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6195: <pre class="programlisting">
6196: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6197: </pre>
6198: </div>
1.41 asau 6199: <div class="sect1">
1.1 dsieger 6200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6201: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6202: <p>Options that enable similar features in different packages (like
6203: optional support for a library) should use a common name in all
6204: packages that support it (like the name of the library). If another
6205: package already has an option with the same meaning, use the same
6206: name.</p>
6207: <p>Options that enable features specific to one package, where it's
6208: unlikely that another (unrelated) package has the same (or a similar)
6209: optional feature, should use a name prefixed with
6210: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6211: <p>If a group of related packages share an optional feature
6212: specific to that group, prefix it with the name of the
1.23 wiz 6213: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 6214: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6215: <p>For new options, add a line to
6216: <code class="filename">mk/defaults/options.description</code>. Lines have two
6217: fields, separated by tab. The first field is the option name, the
6218: second its description. The description should be a whole sentence
6219: (starting with an uppercase letter and ending with a period) that
1.23 wiz 6220: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6221: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 6222: </div>
1.41 asau 6223: <div class="sect1">
1.7 rillig 6224: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6225: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 6226: <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 6227: different dependencies based on the options with which the package was
6228: built. For querying these options, the file
6229: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6230: typical example looks like this:</p>
6231: <pre class="programlisting">
6232: pkgbase := libpurple
6233: .include "../../mk/pkg-build-options.mk"
6234:
6235: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6236: ...
6237: .endif
6238: </pre>
6239: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6240: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6241: options of the libpurple package, which can then be queried like
6242: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6243: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6244: details.</p>
6245: </div>
1.1 dsieger 6246: </div>
1.41 asau 6247: <div class="chapter">
1.1 dsieger 6248: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6249: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6250: <div class="toc">
6251: <p><b>Table of Contents</b></p>
1.100 leot 6252: <dl class="toc">
1.6 rillig 6253: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6254: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6255: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6256: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 6257: <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 6258: <dd><dl>
6259: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6260: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6261: </dl></dd>
1.23 wiz 6262: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6263: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6264: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6265: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6266: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6267: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6268: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6269: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6270: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6271: <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 6272: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6273: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6274: </dl>
6275: </div>
1.41 asau 6276: <div class="sect1">
1.1 dsieger 6277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6278: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6279: <p>This chapter gives a detailed description on how a package is
6280: built. Building a package is separated into different
6281: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6282: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 6283: described in the following sections. Each phase is split into
1.1 dsieger 6284: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6285: containing phase, prefixed by one of <code class="varname">pre-</code>,
6286: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6287: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6288: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6289: <p>Never override the regular targets (like
6290: <code class="varname">fetch</code>), if you have to, override the
6291: <code class="varname">do-*</code> ones instead.</p>
6292: <p>The basic steps for building a program are always the same. First
6293: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6294: the local system and then extracted. After any pkgsrc-specific patches
6295: to compile properly are applied, the software can be configured, then
6296: built (usually by compiling), and finally the generated binaries, etc.
6297: can be put into place on the system.</p>
6298: <p>To get more details about what is happening at each step,
6299: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6300: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6301: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6302: </div>
1.41 asau 6303: <div class="sect1">
1.1 dsieger 6304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6305: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6306: <p>Before outlining the process performed by the NetBSD package system in
6307: the next section, here's a brief discussion on where programs are
6308: installed, and which variables influence this.</p>
6309: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6310: where all files of the final program shall be installed. It is
6311: usually set to <code class="varname">LOCALBASE</code>
6312: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6313: for pkgs in the <code class="filename">cross</code> category. The value of
6314: <code class="varname">PREFIX</code> needs to be put
6315: into the various places in the program's source where paths to
1.10 hubertf 6316: 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 6317: <p>When choosing which of these variables to use,
6318: follow the following rules:</p>
1.41 asau 6319: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6320: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 6321: where the current pkg will be installed. When referring to a
6322: pkg's own installation path, use
1.23 wiz 6323: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6324: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 6325: are installed. If you need to construct a -I or -L argument
6326: to the compiler to find includes and libraries installed by
1.23 wiz 6327: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 6328: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6329: installed all packages in <code class="filename">/usr/local</code>. As
6330: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6331: administrator, this variable is a misnomer.</p></li>
1.23 wiz 6332: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 6333: distribution (from xsrc, etc.) is installed. When looking for
6334: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 6335: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 6336: <li class="listitem"><p>X11-based packages using imake must set
6337: <code class="varname">USE_IMAKE</code> to be installed correctly under
6338: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 6339: <li class="listitem">
1.99 sevan 6340: <p>To determine the prefix of an
1.1 dsieger 6341: installed package, the <code class="varname">EVAL_PREFIX</code>
6342: definition can be used. It takes pairs in the format
1.79 snj 6343: <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 6344: variable <code class="varname">DIRNAME</code> will be set to the prefix
6345: of the installed package <package>, or
1.99 sevan 6346: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> if the package is not
1.1 dsieger 6347: installed.</p>
6348: <p>This is best illustrated by example.</p>
6349: <p>The following lines are taken from
6350: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6351: <pre class="programlisting">
6352: EVAL_PREFIX+= GTKDIR=gtk+
6353: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6354: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6355: CONFIGURE_ARGS+= --enable-multibyte
6356: </pre>
6357: <p>Specific defaults can be defined for the packages
6358: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6359: definition of the form:</p>
6360: <pre class="programlisting">
6361: GTKDIR_DEFAULT= ${LOCALBASE}
6362: </pre>
6363: <p>where <code class="varname">GTKDIR</code> corresponds
6364: to the first definition in
6365: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6366: </li>
1.23 wiz 6367: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.79 snj 6368: 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 6369: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6370: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6371: </ul></div>
6372: </div>
1.41 asau 6373: <div class="sect1">
1.1 dsieger 6374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6375: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 6376: <p>When building a package, various directories are used to store
1.1 dsieger 6377: source files, temporary files, pkgsrc-internal files, and so on. These
6378: directories are explained here.</p>
6379: <p>Some of the directory variables contain relative pathnames. There
6380: are two common base directories for these relative directories:
6381: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6382: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6383: inside the package itself.</p>
1.41 asau 6384: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6385: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6386: <dd><p>This is an absolute pathname that points to the pkgsrc
6387: root directory. Generally, you don't need
6388: it.</p></dd>
6389: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6390: <dd><p>This is an absolute pathname that points to the
6391: current package.</p></dd>
6392: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6393: <dd><p>This is a pathname relative to
6394: <code class="varname">PKGSRCDIR</code> that points to the current
6395: package.</p></dd>
6396: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6397: <dd><p>This is an absolute pathname pointing to the directory
6398: where all work takes place. The distfiles are extracted to this
6399: directory. It also contains temporary directories and log files used by
6400: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6401: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6402: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6403: <dd><p>This is an absolute pathname pointing to the directory
6404: where the distfiles are extracted. It is usually a direct subdirectory
6405: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6406: that isn't hidden. This variable may be changed by a package
6407: <code class="filename">Makefile</code>.</p></dd>
6408: </dl></div>
1.14 jmcneill 6409: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6410: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 6411: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 6412: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6413: If users would like to have their pkgsrc trees behave in a
6414: read-only manner, then the value of
6415: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6416: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 6417: </div>
1.41 asau 6418: <div class="sect1">
1.1 dsieger 6419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6420: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 6421: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6422: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6423: phase. This will automatically run all phases that are required for this
6424: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6425: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6426: the package will be built, but not installed.</p>
6427: </div>
1.41 asau 6428: <div class="sect1">
1.1 dsieger 6429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6430: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6431: <p>The first step in building a package is to fetch the
6432: distribution files (distfiles) from the sites that are providing
6433: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6434: phase.</p>
1.41 asau 6435: <div class="sect2">
1.1 dsieger 6436: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6437: <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 6438: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6439: defines all URLs from where the distfile, whose name is
6440: derived from the <code class="varname">DISTNAME</code> variable, is
6441: fetched. The more complicated cases are described
6442: below.</p>
6443: <p>The variable <code class="varname">DISTFILES</code> specifies
6444: the list of distfiles that have to be fetched. Its value
1.66 asau 6445: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6446: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 6447: so that most packages don't need to define it at all.
6448: <code class="varname">EXTRACT_SUFX</code> is
6449: <code class="literal">.tar.gz</code> by default, but can be changed
6450: freely. Note that if your package requires additional
6451: distfiles to the default one, you cannot just append the
6452: additional filenames using the <code class="literal">+=</code>
6453: operator, but you have write for example:</p>
6454: <pre class="programlisting">
1.66 asau 6455: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 6456: </pre>
6457: <p>Each distfile is fetched from a list of sites, usually
6458: <code class="varname">MASTER_SITES</code>. If the package has multiple
6459: <code class="varname">DISTFILES</code> or multiple
6460: <code class="varname">PATCHFILES</code> from different sites, you can
6461: set
6462: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6463: to the list of URLs where the file
6464: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6465: (including the suffix) can be found.</p>
6466: <pre class="programlisting">
6467: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6468: DISTFILES+= foo-file.tar.gz
6469: SITES.foo-file.tar.gz= \
6470: http://www.somewhere.com/somehow/ \
6471: http://www.somewhereelse.com/mirror/somehow/
6472: </pre>
6473: <p>When actually fetching the distfiles, each item from
6474: <code class="varname">MASTER_SITES</code> or
6475: <code class="varname">SITES.*</code> gets the name of each distfile
6476: appended to it, without an intermediate slash. Therefore,
6477: all site values have to end with a slash or other separator
6478: character. This allows for example to set
6479: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6480: that gets the name of the distfile as a parameter. In this
6481: case, the definition would look like:</p>
6482: <pre class="programlisting">
6483: MASTER_SITES= http://www.example.com/download.cgi?file=
6484: </pre>
1.22 jakllsch 6485: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 6486: In that case the URL is taken as is, fetched and the result
6487: stored under the name of the distfile. You can use this style
6488: for the case when the download URL style does not match the
6489: above common case. For example, if permanent download URL is a
6490: redirector to the real download URL, or the download file name
6491: is offered by an HTTP Content-Disposition header. In the
6492: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6493: created instead of the default
6494: <code class="filename">v1.0.0.tar.gz</code>.</p>
6495: <pre class="programlisting">
6496: DISTNAME= foo-1.0.0
6497: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6498: </pre>
1.1 dsieger 6499: <p>There are some predefined values for
6500: <code class="varname">MASTER_SITES</code>, which can be used in
6501: packages. The names of the variables should speak for
6502: themselves.</p>
6503: <pre class="programlisting">
6504: ${MASTER_SITE_APACHE}
6505: ${MASTER_SITE_BACKUP}
6506: ${MASTER_SITE_CYGWIN}
6507: ${MASTER_SITE_DEBIAN}
6508: ${MASTER_SITE_FREEBSD}
6509: ${MASTER_SITE_FREEBSD_LOCAL}
6510: ${MASTER_SITE_GENTOO}
6511: ${MASTER_SITE_GNOME}
6512: ${MASTER_SITE_GNU}
6513: ${MASTER_SITE_GNUSTEP}
1.66 asau 6514: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 6515: ${MASTER_SITE_IFARCHIVE}
6516: ${MASTER_SITE_KDE}
6517: ${MASTER_SITE_MOZILLA}
1.66 asau 6518: ${MASTER_SITE_MOZILLA_ALL}
6519: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 6520: ${MASTER_SITE_MYSQL}
1.66 asau 6521: ${MASTER_SITE_NETLIB}
1.1 dsieger 6522: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 6523: ${MASTER_SITE_OSDN}
1.1 dsieger 6524: ${MASTER_SITE_PERL_CPAN}
6525: ${MASTER_SITE_PGSQL}
1.66 asau 6526: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 6527: ${MASTER_SITE_R_CRAN}
6528: ${MASTER_SITE_SOURCEFORGE}
6529: ${MASTER_SITE_SUNSITE}
6530: ${MASTER_SITE_SUSE}
6531: ${MASTER_SITE_TEX_CTAN}
6532: ${MASTER_SITE_XCONTRIB}
6533: ${MASTER_SITE_XEMACS}
1.66 asau 6534: ${MASTER_SITE_XORG}
1.1 dsieger 6535: </pre>
6536: <p>Some explanations for the less self-explaining ones:
6537: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6538: 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 6539: 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 6540: <p>If you choose one of these predefined sites, you may
6541: want to specify a subdirectory of that site. Since these
6542: macros may expand to more than one actual site, you
6543: <span class="emphasis"><em>must</em></span> use the following construct to
6544: specify a subdirectory:</p>
6545: <pre class="programlisting">
6546: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6547: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6548: </pre>
6549: <p>Note the trailing slash after the subdirectory
6550: name.</p>
6551: </div>
1.41 asau 6552: <div class="sect2">
1.1 dsieger 6553: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6554: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6555: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6556: all the distfiles exist in a local directory
6557: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6558: user). If the files do not exist, they are fetched using
6559: commands of the form</p>
6560: <pre class="programlisting">
6561: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6562: </pre>
6563: <p>where <code class="literal">${site}</code> varies through
6564: several possibilities in turn: first,
6565: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6566: sites specified in either <code class="varname">SITES.file</code> if
6567: defined, else <code class="varname">MASTER_SITES</code> or
6568: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6569: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6570: all except the first and the last can be optionally sorted
6571: by the user, via setting either
6572: <code class="varname">MASTER_SORT_RANDOM</code>, and
6573: <code class="varname">MASTER_SORT_AWK</code> or
6574: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6575: <p> The specific command and arguments used depend on the
6576: <code class="varname">FETCH_USING</code> parameter. The example above is
6577: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6578: <p>The distfiles mirror run by the NetBSD Foundation uses the
6579: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6580: distfiles, if they are freely distributable. Packages setting
6581: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6582: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6583: mirrored.</p>
6584: </div>
6585: </div>
1.41 asau 6586: <div class="sect1">
1.1 dsieger 6587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6588: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6589: <p>After the distfile(s) are fetched, their checksum is
6590: generated and compared with the checksums stored in the
6591: distinfo file. If the checksums don't match, the build is
6592: aborted. This is to ensure the same distfile is used for
6593: building, and that the distfile wasn't changed, e.g. by some
6594: malign force, deliberately changed distfiles on the master
6595: distribution site or network lossage.</p>
6596: </div>
1.41 asau 6597: <div class="sect1">
1.1 dsieger 6598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6599: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6600: <p>When the distfiles are present on the local system, they
6601: need to be extracted, as they usually come in the form of some
6602: compressed archive format.</p>
6603: <p>By default, all <code class="varname">DISTFILES</code> are
6604: extracted. If you only need some of them, you can set the
6605: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6606: files.</p>
6607: <p>Extracting the files is usually done by a little
6608: program, <code class="filename">mk/extract/extract</code>, which
6609: already knows how to extract various archive formats, so most
6610: likely you will not need to change anything here. But if you
6611: need, the following variables may help you:</p>
1.41 asau 6612: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6613: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6614: <dd><p>Use these variables to override the default
6615: options for an extract command, which are defined in
6616: <code class="filename">mk/extract/extract</code>.</p></dd>
6617: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6618: <dd><p>This variable can be set to
1.14 jmcneill 6619: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6620: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6621: absolute pathname pointing to the command with which tar
1.14 jmcneill 6622: archives should be extracted. It is preferred to choose bsdtar over gtar
6623: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6624: </dl></div>
6625: <p>If the <code class="filename">extract</code> program doesn't
6626: serve your needs, you can also override the
6627: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6628: command used for extracting the files. This command is
6629: executed in the <code class="filename">${WRKSRC}</code>
6630: directory. During execution of this command, the shell
6631: variable <code class="varname">extract_file</code> holds the absolute
6632: pathname of the file that is going to be extracted.</p>
6633: <p>And if that still does not suffice, you can override the
6634: <code class="varname">do-extract</code> target in the package
6635: Makefile.</p>
6636: </div>
1.41 asau 6637: <div class="sect1">
1.1 dsieger 6638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6639: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6640: <p>After extraction, all the patches named by the
6641: <code class="varname">PATCHFILES</code>, those present in the patches
6642: subdirectory of the package as well as in
6643: $LOCALPATCHES/$PKGPATH (e.g.
6644: <code class="filename">/usr/local/patches/graphics/png</code>) are
6645: applied. Patchfiles ending in <code class="filename">.Z</code> or
6646: <code class="filename">.gz</code> are uncompressed before they are
6647: applied, files ending in <code class="filename">.orig</code> or
6648: <code class="filename">.rej</code> are ignored. Any special options to
1.79 snj 6649: <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 6650: <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 6651: <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 6652: it fail if the patches apply with some lines of fuzz. Please
6653: fix (regen) the patches so that they apply cleanly. The
6654: rationale behind this is that patches that don't apply cleanly
6655: may end up being applied in the wrong place, and cause severe
6656: harm there.</p>
6657: </div>
1.41 asau 6658: <div class="sect1">
1.1 dsieger 6659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6660: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6661: <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 6662: </p>
6663: </div>
1.41 asau 6664: <div class="sect1">
1.1 dsieger 6665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6666: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6667: <p>This phase creates wrapper programs for the compilers and
6668: linkers. The following variables can be used to tweak the
6669: wrappers.</p>
1.41 asau 6670: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6671: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6672: <dd><p>The command used to print progress
6673: messages. Does nothing by default. Set to
6674: <code class="literal">${ECHO}</code> to see the progress
6675: messages.</p></dd>
6676: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6677: <dd><p>This variable can be set to
6678: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6679: depending on whether you want additional information in the
6680: wrapper log file.</p></dd>
6681: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6682: <dd><p>This variable can be set to
6683: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6684: on whether the wrapper should use its cache, which will
6685: improve the speed. The default value is
6686: <code class="literal">yes</code>, but is forced to
6687: <code class="literal">no</code> if the platform does not support
6688: it.</p></dd>
6689: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6690: <dd><p>A list of reordering commands. A reordering
6691: command has the form
6692: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6693: It ensures that that
6694: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6695: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6696: </p></dd>
6697: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6698: <dd><p>A list of transformation commands. [TODO:
6699: investigate further]</p></dd>
6700: </dl></div>
6701: </div>
1.41 asau 6702: <div class="sect1">
1.1 dsieger 6703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6704: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6705: <p>Most pieces of software need information on the header
6706: files, system calls, and library routines which are available
6707: on the platform they run on. The process of determining this
6708: information is known as configuration, and is usually
6709: automated. In most cases, a script is supplied with the
6710: distfiles, and its invocation results in generation of header
6711: files, Makefiles, etc.</p>
6712: <p>If the package contains a configure script, this can be
6713: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6714: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6715: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6716: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6717: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6718: <pre class="programlisting">
6719: .for d in ${CONFIGURE_DIRS}
6720: cd ${WRKSRC} \
6721: && cd ${d} \
6722: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6723: .endfor
6724: </pre>
6725: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6726: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6727: <code class="varname">WRKSRC</code>. In each of these directories, the
6728: configure script is run with the environment
6729: <code class="varname">CONFIGURE_ENV</code> and arguments
6730: <code class="varname">CONFIGURE_ARGS</code>. The variables
6731: <code class="varname">CONFIGURE_ENV</code>,
6732: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6733: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6734: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6735: package.</p>
1.37 wiz 6736: <p>If the program uses the Perl way of configuration (mainly Perl
6737: modules, but not only), i.e. a file called
6738: <code class="filename">Makefile.PL</code>, it should include
6739: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6740: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6741: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6742: <p>If the program uses an <code class="filename">Imakefile</code>
6743: for configuration, the appropriate steps can be invoked by
6744: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6745: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6746: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6747: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6748: <p>If the program uses <code class="filename">cmake</code>
6749: for configuration, the appropriate steps can be invoked by
1.23 wiz 6750: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6751: You can add variables to cmake's environment by adding them to the
6752: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6753: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6754: The top directory argument is given by the
6755: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6756: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6757: <p>If there is no configure step at all, set
1.23 wiz 6758: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6759: </div>
1.41 asau 6760: <div class="sect1">
1.1 dsieger 6761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6762: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6763: <p>For building a package, a rough equivalent of the
6764: following code is executed.</p>
6765: <pre class="programlisting">
6766: .for d in ${BUILD_DIRS}
6767: cd ${WRKSRC} \
6768: && cd ${d} \
6769: && env ${MAKE_ENV} \
6770: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6771: -f ${MAKE_FILE} \
6772: ${BUILD_TARGET}
6773: .endfor
6774: </pre>
6775: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6776: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6777: <code class="varname">WRKSRC</code>. In each of these directories,
6778: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6779: <code class="varname">MAKE_ENV</code> and arguments
6780: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6781: <code class="varname">MAKE_ENV</code>,
6782: <code class="varname">BUILD_MAKE_FLAGS</code>,
6783: <code class="varname">MAKE_FILE</code> and
6784: <code class="varname">BUILD_TARGET</code> may all be changed by the
6785: package.</p>
6786: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6787: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6788: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6789: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6790: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6791: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6792: <p>If there is no build step at all, set
1.23 wiz 6793: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6794: </div>
1.41 asau 6795: <div class="sect1">
1.1 dsieger 6796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6797: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6798: <p>[TODO]</p>
6799: </div>
1.41 asau 6800: <div class="sect1">
1.1 dsieger 6801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6802: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6803: <p>Once the build stage has completed, the final step is to
6804: install the software in public directories, so users can
6805: access the programs and files.</p>
6806: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6807: equivalent of the following code is executed. Additionally,
6808: before and after this code, much magic is performed to do
6809: consistency checks, registering the package, and so on.</p>
6810: <pre class="programlisting">
6811: .for d in ${INSTALL_DIRS}
6812: cd ${WRKSRC} \
6813: && cd ${d} \
6814: && env ${MAKE_ENV} \
6815: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6816: -f ${MAKE_FILE} \
6817: ${INSTALL_TARGET}
6818: .endfor
6819: </pre>
6820: <p>The variable's meanings are analogous to the ones in the
6821: <span class="emphasis"><em>build</em></span> phase.
6822: <code class="varname">INSTALL_DIRS</code> defaults to
6823: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6824: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6825: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6826: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6827: defined.</p>
6828: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6829: variables are useful. They are all variations of the
1.79 snj 6830: <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 6831: permissions preset. <code class="varname">INSTALL</code> is the plain
6832: install command. The specialized variants, together with their
6833: intended use, are:</p>
1.41 asau 6834: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6835: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6836: <dd><p>directories that contain
6837: binaries</p></dd>
6838: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6839: <dd><p>directories that contain
6840: scripts</p></dd>
6841: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6842: <dd><p>directories that contain shared and static
6843: libraries</p></dd>
6844: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6845: <dd><p>directories that contain data
6846: files</p></dd>
6847: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6848: <dd><p>directories that contain man
6849: pages</p></dd>
1.100 leot 6850: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6851: <dd><p>directories that contain data files for games
6852: </p></dd>
1.1 dsieger 6853: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6854: <dd><p>binaries that can be stripped from debugging
6855: symbols</p></dd>
6856: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6857: <dd><p>binaries that cannot be
6858: stripped</p></dd>
6859: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6860: <dd><p>game
6861: binaries</p></dd>
6862: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6863: <dd><p>shared and static
6864: libraries</p></dd>
6865: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6866: <dd><p>data files</p></dd>
6867: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6868: <dd><p>data files for
6869: games</p></dd>
6870: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6871: <dd><p>man pages</p></dd>
6872: </dl></div>
6873: <p>Some other variables are:</p>
1.41 asau 6874: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6875: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6876: <dd><p>A list of directories relative to
6877: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6878: beginning of the <span class="emphasis"><em>install</em></span> phase.
6879: The package is supposed to create all needed directories itself
6880: before installing files to it and list all other directories here.
6881: </p></dd>
6882: </dl></div>
6883: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6884: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6885: mostly relevant for packages in the <code class="filename">regress</code>
6886: category.</p>
6887: </div>
1.41 asau 6888: <div class="sect1">
1.1 dsieger 6889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6890: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6891: <p>Once the install stage has completed, a binary package of
6892: the installed files can be built. These binary packages can be
6893: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6894: the <span class="command"><strong>make bin-install</strong></span> or by using
6895: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6896: <p>By default, the binary packages are created in
6897: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6898: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6899: one for each category in the <code class="varname">CATEGORIES</code>
6900: variable. <code class="varname">PACKAGES</code> defaults to
6901: <code class="filename">pkgsrc/packages</code>.</p>
6902: </div>
1.41 asau 6903: <div class="sect1">
1.1 dsieger 6904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6905: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6906: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6907: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6908: to clean the work directories of all dependencies too, use
1.10 hubertf 6909: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6910: </div>
1.41 asau 6911: <div class="sect1">
1.1 dsieger 6912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6913: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6914: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6915: <dt><span class="term">pre/post-*</span></dt>
6916: <dd><p>For any of the main targets described in the
6917: previous section, two auxiliary targets exist with
1.23 wiz 6918: <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 6919: prefix for the main target's name. These targets are
6920: invoked before and after the main target is called,
6921: allowing extra configuration or installation steps be
6922: performed from a package's Makefile, for example, which
6923: a program's configure script or install target
6924: omitted.</p></dd>
6925: <dt><span class="term">do-*</span></dt>
6926: <dd><p>Should one of the main targets do the wrong thing,
6927: and should there be no variable to fix this, you can
6928: redefine it with the do-* target. (Note that redefining
6929: the target itself instead of the do-* target is a bad
6930: idea, as the pre-* and post-* targets won't be called
6931: anymore, etc.) You will not usually need to do
6932: this.</p></dd>
6933: <dt><span class="term">reinstall</span></dt>
6934: <dd>
1.10 hubertf 6935: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6936: you noticed some file was not installed properly, you
6937: can repeat the installation with this target, which will
1.23 wiz 6938: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6939: <p>This is the default value of
6940: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6941: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6942: package</strong></span>, where the defaults are
1.23 wiz 6943: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6944: respectively.</p>
6945: </dd>
6946: <dt><span class="term">deinstall</span></dt>
6947: <dd>
1.79 snj 6948: <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 6949: current directory, effectively de-installing the
6950: package. The following variables can be used to tune the
6951: behaviour:</p>
1.41 asau 6952: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6953: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.79 snj 6954: <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 6955: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6956: <dd><p>Remove all packages that require (depend on)
6957: the given package. This can be used to remove any
6958: packages that may have been pulled in by a given
1.10 hubertf 6959: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6960: DEINSTALLDEPENDS=1</strong></span> is done in
6961: <code class="filename">pkgsrc/x11/kde</code>, this is
6962: likely to remove whole KDE. Works by adding
1.79 snj 6963: <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 6964: command line.</p></dd>
6965: </dl></div>
6966: </dd>
6967: <dt><span class="term">bin-install</span></dt>
6968: <dd><p>Install a binary package from local disk and via FTP
6969: from a list of sites (see the
6970: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6971: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6972: available anywhere. The arguments given to
1.10 hubertf 6973: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6974: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6975: operation, etc.</p></dd>
1.95 wiz 6976: <dt><span class="term">install-clean</span></dt>
6977: <dd><p>This target removes the state files for the "install" and later
6978: phases so that the "install" target may be re-invoked. This can be
6979: used after editing the PLIST to install the package without
6980: rebuilding it.</p></dd>
6981: <dt><span class="term">build-clean</span></dt>
6982: <dd><p>This target removes the state files for the "build" and later
6983: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6984: <dt><span class="term">update</span></dt>
6985: <dd>
6986: <p>This target causes the current package to be
6987: updated to the latest version. The package and all
6988: depending packages first get de-installed, then current
6989: versions of the corresponding packages get compiled and
6990: installed. This is similar to manually noting which
6991: packages are currently installed, then performing a
1.10 hubertf 6992: series of <span class="command"><strong>make deinstall</strong></span> and
6993: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6994: <code class="varname">UPDATE_TARGET</code> is set to) for these
6995: packages.</p>
1.23 wiz 6996: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6997: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6998: update</strong></span> was interrupted for some reason.
6999: However, in this case, make sure you don't call
1.10 hubertf 7000: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 7001: list of dependent packages in <code class="varname">WRKDIR</code>.
7002: Otherwise, you lose the ability to automatically update
7003: the current package along with the dependent packages
7004: you have installed.</p>
1.10 hubertf 7005: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 7006: update</strong></span> will only work as long as the package
7007: tree remains unchanged. If the source code for one of
7008: the packages to be updated has been changed, resuming
1.10 hubertf 7009: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 7010: fail!</p>
7011: <p>The following variables can be used either on the
1.10 hubertf 7012: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7013: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 7014: update</strong></span>:</p>
1.41 asau 7015: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7016: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7017: <dd><p>Install target to recursively use for the
7018: updated package and the dependent packages.
7019: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 7020: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 7021: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 7022: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7023: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7024: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 7025: endless loop!</p></dd>
7026: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7027: <dd><p>Don't clean up after updating. Useful if
7028: you want to leave the work sources of the updated
7029: packages around for inspection or other purposes.
7030: Be sure you eventually clean up the source tree
1.23 wiz 7031: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 7032: or you may run into troubles with old source code
7033: still lying around on your next
1.10 hubertf 7034: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 7035: update</strong></span>.</p></dd>
7036: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7037: <dd><p>Deinstall each package before installing
7038: (making <code class="varname">DEPENDS_TARGET</code>). This
7039: may be necessary if the
1.23 wiz 7040: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 7041: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 7042: update</strong></span>.</p></dd>
7043: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7044: <dd><p>Allows you to disable recursion and hardcode
7045: the target for packages. The default is
1.23 wiz 7046: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 7047: facilitating a recursive update of prerequisite
7048: packages. Only set
7049: <code class="varname">DEPENDS_TARGET</code> if you want to
7050: disable recursive updates. Use
7051: <code class="varname">UPDATE_TARGET</code> instead to just
7052: set a specific target for each package to be
1.10 hubertf 7053: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 7054: (see above).</p></dd>
7055: </dl></div>
7056: </dd>
7057: <dt><span class="term">clean-update</span></dt>
7058: <dd>
7059: <p>Clean the source tree for all packages that would
1.10 hubertf 7060: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 7061: from the current directory. This target should not be
7062: used if the current package (or any of its depending
7063: packages) have already been de-installed (e.g., after
1.10 hubertf 7064: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 7065: some packages you intended to update. As a rule of
7066: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 7067: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 7068: and only if you have a dirty package tree (e.g., if you
7069: used <code class="varname">NOCLEAN</code>).</p>
7070: <p>If you are unsure about whether your tree is
1.10 hubertf 7071: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 7072: clean</strong></span> at the top of the tree, or use the
7073: following sequence of commands from the directory of the
7074: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 7075: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 7076: time, otherwise you lose all the packages you wanted to
7077: update!):</p>
7078: <pre class="screen">
7079: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7080: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7081: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7082: </pre>
7083: <p>The following variables can be used either on the
1.10 hubertf 7084: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7085: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 7086: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7087: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 7088: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 7089: reconstruct the list of directories to update for
1.10 hubertf 7090: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 7091: update</strong></span> successfully installed all
7092: packages you wanted to update. Normally, this is
1.10 hubertf 7093: done automatically on <span class="command"><strong>make
1.1 dsieger 7094: update</strong></span>, but may have been suppressed by
7095: the <code class="varname">NOCLEAN</code> variable (see
7096: above).</p></dd>
7097: </dl></div>
7098: </dd>
7099: <dt><span class="term">replace</span></dt>
7100: <dd>
7101: <p>Update the installation of the current package. This
7102: differs from update in that it does not replace dependent
1.79 snj 7103: 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 7104: target to work.</p>
7105: <p><span class="emphasis"><em>Be careful when using this
7106: target!</em></span> There are no guarantees that dependent
7107: packages will still work, in particular they will most
1.10 hubertf 7108: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 7109: library package whose shared library major version changed
7110: between your installed version and the new one. For this
7111: reason, this target is not officially supported and only
7112: recommended for advanced users.</p>
7113: </dd>
7114: <dt><span class="term">info</span></dt>
1.79 snj 7115: <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 7116: package. You can use this to check which version of a
7117: package is installed.</p></dd>
7118: <dt><span class="term">index</span></dt>
7119: <dd>
7120: <p>This is a top-level command, i.e. it should be used in
7121: the <code class="filename">pkgsrc</code> directory. It creates a
7122: database of all packages in the local pkgsrc tree, including
7123: dependencies, comment, maintainer, and some other useful
7124: information. Individual entries are created by running
1.10 hubertf 7125: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 7126: directories. This index file is saved as
7127: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 7128: verbose format by running <span class="command"><strong>make
1.1 dsieger 7129: print-index</strong></span>. You can search in it with
1.10 hubertf 7130: <span class="command"><strong>make search
1.1 dsieger 7131: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7132: extract a list of all packages that depend on a particular
1.10 hubertf 7133: one by running <span class="command"><strong>make show-deps
1.1 dsieger 7134: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7135: <p>Running this command takes a very long time, some
7136: hours even on fast machines!</p>
7137: </dd>
7138: <dt><span class="term">readme</span></dt>
7139: <dd>
7140: <p>This target generates a
7141: <code class="filename">README.html</code> file, which can be
1.79 snj 7142: 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 7143: contain references to any packages which are in the
7144: <code class="varname">PACKAGES</code> directory on the local
7145: host. The generated files can be made to refer to URLs
7146: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7147: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7148: wanted to generate <code class="filename">README.html</code>
7149: files which pointed to binary packages on the local
7150: machine, in the directory
7151: <code class="filename">/usr/packages</code>, set
7152: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7153: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7154: <code class="varname">${PACKAGES}</code> directory and its
7155: subdirectories will be searched for all the binary
7156: packages.</p>
7157: <p>The target can be run at the toplevel or in category
7158: directories, in which case it descends recursively.</p>
7159: </dd>
7160: <dt><span class="term">readme-all</span></dt>
7161: <dd><p>This is a top-level command, run it in
7162: <code class="filename">pkgsrc</code>. Use this target to create a
7163: file <code class="filename">README-all.html</code> which contains a
7164: list of all packages currently available in the NetBSD
7165: Packages Collection, together with the category they belong
7166: to and a short description. This file is compiled from the
7167: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 7168: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 7169: readme</strong></span>.</p></dd>
7170: <dt><span class="term">cdrom-readme</span></dt>
7171: <dd><p>This is very much the same as the
1.23 wiz 7172: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 7173: used when generating a pkgsrc tree to be written to a
7174: CD-ROM. This target also produces
7175: <code class="filename">README.html</code> files, and can be made
7176: to refer to URLs based on
7177: <code class="varname">CDROM_PKG_URL_HOST</code> and
7178: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7179: <dt><span class="term">show-distfiles</span></dt>
7180: <dd><p>This target shows which distfiles and patchfiles
7181: are needed to build the package
7182: (<code class="varname">ALLFILES</code>, which contains all
7183: <code class="varname">DISTFILES</code> and
7184: <code class="varname">PATCHFILES</code>, but not
7185: <code class="filename">patches/*</code>).</p></dd>
7186: <dt><span class="term">show-downlevel</span></dt>
7187: <dd><p>This target shows nothing if the package is not
7188: installed. If a version of this package is installed,
7189: but is not the version provided in this version of
7190: pkgsrc, then a warning message is displayed. This target
7191: can be used to show which of your installed packages are
7192: downlevel, and so the old versions can be deleted, and
7193: the current ones added.</p></dd>
7194: <dt><span class="term">show-pkgsrc-dir</span></dt>
7195: <dd><p>This target shows the directory in the pkgsrc
7196: hierarchy from which the package can be built and
7197: installed. This may not be the same directory as the one
7198: from which the package was installed. This target is
7199: intended to be used by people who may wish to upgrade
7200: many packages on a single host, and can be invoked from
7201: the top-level pkgsrc Makefile by using the
1.23 wiz 7202: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 7203: <dt><span class="term">show-installed-depends</span></dt>
7204: <dd><p>This target shows which installed packages match
7205: the current package's <code class="varname">DEPENDS</code>. Useful
7206: if out of date dependencies are causing build
7207: problems.</p></dd>
1.95 wiz 7208: <dt><span class="term">print-build-depends-list</span></dt>
7209: <dd><p>This target shows the list of packages that the current package
7210: depends on for building.</p></dd>
7211: <dt><span class="term">print-run-depends-list</span></dt>
7212: <dd><p>This target shows the list of packages that the current package
7213: depends on for running.</p></dd>
1.1 dsieger 7214: <dt><span class="term">check-shlibs</span></dt>
7215: <dd><p>After a package is installed, check all its
7216: binaries and (on ELF platforms) shared libraries to see
7217: if they find the shared libs they need. Run by default
1.10 hubertf 7218: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1 dsieger 7219: <dt><span class="term">print-PLIST</span></dt>
7220: <dd>
1.23 wiz 7221: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 7222: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 7223: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 7224: -newer work/.extract_done</strong></span>. An attempt is made
7225: to care for shared libs etc., but it is
7226: <span class="emphasis"><em>strongly</em></span> recommended to review the
7227: result before putting it into
7228: <code class="filename">PLIST</code>. On upgrades, it's useful to
7229: diff the output of this command against an already
7230: existing <code class="filename">PLIST</code> file.</p>
1.79 snj 7231: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 7232: other methods that don't update file access times, be
7233: sure to add these files manually to your
1.23 wiz 7234: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7235: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 7236: them!</p>
1.23 wiz 7237: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.1 dsieger 7238: information on this target.</p>
7239: </dd>
7240: <dt><span class="term">bulk-package</span></dt>
7241: <dd>
7242: <p>Used to do bulk builds. If an appropriate binary
7243: package already exists, no action is taken. If not, this
7244: target will compile, install and package it (and its
7245: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 7246: properly. See <a class="xref" href="#bulk" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 7, <i>Creating binary packages for everything in pkgsrc (bulk
7247: builds)</i></a>).
1.1 dsieger 7248: After creating the binary package, the sources, the
7249: just-installed package and its required packages are
7250: removed, preserving free disk space.</p>
7251: <p><span class="emphasis"><em>Beware that this target may deinstall
7252: all packages installed on a system!</em></span></p>
7253: </dd>
7254: <dt><span class="term">bulk-install</span></dt>
7255: <dd>
7256: <p>Used during bulk-installs to install required
7257: packages. If an up-to-date binary package is available,
1.79 snj 7258: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10 hubertf 7259: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 7260: but the installed binary won't be removed.</p>
7261: <p>A binary package is considered
1.23 wiz 7262: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.79 snj 7263: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41 asau 7264: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7265: <li class="listitem"><p>None of the package's files
1.1 dsieger 7266: (<code class="filename">Makefile</code>, ...) were modified
7267: since it was built.</p></li>
1.23 wiz 7268: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 7269: packages were modified since it was built.</p></li>
7270: </ul></div>
7271: <p><span class="emphasis"><em>Beware that this target may deinstall
7272: all packages installed on a system!</em></span></p>
7273: </dd>
7274: </dl></div>
7275: </div>
7276: </div>
1.41 asau 7277: <div class="chapter">
1.1 dsieger 7278: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7279: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7280: <div class="toc">
7281: <p><b>Table of Contents</b></p>
1.100 leot 7282: <dl class="toc">
1.6 rillig 7283: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7284: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7285: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7286: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7287: </dl>
7288: </div>
7289: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7290: by pkgsrc and also for individual packages to define what commands
7291: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7292: or for later run-time of an installed packaged (such as
7293: <code class="varname">DEPENDS</code>).
7294: If the native system provides an adequate tool, then in many cases, a pkgsrc
7295: package will not be used.</p>
7296: <p>When building a package, the replacement tools are
7297: made available in a directory (as symlinks or wrapper scripts)
7298: that is early in the executable search path. Just like the buildlink
7299: system, this helps with consistent builds.</p>
7300: <p>A tool may be needed to help build a specific package. For example,
7301: perl, GNU make (gmake) or yacc may be needed.</p>
7302: <p>Also a tool may be needed, for example, because the native system's supplied
7303: tool may be inefficient for building a package with pkgsrc.
7304: For example, a package may need GNU awk, bison (instead of
7305: yacc) or a better sed.</p>
7306: <p>The tools used by a package can be listed by running
1.10 hubertf 7307: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 7308: <div class="sect1">
1.1 dsieger 7309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7310: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7311: <p>The default set of tools used by pkgsrc is defined in
7312: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7313: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7314: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7315: These can be seen by running:
1.10 hubertf 7316: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7317: <p>If a package needs a specific program to build
7318: then the <code class="varname">USE_TOOLS</code> variable can be used
7319: to define the tools needed.</p>
7320: </div>
1.41 asau 7321: <div class="sect1">
1.1 dsieger 7322: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7323: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 7324: <p>In the following examples, the :run means that it is needed at
7325: run-time (and becomes a DEPENDS).
1.1 dsieger 7326: The default is a build dependency which can be set with
7327: :build. (So in this example, it is the same as gmake:build
7328: and pkg-config:build.)</p>
7329: <pre class="programlisting">
7330: USE_TOOLS+= gmake perl:run pkg-config
7331: </pre>
7332: <p>When using the tools framework, a
7333: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7334: which contains the full path to the appropriate tool. For example,
1.23 wiz 7335: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 7336: on Linux systems.</p>
7337: <p>If you always need a pkgsrc version of the
7338: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7339: </p>
7340: </div>
1.41 asau 7341: <div class="sect1">
1.1 dsieger 7342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7343: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7344: <p>When improving or porting pkgsrc to a new platform, have a look
7345: at (or create) the corresponding platform specific make file fragment under
7346: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7347: the name of the common tools. For example:</p>
7348: <pre class="programlisting">
7349: .if exists(/usr/bin/bzcat)
7350: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7351: .elif exists(/usr/bin/bzip2)
7352: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7353: .endif
7354:
7355: TOOLS_PLATFORM.true?= true # shell builtin
7356: </pre>
7357: </div>
1.41 asau 7358: <div class="sect1">
1.1 dsieger 7359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7360: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.41 asau 7361: <div class="qandaset">
1.104 ! sevan 7362: <a name="idp2089748084"></a><dl>
1.6 rillig 7363: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7364: </dt>
1.6 rillig 7365: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7366: tools?</a>
7367: </dt>
1.6 rillig 7368: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7369: package is using while being built? I want to know whether it
7370: uses sed or not.</a>
7371: </dt>
7372: </dl>
1.41 asau 7373: <table border="0" style="width: 100%;">
7374: <colgroup>
1.1 dsieger 7375: <col align="left" width="1%">
1.23 wiz 7376: <col>
1.41 asau 7377: </colgroup>
1.1 dsieger 7378: <tbody>
1.41 asau 7379: <tr class="question">
1.1 dsieger 7380: <td align="left" valign="top">
1.104 ! sevan 7381: <a name="tools.new"></a><a name="idp2089747748"></a><p><b>18.4.1.</b></p>
1.1 dsieger 7382: </td>
7383: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7384: </tr>
7385: <tr class="answer">
7386: <td align="left" valign="top"></td>
7387: <td align="left" valign="top"><p>TODO</p></td>
7388: </tr>
1.41 asau 7389: <tr class="question">
1.1 dsieger 7390: <td align="left" valign="top">
1.104 ! sevan 7391: <a name="tools.listall"></a><a name="idp2089747044"></a><p><b>18.4.2.</b></p>
1.1 dsieger 7392: </td>
7393: <td align="left" valign="top"><p>How do I get a list of all available
7394: tools?</p></td>
7395: </tr>
7396: <tr class="answer">
7397: <td align="left" valign="top"></td>
7398: <td align="left" valign="top"><p>TODO</p></td>
7399: </tr>
1.41 asau 7400: <tr class="question">
1.1 dsieger 7401: <td align="left" valign="top">
1.104 ! sevan 7402: <a name="tools.used"></a><a name="idp2089746324"></a><p><b>18.4.3.</b></p>
1.1 dsieger 7403: </td>
7404: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7405: package is using while being built? I want to know whether it
7406: uses sed or not.</p></td>
7407: </tr>
7408: <tr class="answer">
7409: <td align="left" valign="top"></td>
7410: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7411: to do it.)</p></td>
7412: </tr>
7413: </tbody>
7414: </table>
7415: </div>
7416: </div>
7417: </div>
1.41 asau 7418: <div class="chapter">
1.1 dsieger 7419: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7420: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7421: <div class="toc">
7422: <p><b>Table of Contents</b></p>
1.100 leot 7423: <dl class="toc">
1.6 rillig 7424: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7425: <dd><dl>
1.6 rillig 7426: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 7427: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6 rillig 7428: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7429: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7430: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7431: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7432: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7433: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7434: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7435: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7436: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7437: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7438: </dl></dd>
1.23 wiz 7439: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 7440: <dd><dl>
7441: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7442: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.88 tnn 7443: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6 rillig 7444: </dl></dd>
1.23 wiz 7445: <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 7446: <dd><dl>
7447: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7448: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7449: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7450: </dl></dd>
7451: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7452: <dd><dl>
7453: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7454: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7455: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 7456: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7457: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 7458: </dl></dd>
1.23 wiz 7459: <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 7460: <dd><dl>
7461: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7462: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 7463: <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 7464: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7465: </dl></dd>
1.23 wiz 7466: <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 7467: <dd><dl>
7468: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7469: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7470: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7471: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7472: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7473: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7474: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7475: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7476: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 7477: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 7478: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7479: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7480: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7481: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7482: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7483: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7484: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7485: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7486: emulation</a></span></dt>
1.6 rillig 7487: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7488: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7489: </dl></dd>
1.6 rillig 7490: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7491: </dl>
7492: </div>
1.41 asau 7493: <div class="sect1">
1.1 dsieger 7494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7495: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.41 asau 7496: <div class="sect2">
1.1 dsieger 7497: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7498: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7499: <p>One appealing feature of pkgsrc is that it runs on many
7500: different platforms. As a result, it is important to ensure,
7501: where possible, that packages in pkgsrc are portable. This
7502: chapter mentions some particular details you should pay
7503: attention to while working on pkgsrc.</p>
7504: </div>
1.41 asau 7505: <div class="sect2">
1.1 dsieger 7506: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 7507: <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 7508: </h3></div></div></div>
7509: <p>The pkgsrc user can configure pkgsrc by overriding several
7510: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7511: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7512: want to use those variables in the preprocessor directives of
1.79 snj 7513: <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 7514: <code class="literal">.for</code>), you need to include the file
7515: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7516: loads the user preferences.</p>
7517: <p>But note that some variables may not be completely defined
7518: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7519: included, as they may contain references to variables that are
7520: not yet defined. In shell commands this is no problem, since
7521: variables are actually macros, which are only expanded when they
7522: are used. But in the preprocessor directives mentioned above and
7523: in dependency lines (of the form <code class="literal">target:
7524: dependencies</code>) the variables are expanded at load
7525: time.</p>
1.41 asau 7526: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7527: <h3 class="title">Note</h3>
7528: <p>Currently there is no exhaustive list of all
7529: variables that tells you whether they can be used at load time
7530: or only at run time, but it is in preparation.</p>
7531: </div>
7532: </div>
1.41 asau 7533: <div class="sect2">
1.1 dsieger 7534: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7535: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7536: <p>Occasionally, packages require interaction from the user,
7537: and this can be in a number of ways:</p>
1.41 asau 7538: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7539: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7540: interaction such as entering username/password or accepting a
7541: license on a web page.</p></li>
1.23 wiz 7542: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7543: passwords.</p></li>
1.23 wiz 7544: <li class="listitem"><p>help to configure the package before it is built</p></li>
7545: <li class="listitem"><p>help during the build process</p></li>
7546: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7547: </ul></div>
7548: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7549: provided to notify the pkgsrc mechanism of an interactive stage
7550: which will be needed, and this should be set in the package's
7551: <code class="filename">Makefile</code>, e.g.:</p>
7552: <pre class="programlisting">
7553: INTERACTIVE_STAGE= build
7554: </pre>
7555: <p>Multiple interactive stages can be specified:</p>
7556: <pre class="programlisting">
7557: INTERACTIVE_STAGE= configure install
7558: </pre>
7559: <p>The user can then decide to skip this package by setting the
7560: <code class="varname">BATCH</code> variable.</p>
7561: </div>
1.41 asau 7562: <div class="sect2">
1.1 dsieger 7563: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7564: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7565: <p>Authors of software can choose the licence under which
7566: software can be copied. This is due to copyright law, and reasons
7567: for license choices are outside the scope of pkgsrc. The pkgsrc
7568: system recognizes that there are a number of licenses which some
7569: users may find objectionable or difficult or impossible to comply
7570: with. The Free Software Foundation has declared some licenses
7571: "Free", and the Open Source Initiative has a definition of "Open
7572: Source". The pkgsrc system, as a policy choice, does not label
7573: packages which have licenses that are Free or Open Source.
7574: However, packages without a license meeting either of those tests
7575: are labeled with a license tag denoting the license. Note that a
7576: package with no license to copy trivially does not meet either the
7577: Free or Open Source test.</p>
7578: <p>For packages which are not Free or Open Source, pkgsrc will
7579: not build the package unless the user has indicated to pkgsrc that
7580: packages with that particular license may be built. Note that
7581: this documentation avoids the term "accepted the license". The
7582: pkgsrc system is merely providing a mechanism to avoid
7583: accidentally building a package with a non-free license;
7584: judgement and responsibility remain with the user. (Installation
7585: of binary packages are not currently subject to this mechanism;
7586: this is a bug.)</p>
7587: <p>One might want to only install packages with a BSD license,
1.19 jnemeth 7588: or the GPL, and not the other. The free licenses are added to the
7589: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7590: user can override the default by setting the
7591: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7592: of "+=". The licenses accepted by default are:
7593: </p>
7594: <pre class="programlisting">
1.48 rodent 7595: apache-1.1 apache-2.0
7596: arphic-public
7597: artistic artistic-2.0
7598: boost-license
7599: cc-by-sa-v3.0
1.55 ryoon 7600: cc0-1.0-universal
1.48 rodent 7601: cddl-1.0
7602: cpl-1.0
7603: epl-v1.0
7604: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7605: gnu-gpl-v1
7606: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7607: gnu-gpl-v3 gnu-lgpl-v3
7608: ibm-public-license-1.0
7609: ipafont
7610: isc
7611: lppl-1.3c
7612: lucent
7613: miros
7614: mit
7615: mpl-1.0 mpl-1.1 mpl-2.0
7616: mplusfont
7617: ofl-v1.0 ofl-v1.1
7618: original-bsd modified-bsd 2-clause-bsd
7619: php
7620: png-license
7621: postgresql-license
7622: public-domain
7623: python-software-foundation
7624: qpl-v1.0
1.52 rodent 7625: sgi-free-software-b-v2.0
1.48 rodent 7626: sleepycat-public
7627: unlicense
7628: x11
7629: zlib
7630: zpl
1.19 jnemeth 7631: </pre>
7632: <p>
7633: </p>
1.1 dsieger 7634: <p>The license tag mechanism is intended to address
7635: copyright-related issues surrounding building, installing and
7636: using a package, and not to address redistribution issues (see
7637: <code class="varname">RESTRICTED</code> and
1.19 jnemeth 7638: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7639: Packages with redistribution restrictions should set these
7640: tags.</p>
1.1 dsieger 7641: <p>Denoting that a package may be copied according to a
7642: particular license is done by placing the license in
7643: <code class="filename">pkgsrc/licenses</code> and setting the
7644: <code class="varname">LICENSE</code> variable to a string identifying the
1.79 snj 7645: 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 7646: <pre class="programlisting">
7647: LICENSE= xv-license
7648: </pre>
7649: <p>When trying to build, the user will get a notice that the
7650: package is covered by a license which has not been placed in the
7651: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7652: <pre class="programlisting">
7653: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7654: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7655: ===> To view the license, enter "/usr/bin/make show-license".
7656: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7657: ===> ACCEPTABLE_LICENSES+=xv-license
7658: *** Error code 1
7659: </pre>
1.10 hubertf 7660: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7661: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7662: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7663: convey to pkgsrc that it should not in the future fail because of
7664: that license:</p>
7665: <pre class="programlisting">
7666: ACCEPTABLE_LICENSES+=xv-license
7667: </pre>
1.48 rodent 7668: <p>When adding a package with a new license, the following steps
7669: are required:</p>
7670: <div class="orderedlist"><ol class="orderedlist" type="1">
7671: <li class="listitem">
7672: <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>
7673: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7674: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7675: <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 7676: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.48 rodent 7677: </ul></div>
7678: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7679: </li>
7680: <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>
7681: </ol></div>
1.1 dsieger 7682: <p>When the license changes (in a way other than formatting),
7683: please make sure that the new license has a different name (e.g.,
7684: append the version number if it exists, or the date). Just
7685: because a user told pkgsrc to build programs under a previous
7686: version of a license does not mean that pkgsrc should build
7687: programs under the new licenses. The higher-level point is that
7688: pkgsrc does not evaluate licenses for reasonableness; the only
7689: test is a mechanistic test of whether a particular text has been
7690: approved by either of two bodies.</p>
7691: <p>The use of <code class="varname">LICENSE=shareware</code>,
7692: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7693: is deprecated because it does not crisply refer to a particular
7694: license text. Another problem with such usage is that it does not
7695: enable a user to tell pkgsrc to proceed for a single package
7696: without also telling pkgsrc to proceed for all packages with that
7697: tag.</p>
7698: </div>
1.41 asau 7699: <div class="sect2">
1.1 dsieger 7700: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7701: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7702: <p>Some licenses restrict how software may be re-distributed.
7703: Because a license tag is required unless the package is Free or
7704: Open Source, all packages with restrictions should have license
7705: tags. By declaring the restrictions, package tools can
7706: automatically refrain from e.g. placing binary packages on FTP
7707: sites.</p>
7708: <p>There are four restrictions that may be encoded, which are
7709: the cross product of sources (distfiles) and binaries not being
7710: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7711: language in any license, and because non-Free licenses tend to be
7712: different from each other, pkgsrc adopts a definition of FTP and
7713: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7714: should not be made available over the Internet at no charge.
7715: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7716: made available on some kind of media, together with other source
7717: and binary packages, and which is sold for a distribution charge.
7718: </p>
7719: <p>In order to encode these restrictions, the package system
7720: defines five make variables that can be set to note these
7721: restrictions:</p>
1.41 asau 7722: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7723: <li class="listitem">
1.1 dsieger 7724: <p><code class="varname">RESTRICTED</code></p>
7725: <p>This variable should be set whenever a restriction
7726: exists (regardless of its kind). Set this variable to a
7727: string containing the reason for the restriction. It should
7728: be understood that those wanting to understand the restriction
7729: will have to read the license, and perhaps seek advice of
7730: counsel.</p>
7731: </li>
1.23 wiz 7732: <li class="listitem">
1.1 dsieger 7733: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7734: <p>Binaries may not be placed on CD-ROM containing other
7735: binary packages, for which a distribution charge may be made.
7736: In this case, set this variable to
7737: <code class="varname">${RESTRICTED}</code>.</p>
7738: </li>
1.23 wiz 7739: <li class="listitem">
1.1 dsieger 7740: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7741: <p>Binaries may not made available on the Internet without
7742: charge. In this case, set this variable to
7743: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7744: binary packages will not be included on ftp.NetBSD.org.</p>
7745: </li>
1.23 wiz 7746: <li class="listitem">
1.1 dsieger 7747: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7748: <p>Distfiles may not be placed on CD-ROM, together with
7749: other distfiles, for which a fee may be charged. In this
7750: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7751: </p>
7752: </li>
1.23 wiz 7753: <li class="listitem">
1.1 dsieger 7754: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7755: <p>Distfiles may not made available via FTP at no charge.
7756: In this case, set this variable to
7757: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7758: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7759: </li>
7760: </ul></div>
1.32 wiz 7761: <p>Please note that packages will to be removed from pkgsrc
7762: when the distfiles are not distributable and cannot be obtained
7763: for a period of one full quarter branch. Packages with manual /
7764: interactive fetch must have a maintainer and it is his/her
7765: responsibility to ensure this.</p>
1.1 dsieger 7766: </div>
1.41 asau 7767: <div class="sect2">
1.1 dsieger 7768: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7769: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7770: <p>Your package may depend on some other package being present
7771: - and there are various ways of expressing this dependency.
7772: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7773: <code class="varname">DEPENDS</code> definitions, the
7774: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7775: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7776: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7777: 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 7778: <p>The basic difference between the two variables is as
7779: follows: The <code class="varname">DEPENDS</code> definition registers
7780: that pre-requisite in the binary package so it will be pulled in
7781: when the binary package is later installed, whilst the
7782: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7783: dependency that is only needed for building the package.</p>
7784: <p>This means that if you only need a package present whilst
7785: you are building, it should be noted as a
7786: <code class="varname">BUILD_DEPENDS</code>.</p>
7787: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7788: <code class="varname">DEPENDS</code> definition is:</p>
7789: <pre class="programlisting">
7790: <pre-req-package-name>:../../<category>/<pre-req-package>
7791: </pre>
1.23 wiz 7792: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7793: may include any of the wildcard version numbers recognized by
1.79 snj 7794: <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 7795: <div class="orderedlist"><ol class="orderedlist" type="1">
7796: <li class="listitem">
1.1 dsieger 7797: <p>If your package needs another package's binaries or
1.54 wiz 7798: libraries to build and run, and if that package has a
1.1 dsieger 7799: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7800: <pre class="programlisting">
7801: .include "../../graphics/jpeg/buildlink3.mk"
7802: </pre>
7803: </li>
1.23 wiz 7804: <li class="listitem">
1.54 wiz 7805: <p>If your package needs another package's binaries or
7806: libraries only for building, and if that package has a
7807: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7808: <pre class="programlisting">
7809: .include "../../graphics/jpeg/buildlink3.mk"
7810: </pre>
7811: <p>but set
7812: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7813: to make it a build dependency only. This case is rather
7814: rare.</p>
7815: </li>
7816: <li class="listitem">
1.25 spz 7817: <p>If your package needs binaries from another package to build,
7818: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7819: <pre class="programlisting">
1.25 spz 7820: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1 dsieger 7821: </pre>
7822: </li>
1.25 spz 7823: <li class="listitem"><p>If your package needs a library with which to link and
7824: there is no <code class="filename">buildlink3.mk</code> file
7825: available, create one. Using
7826: <code class="varname">DEPENDS</code> won't be sufficient because the
7827: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7828: <li class="listitem">
1.25 spz 7829: <p>If your package needs some executable to be able to run
7830: correctly and if there's no
7831: <code class="filename">buildlink3.mk</code> file, this is specified
7832: using the <code class="varname">DEPENDS</code> variable. The
1.79 snj 7833: <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 7834: be able to execute the latex binary from the teTeX package
7835: when it runs, and that is specified:</p>
1.1 dsieger 7836: <pre class="programlisting">
1.25 spz 7837: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.1 dsieger 7838: </pre>
1.25 spz 7839: </li>
7840: <li class="listitem">
7841: <p>You can use wildcards in package dependencies. Note that
7842: such wildcard dependencies are retained when creating binary
7843: packages. The dependency is checked when installing the binary
7844: package and any package which matches the pattern will be
7845: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7846: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7847: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7848: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7849: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7850: <p>Wildcards can also be used to specify that a package
7851: will only build against a certain minimum version of a
7852: pre-requisite:</p>
7853: <pre class="programlisting">
1.25 spz 7854: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 7855: </pre>
1.25 spz 7856: <p>This means that the package will build using version 6.0
7857: of ImageMagick or newer. Such a dependency may be warranted
7858: if, for example, the command line options of an executable
7859: have changed.</p>
7860: <p>If you need to depend on minimum versions of libraries,
7861: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7862: <p>For security fixes, please update the package
1.10 hubertf 7863: 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 7864: information.</p>
7865: </li>
7866: </ol></div>
7867: <p>If your package needs files from another package to build,
7868: add the relevant distribution files to
7869: <code class="varname">DISTFILES</code>, so they will be extracted
1.79 snj 7870: 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 7871: (It relies on the jpeg sources being present in source form
7872: during the build.)</p>
7873: </div>
1.41 asau 7874: <div class="sect2">
1.1 dsieger 7875: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7876: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7877: <p>Your package may conflict with other packages a user might
7878: already have installed on his system, e.g. if your package
7879: installs the same set of files as another package in the pkgsrc
1.80 wiz 7880: tree or has the same <code class="varname">PKGNAME</code>.</p>
7881: <p>These cases are handled automatically by the packaging tools
7882: at package installation time and do not need to be handled
7883: manually.</p>
7884: <p>In case the conflicts can not be recognized automatically
7885: (e.g., packages using the same config file location but no other
7886: shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1 dsieger 7887: space-separated list of packages (including version string) your
7888: package conflicts with.</p>
1.80 wiz 7889: <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>
7890: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
7891: use the same config file, you would set in
7892: <code class="filename">foo/bar/Makefile</code>:</p>
1.1 dsieger 7893: <pre class="programlisting">
1.80 wiz 7894: CONFLICTS= baz-[0-9]*
1.1 dsieger 7895: </pre>
1.80 wiz 7896: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1 dsieger 7897: <pre class="programlisting">
1.80 wiz 7898: CONFLICTS= bar-[0-9]*
1.1 dsieger 7899: </pre>
7900: </div>
1.41 asau 7901: <div class="sect2">
1.1 dsieger 7902: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7903: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7904: <p>There are several reasons why a package might be
7905: instructed to not build under certain circumstances. If the
7906: package builds and runs on most platforms, the exceptions
1.83 dholland 7907: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7908: the package builds and runs on a small handful of platforms,
7909: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7910: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7911: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7912: (OS-version-platform) that can use glob-style
7913: wildcards.</p>
7914: <p>If a package is not appropriate for some platforms (as
7915: oopposed to merely broken), a different set of variables should be
7916: used as this affects failure reporting and statistics.
7917: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7918: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7919: the package is appropriate for only a small handful of platforms
7920: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7921: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7922: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7923: (OS-version-platform) that can use glob-style
7924: wildcards.</p>
7925: <p>Some packages are tightly bound to a specific version of an
1.79 snj 7926: 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 7927: backwards compatible with other versions of the OS, and should be
7928: uploaded to a version specific directory on the FTP server. Mark
7929: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7930: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7931: the package system internals, but may be used in the
7932: future.</p>
7933: <p>If the package should be skipped (for example, because it
7934: provides functionality already provided by the system), set
7935: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7936: the package should fail because some preconditions are not met,
7937: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7938: message.</p>
7939: </div>
1.41 asau 7940: <div class="sect2">
1.1 dsieger 7941: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7942: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7943: <p>To ensure that a package may not be deleted, once it has been
7944: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7945: be set in the package Makefile. This will be carried into any
7946: binary package that is made from this pkgsrc entry. A
1.23 wiz 7947: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.79 snj 7948: 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 7949: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7950: </div>
1.41 asau 7951: <div class="sect2">
1.1 dsieger 7952: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7953: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7954: <p>When a vulnerability is found, this should be noted in
7955: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7956: and after committing that file, ask pkgsrc-security@NetBSD.org to
7957: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7958: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7959: <code class="varname">PKGREVISION</code> should be increased (this is of
7960: course not necessary if the problem is fixed by using a newer
7961: release of the software), and the pattern in the
7962: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7963: <p>Also, if the fix should be applied to the stable pkgsrc
7964: branch, be sure to submit a pullup request!</p>
7965: <p>Binary packages already on ftp.NetBSD.org will be handled
7966: semi-automatically by a weekly cron job.</p>
7967: </div>
1.41 asau 7968: <div class="sect2">
1.1 dsieger 7969: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7970: <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 7971: <p>When making fixes to an existing package it can be useful
7972: to change the version number in <code class="varname">PKGNAME</code>. To
7973: avoid conflicting with future versions by the original author, a
1.23 wiz 7974: <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 7975: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7976: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7977: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7978: <pre class="programlisting">
7979: DISTNAME= foo-17.42
7980: PKGREVISION= 9
7981: </pre>
7982: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7983: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7984: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7985: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7986: <code class="varname">PKGNAME_NOREV</code>.</p>
7987: <p>When a new release of the package is released, the
7988: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7989: minor release of the above package, things should be like:</p>
7990: <pre class="programlisting">
7991: DISTNAME= foo-17.43
7992: </pre>
7993: <p><code class="varname">PKGREVISION</code> should be incremented for any
7994: non-trivial change in the resulting binary package. Without a
7995: <code class="varname">PKGREVISION</code> bump, someone with the previous
7996: version installed has no way of knowing that their package is out
7997: of date. Thus, changes without increasing
7998: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7999: trivial that no reasonable person would want to upgrade", and this
8000: is the rough test for when increasing
8001: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8002: changes that do not merit increasing
8003: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 8004: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8005: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 8006: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 8007: or comments in Makefile.</p></li>
1.23 wiz 8008: <li class="listitem"><p>
1.1 dsieger 8009: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 8010: <li class="listitem"><p>
1.1 dsieger 8011: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 8012: <li class="listitem"><p>
1.1 dsieger 8013: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8014: </ul></div>
8015: <p>Examples of changes that do merit an increase to
8016: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8017: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8018: <li class="listitem"><p>
1.1 dsieger 8019: Security fixes</p></li>
1.23 wiz 8020: <li class="listitem"><p>
1.1 dsieger 8021: Changes or additions to a patch file</p></li>
1.23 wiz 8022: <li class="listitem"><p>
1.1 dsieger 8023: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 8024: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 8025: </ul></div>
8026: <p>PKGREVISION must also be incremented when dependencies have ABI
8027: changes.</p>
8028: </div>
1.41 asau 8029: <div class="sect2">
1.1 dsieger 8030: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8031: <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 8032: <p>When you want to replace the same text in multiple files
8033: or when the replacement text varies, patches alone cannot help.
8034: This is where the SUBST framework comes in. It provides an
8035: easy-to-use interface for replacing text in files.
8036: Example:</p>
8037: <pre class="programlisting">
8038: SUBST_CLASSES+= fix-paths
8039: SUBST_STAGE.fix-paths= pre-configure
8040: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8041: SUBST_FILES.fix-paths= src/*.c
8042: SUBST_FILES.fix-paths+= scripts/*.sh
8043: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8044: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8045: </pre>
8046: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8047: that are used to identify the different SUBST blocks that are
8048: defined. The SUBST framework is heavily used by pkgsrc, so it is
8049: important to always use the <code class="literal">+=</code> operator with
8050: this variable. Otherwise some substitutions may be
8051: skipped.</p>
8052: <p>The remaining variables of each SUBST block are
8053: parameterized with the identifier from the first line
8054: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8055: parameters to a function call.</p>
8056: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8057: which the replacement will take place. All combinations of
8058: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8059: <code class="literal">post-</code> together with a phase name are
8060: possible, though only few are actually used. Most commonly used
8061: are <code class="literal">post-patch</code> and
8062: <code class="literal">pre-configure</code>. Of these two,
8063: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 8064: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 8065: have the state after applying the patches but before making any
8066: other changes. This is especially useful when you are debugging
8067: a package in order to create new patches for it. Similarly,
8068: <code class="literal">post-build</code> is preferred over
8069: <code class="literal">pre-install</code>, because the install phase should
8070: generally be kept as simple as possible. When you use
8071: <code class="literal">post-build</code>, you have the same files in the
8072: working directory that will be installed later, so you can check
8073: if the substitution has succeeded.</p>
8074: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8075: that is printed just before the substitution is done.</p>
8076: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8077: globbing patterns that specifies the files in which the
8078: substitution will take place. The patterns are interpreted
8079: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8080: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.79 snj 8081: <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 8082: command should be prefixed with <code class="literal">-e</code>, so that
8083: all SUBST blocks look uniform.</p>
8084: <p>There are some more variables, but they are so seldomly
8085: used that they are only documented in the
8086: <code class="filename">mk/subst.mk</code> file.</p>
8087: </div>
8088: </div>
1.41 asau 8089: <div class="sect1">
1.1 dsieger 8090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8091: <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 8092: <div class="sect2">
1.1 dsieger 8093: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8094: <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 8095: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8096: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8097: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8098: with the name of each file to download as an argument, expecting
8099: it to output the URL of the directory from which to download
1.79 snj 8100: 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 8101: example of this usage.</p>
8102: <p>If the download can't be automated, because the user must
8103: submit personal information to apply for a password, or must pay
8104: for the source, or whatever, you can set
8105: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8106: displayed to the user before aborting the build. Example:</p>
8107: <pre class="programlisting">
8108: FETCH_MESSAGE= "Please download the files"
8109: FETCH_MESSAGE+= " "${DISTFILES:Q}
8110: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8111: </pre>
8112: </div>
1.41 asau 8113: <div class="sect2">
1.1 dsieger 8114: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8115: <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 8116: <p>Sometimes authors of a software package make some
8117: modifications after the software was released, and they put up a
8118: new distfile without changing the package's version number. If a
8119: package is already in pkgsrc at that time, the checksum will
8120: no longer match. The contents of the new distfile should be
8121: compared against the old one before changing anything, to make
8122: sure the distfile was really updated on purpose, and that
8123: no trojan horse or so crept in.
8124: Please mention that the distfiles were compared and what was found
1.53 rodent 8125: in your commit message.</p>
8126: <p>Then, the correct way to work around this is to
1.1 dsieger 8127: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8128: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8129: <code class="varname">DISTFILES</code> and
8130: <code class="varname">PATCHFILES</code> for this package will be put in that
8131: subdirectory of the local distfiles directory.
1.10 hubertf 8132: (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 8133: In case this
8134: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8135: including the <code class="filename">nbX</code> suffix) or a date stamp
1.53 rodent 8136: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8137: <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>
8138: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8139: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8140: path in the filenames.
1.53 rodent 8141: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8142: Furthermore, a mail to the package's authors seems appropriate
8143: telling them that changing distfiles after releases without
8144: changing the file names is not good practice.</p>
8145: </div>
1.88 tnn 8146: <div class="sect2">
8147: <div class="titlepage"><div><div><h3 class="title">
8148: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 8149: <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:
8150: </p>
1.88 tnn 8151: <div class="sect3">
8152: <div class="titlepage"><div><div><h4 class="title">
8153: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
8154: <p>
8155: 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.
8156: </p>
8157: <pre class="programlisting">
8158: DISTNAME= exampleproject-1.0
1.90 tnn 8159: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8160: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
8161: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8162: EXTRACT_SUFX= .zip
8163: </pre>
8164: </div>
8165: <div class="sect3">
8166: <div class="titlepage"><div><div><h4 class="title">
8167: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
8168: <p>
8169: 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.
8170: </p>
8171: <pre class="programlisting">
8172: DISTNAME= example-1.0
1.90 tnn 8173: MASTER_SITES= ${MASTER_SITE_GITHUB:example/}
8174: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
8175: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 8176: </pre>
8177: </div>
8178: <div class="sect3">
8179: <div class="titlepage"><div><div><h4 class="title">
8180: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
8181: <p>
8182: 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.
8183: </p>
8184: <pre class="programlisting">
8185: DISTNAME= offensive-1.6
1.90 tnn 8186: PKGNAME= ${DISTNAME:S/offensive/proper/}
8187: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8188: GITHUB_PROJECT= exampleproject
8189: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8190: EXTRACT_SUFX= .zip
1.88 tnn 8191: </pre>
8192: </div>
8193: </div>
1.1 dsieger 8194: </div>
1.41 asau 8195: <div class="sect1">
1.1 dsieger 8196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8197: <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 8198: <div class="sect2">
1.1 dsieger 8199: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8200: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8201: <p>pkgsrc supports many different machines, with different
8202: object formats like a.out and ELF, and varying abilities to do
8203: shared library and dynamic loading at all. To accompany this,
8204: varying commands and options have to be passed to the
8205: compiler, linker, etc. to get the Right Thing, which can be
8206: pretty annoying especially if you don't have all the machines
8207: at your hand to test things. The
1.79 snj 8208: <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 8209: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8210: both static and dynamic libraries from a set of source files,
8211: thus being platform-independent.</p>
8212: <p>Here's how to use libtool in a package in seven simple
8213: steps:</p>
1.23 wiz 8214: <div class="orderedlist"><ol class="orderedlist" type="1">
8215: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8216: Makefile.</p></li>
1.23 wiz 8217: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8218: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8219: add it to the definition of <code class="varname">CC</code>, if only
8220: libraries are being built in a given Makefile. This one command
8221: will build both PIC and non-PIC library objects, so you need not
8222: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8223: <li class="listitem">
1.1 dsieger 8224: <p>For the linking of the library, remove any
1.23 wiz 8225: <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
8226: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8227: <pre class="programlisting">
8228: ${LIBTOOL} --mode=link \
8229: ${CC} -o ${.TARGET:.a=.la} \
8230: ${OBJS:.o=.lo} \
8231: -rpath ${PREFIX}/lib \
8232: -version-info major:minor
8233: </pre>
8234: <p>Note that the library is changed to have a
8235: <code class="filename">.la</code> extension, and the objects are
8236: changed to have a <code class="filename">.lo</code>
8237: extension. Change <code class="varname">OBJS</code> as
8238: necessary. This automatically creates all of the
8239: <code class="filename">.a</code>,
8240: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8241: necessary) in the build directory. Be sure to include
1.23 wiz 8242: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8243: minor are zero, as libtool will otherwise strip off the
8244: shared library version.</p>
8245: <p>From the libtool manual:</p>
8246: <pre class="programlisting">
8247: So, libtool library versions are described by three integers:
8248:
8249: CURRENT
8250: The most recent interface number that this library implements.
8251:
8252: REVISION
8253: The implementation number of the CURRENT interface.
8254:
8255: AGE
8256: The difference between the newest and oldest interfaces that
8257: this library implements. In other words, the library implements
8258: all the interface numbers in the range from number `CURRENT -
8259: AGE' to `CURRENT'.
8260:
8261: If two libraries have identical CURRENT and AGE numbers, then the
8262: dynamic linker chooses the library with the greater REVISION number.
8263: </pre>
1.23 wiz 8264: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8265: different results for a.out and ELF (excluding symlinks)
8266: in only one case. An ELF library of the form
1.23 wiz 8267: <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 8268: will have a symlink of
1.23 wiz 8269: <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 8270: on an a.out platform. This is handled
8271: automatically.</p>
1.23 wiz 8272: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8273: directory of the library being built.</p>
8274: <p>In the <code class="filename">PLIST</code>, include only the
8275: <code class="filename">.la</code> file, the other files will be
8276: added automatically.</p>
8277: </li>
1.23 wiz 8278: <li class="listitem">
1.1 dsieger 8279: <p>When linking shared object (<code class="filename">.so</code>)
1.79 snj 8280: 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 8281: shared libraries, use <span class="quote">“<span class="quote">-module
8282: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8283: tacked on.</p>
8284: <p>The <code class="filename">PLIST</code> file gets the
8285: <code class="filename">foo.so</code> entry.</p>
8286: </li>
1.23 wiz 8287: <li class="listitem">
1.1 dsieger 8288: <p>When linking programs that depend on these libraries
8289: <span class="emphasis"><em>before</em></span> they are installed, preface
1.79 snj 8290: 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 8291: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8292: libraries (static or shared), but please be aware that
8293: libtool will not allow you to specify a relative path in
1.23 wiz 8294: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8295: expects you to change that argument to be the
8296: <code class="filename">.la</code> file. e.g.</p>
8297: <pre class="programlisting">
8298: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8299: </pre>
8300: <p>should be changed to:</p>
8301: <pre class="programlisting">
8302: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8303: </pre>
8304: <p>and it will do the right thing with the libraries.</p>
8305: </li>
1.23 wiz 8306: <li class="listitem">
1.79 snj 8307: <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>
8308: 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 8309: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8310: <code class="filename">.la</code>. e.g.</p>
8311: <pre class="programlisting">
1.22 jakllsch 8312: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 8313: </pre>
8314: <p>This will install the static <code class="filename">.a</code>,
8315: shared library, any needed symlinks, and run
1.79 snj 8316: <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 8317: </li>
1.23 wiz 8318: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8319: the <code class="filename">.la</code>
8320: file (this is a change from previous behaviour).</p></li>
8321: </ol></div>
8322: </div>
1.41 asau 8323: <div class="sect2">
1.1 dsieger 8324: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8325: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8326: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8327: package Makefile. This will override the package's own libtool
8328: in most cases. For older libtool using packages, libtool is
8329: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8330: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8331: configure; find work*/ -name libtool</strong></span>.</p>
8332: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8333: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8334: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8335: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8336: package's libtool script(s), set it as appropriate.</p>
8337: <p>If you do not need <code class="filename">*.a</code> static
8338: libraries built and installed, then use
8339: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8340: <p>If your package makes use of the platform-independent library
8341: for loading dynamic shared objects, that comes with libtool
8342: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8343: <p>Some packages use libtool incorrectly so that the package
8344: may not work or build in some circumstances. Some of the more
8345: common errors are:</p>
1.41 asau 8346: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8347: <li class="listitem">
1.1 dsieger 8348: <p>The inclusion of a shared object (-module) as a dependent library in an
8349: executable or library. This in itself isn't a problem if one of two things
8350: has been done:</p>
1.23 wiz 8351: <div class="orderedlist"><ol class="orderedlist" type="1">
8352: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8353: <code class="filename">libfoo.la</code>, not
8354: <code class="filename">foo.la</code></p></li>
1.23 wiz 8355: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8356: </ol></div>
8357: </li>
1.23 wiz 8358: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8359: The function lt_dlinit() should be called and the macro
8360: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8361: executables.</p></li>
8362: </ul></div>
8363: </div>
1.41 asau 8364: <div class="sect2">
1.1 dsieger 8365: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8366: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8367: <p>If a package needs GNU autoconf or automake to be executed
8368: to regenerate the configure script and Makefile.in makefile
8369: templates, then they should be executed in a pre-configure
8370: target.</p>
8371: <p>For packages that need only autoconf:</p>
8372: <pre class="programlisting">
8373: AUTOCONF_REQD= 2.50 # if default version is not good enough
8374: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8375: ...
8376:
8377: pre-configure:
8378: cd ${WRKSRC} && autoconf
8379:
8380: ...
8381: </pre>
8382: <p>and for packages that need automake and autoconf:</p>
8383: <pre class="programlisting">
8384: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8385: USE_TOOLS+= automake # use "automake14" for automake-1.4
8386: ...
8387:
8388: pre-configure:
8389: set -e; cd ${WRKSRC}; \
8390: aclocal; autoheader; automake -a --foreign -i; autoconf
8391:
8392: ...
8393: </pre>
8394: <p>Packages which use GNU Automake will almost certainly
8395: require GNU Make.</p>
8396: <p>There are times when the configure process makes
8397: additional changes to the generated files, which then causes
8398: the build process to try to re-execute the automake sequence.
8399: This is prevented by touching various files in the configure
8400: stage. If this causes problems with your package you can set
8401: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8402: Makefile.</p>
8403: </div>
8404: </div>
1.41 asau 8405: <div class="sect1">
1.1 dsieger 8406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8407: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 8408: <div class="sect2">
1.1 dsieger 8409: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8410: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8411: <p>Compilers for the C, C++, and Fortran languages comes with
8412: the NetBSD base system. By default, pkgsrc assumes that a package
8413: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 8414: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8415: <p>To declare which language's compiler a package needs, set
8416: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8417: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8418: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8419: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8420: written in C++, usually need a C compiler for the configure
8421: phase.</p>
8422: </div>
1.41 asau 8423: <div class="sect2">
1.1 dsieger 8424: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8425: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8426: <p>If a program is written in Java, use the Java framework in
8427: pkgsrc. The package must include
8428: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8429: provides the following variables:</p>
1.41 asau 8430: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8431: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8432: dependency on the JDK is added. If
1.23 wiz 8433: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8434: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8435: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8436: JDK.</p></li>
1.23 wiz 8437: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8438: a package needs a Java2 implementation. The supported values
1.23 wiz 8439: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8440: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8441: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8442: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8443: above. This variable is not set by default.</p></li>
1.24 wiz 8444: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8445: automatically set to the runtime location of the used Java
8446: implementation dependency. It may be used to set
8447: <code class="varname">JAVA_HOME</code> to a good value if the program
8448: needs this variable to be defined.
8449: </p></li>
1.1 dsieger 8450: </ul></div>
8451: </div>
1.41 asau 8452: <div class="sect2">
1.1 dsieger 8453: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8454: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8455: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8456: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8457: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8458: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8459: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8460: that you want adjusted. Every occurrence of
8461: <code class="filename">*/bin/perl</code> in a she-bang line will be
8462: replaced with the full path to the perl executable.</p>
1.1 dsieger 8463: <p>If a particular version of perl is needed, set the
8464: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8465: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 8466: <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 8467: about handling perl modules.</p>
8468: </div>
1.41 asau 8469: <div class="sect2">
1.1 dsieger 8470: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 8471: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8472: <p><code class="varname">REPLACE_SH</code>,
8473: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8474: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8475: hash bangs in files. Please use the appropriate one, prefering
8476: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 8477: Each should contain a list of scripts, relative to
8478: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8479: occurrence of the matching shell in a she-bang line will be
8480: replaced with the full path to the shell executable.
1.40 wiz 8481: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8482: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8483: </div>
1.41 asau 8484: <div class="sect2">
1.40 wiz 8485: <div class="titlepage"><div><div><h3 class="title">
8486: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8487: <p>Currently, there is no special handling for other languages
8488: in pkgsrc. If a compiler package provides a
8489: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8490: just add a (build) dependency on the appropriate compiler
8491: package.</p>
8492: </div>
8493: </div>
1.41 asau 8494: <div class="sect1">
1.1 dsieger 8495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8496: <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 8497: <p>The most common failures when building a package are that
8498: some platforms do not provide certain header files, functions or
8499: libraries, or they provide the functions in a library that the
8500: original package author didn't know. To work around this, you
8501: can rewrite the source code in most cases so that it does not
8502: use the missing functions or provides a replacement function.</p>
1.41 asau 8503: <div class="sect2">
1.1 dsieger 8504: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8505: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8506: <p>If a package already comes with a GNU configure script, the
8507: preferred way to fix the build failure is to change the
8508: configure script, not the code. In the other cases, you can
8509: utilize the C preprocessor, which defines certain macros
8510: depending on the operating system and hardware architecture it
8511: compiles for. These macros can be queried using for example
8512: <code class="varname">#if defined(__i386)</code>. Almost every operating
8513: system, hardware architecture and compiler has its own macro.
8514: For example, if the macros <code class="varname">__GNUC__</code>,
8515: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8516: are all defined, you know that you are using NetBSD on an i386
8517: compatible CPU, and your compiler is GCC.</p>
8518: <p>The list of the following macros for hardware and
8519: operating system depends on the compiler that is used. For
8520: example, if you want to conditionally compile code on Solaris,
8521: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8522: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8523: <div class="sect3">
1.1 dsieger 8524: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8525: <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 8526: <p>To distinguish between 4.4 BSD-derived systems and the
8527: rest of the world, you should use the following code.</p>
8528: <pre class="programlisting">
8529: #include <sys/param.h>
8530: #if (defined(BSD) && BSD >= 199306)
8531: /* BSD-specific code goes here */
8532: #else
8533: /* non-BSD-specific code goes here */
8534: #endif
8535: </pre>
8536: <p>If this distinction is not fine enough, you can also test
8537: for the following macros.</p>
8538: <pre class="programlisting">
1.45 obache 8539: Cygwin __CYGWIN__
8540: DragonFly __DragonFly__
1.1 dsieger 8541: FreeBSD __FreeBSD__
1.45 obache 8542: Haiku __HAIKU__
1.1 dsieger 8543: Interix __INTERIX
8544: IRIX __sgi (TODO: get a definite source for this)
8545: Linux linux, __linux, __linux__
1.83 dholland 8546: Mac OS X __APPLE__
1.45 obache 8547: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8548: Minix3 __minix
1.1 dsieger 8549: NetBSD __NetBSD__
8550: OpenBSD __OpenBSD__
8551: Solaris sun, __sun
8552: </pre>
8553: </div>
1.41 asau 8554: <div class="sect3">
1.1 dsieger 8555: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8556: <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 8557: <pre class="programlisting">
8558: i386 i386, __i386, __i386__
8559: MIPS __mips
8560: SPARC sparc, __sparc
8561: </pre>
8562: </div>
1.41 asau 8563: <div class="sect3">
1.1 dsieger 8564: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8565: <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 8566: <pre class="programlisting">
8567: GCC __GNUC__ (major version), __GNUC_MINOR__
8568: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8569: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8570: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8571: </pre>
8572: </div>
8573: </div>
1.41 asau 8574: <div class="sect2">
1.1 dsieger 8575: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8576: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8577: <p>Some source files trigger bugs in the compiler, based on
8578: combinations of compiler version and architecture and almost
8579: always relation to optimisation being enabled. Common symptoms
8580: are gcc internal errors or never finishing compiling a
8581: file.</p>
8582: <p>Typically, a workaround involves testing the
8583: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8584: optimisation for that combination of file,
1.87 tnn 8585: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8586: <p>This used to be a big problem in the past, but is rarely
8587: needed now as compiler technology has matured. If you still need
8588: to add a compiler specific workaround, please do so in the file
8589: <code class="filename">hacks.mk</code> and describe the symptom and
8590: compiler version as detailed as possible.</p>
1.1 dsieger 8591: </div>
1.41 asau 8592: <div class="sect2">
1.1 dsieger 8593: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 8594: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8595: </h3></div></div></div>
1.1 dsieger 8596: <p>This error message often means that a package did not
8597: link to a shared library it needs. The following functions are
8598: known to cause this error message over and over.</p>
8599: <div class="informaltable">
8600: <a name="undefined-reference-functions"></a><table border="1">
8601: <colgroup>
8602: <col>
8603: <col>
8604: <col>
8605: </colgroup>
8606: <thead><tr>
8607: <th>Function</th>
8608: <th>Library</th>
8609: <th>Affected platforms</th>
8610: </tr></thead>
8611: <tbody>
8612: <tr>
8613: <td>accept, bind, connect</td>
8614: <td>-lsocket</td>
8615: <td>Solaris</td>
8616: </tr>
8617: <tr>
8618: <td>crypt</td>
8619: <td>-lcrypt</td>
8620: <td>DragonFly, NetBSD</td>
8621: </tr>
8622: <tr>
8623: <td>dlopen, dlsym</td>
8624: <td>-ldl</td>
8625: <td>Linux</td>
8626: </tr>
8627: <tr>
8628: <td>gethost*</td>
8629: <td>-lnsl</td>
8630: <td>Solaris</td>
8631: </tr>
8632: <tr>
8633: <td>inet_aton</td>
8634: <td>-lresolv</td>
8635: <td>Solaris</td>
8636: </tr>
8637: <tr>
8638: <td>nanosleep, sem_*, timer_*</td>
8639: <td>-lrt</td>
8640: <td>Solaris</td>
8641: </tr>
8642: <tr>
8643: <td>openpty</td>
8644: <td>-lutil</td>
8645: <td>Linux</td>
8646: </tr>
8647: </tbody>
8648: </table>
8649: </div>
8650: <p>To fix these linker errors, it is often sufficient to say
8651: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8652: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8653: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8654: bmake</strong></span>.</p>
1.41 asau 8655: <div class="sect3">
1.1 dsieger 8656: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8657: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8658: <p>When you are using the SunPro compiler, there is another
8659: possibility. That compiler cannot handle the following code:</p>
8660: <pre class="programlisting">
8661: extern int extern_func(int);
8662:
8663: static inline int
8664: inline_func(int x)
8665: {
8666: return extern_func(x);
8667: }
8668:
8669: int main(void)
8670: {
8671: return 0;
8672: }
8673: </pre>
8674: <p>It generates the code for <code class="function">inline_func</code> even if
8675: that function is never used. This code then refers to
8676: <code class="function">extern_func</code>, which can usually not be resolved. To
8677: solve this problem you can try to tell the package to disable inlining
8678: of functions.</p>
8679: </div>
8680: </div>
1.41 asau 8681: <div class="sect2">
1.1 dsieger 8682: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8683: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8684: <p>Sometimes packages fail to build because the compiler runs
8685: into an operating system specific soft limit. With the
8686: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8687: to unlimit the resources. Currently, the allowed values are any combination of
8688: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8689: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8690: Setting this variable is similar to running the shell builtin
1.10 hubertf 8691: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8692: segment size or maximum stack size of a process, respectively, to
8693: their hard limits.</p>
8694: </div>
8695: </div>
1.41 asau 8696: <div class="sect1">
1.1 dsieger 8697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8698: <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 8699: <div class="sect2">
1.1 dsieger 8700: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8701: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8702: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8703: with some operating systems cannot create more than one
8704: directory at a time. As such, you should call
8705: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8706: <pre class="programlisting">
8707: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8708: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8709: </pre>
1.23 wiz 8710: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8711: dir2</code></span>”</span> to the
1.1 dsieger 8712: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8713: automatically do the right thing.</p>
8714: </div>
1.41 asau 8715: <div class="sect2">
1.1 dsieger 8716: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8717: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8718: <p>In general, documentation should be installed into
8719: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8720: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8721: includes the version number of the package).</p>
8722: <p>Many modern packages using GNU autoconf allow to set the
8723: directory where HTML documentation is installed with the
1.23 wiz 8724: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8725: is needed because otherwise the documentation ends up in
8726: <code class="filename">${PREFIX}/share/doc/html</code> or other
8727: places.</p>
8728: <p>An exception to the above is that library API documentation
1.79 snj 8729: 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 8730: browsers (devhelp) should be left at their default location, which
8731: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8732: documentation can be recognized from files ending in
8733: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8734: (It is also acceptable to install such files in
8735: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8736: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8737: <code class="filename">.devhelp*</code> file must be directly in that
8738: directory then, no additional subdirectory level is allowed in
8739: this case. This is usually achieved by using
1.23 wiz 8740: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8741: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8742: though.)</p>
8743: </div>
1.41 asau 8744: <div class="sect2">
1.1 dsieger 8745: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8746: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8747: <p>Certain packages, most of them in the games category, install
8748: a score file that allows all users on the system to record their
8749: highscores. In order for this to work, the binaries need to be
8750: installed setgid and the score files owned by the appropriate
1.35 wiz 8751: group and/or owner (traditionally the "games" user/group). Set
8752: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8753: following variables, documented in more detail in
8754: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8755: behaviour: <code class="varname">GAMEDATAMODE</code>,
8756: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8757: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8758: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8759: <code class="varname">GAMEDATA_PERMS</code> and
8760: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8761: <p>An example that illustrates some of the variables described above is
8762: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8763: used to properly set directory permissions of the directory where the
8764: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8765: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8766: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8767: binary:</p>
8768: <pre class="programlisting">
8769: USE_GAMESGROUP= yes
8770:
8771: BUILD_DEFS+= VARBASE
8772:
8773: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8774: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8775: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
8776: </pre>
8777: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8778: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8779: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8780: needed to be accessed by setgid games and
8781: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8782: <p>A package should therefore never hard code file ownership or
1.100 leot 8783: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8784: or alternatively on <code class="varname">INSTALL_GAME</code>,
8785: <code class="varname">INSTALL_GAME_DATA</code> and
8786: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8787: </div>
1.41 asau 8788: <div class="sect2">
1.1 dsieger 8789: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8790: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8791: <p><code class="varname">DESTDIR</code> support means that a package
8792: installs into a staging directory, not the final location of the
8793: files. Then a binary package is created which can be used for
8794: installation as usual. There are two ways: Either the package must
1.23 wiz 8795: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8796: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8797: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8798: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 8799: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8800: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8801: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8802: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8803: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8804: the inclusion.</p></li>
1.23 wiz 8805: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8806: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8807: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8808: automatically. Many manual rules and pre/post-install often are
8809: incorrect; fix them.</p></li>
1.23 wiz 8810: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8811: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8812: <li class="listitem"><p>In general, packages should support
1.4 rillig 8813: <code class="varname">UNPRIVILEGED</code> to be able to use
8814: DESTDIR.</p></li>
8815: </ul></div>
8816: </div>
1.41 asau 8817: <div class="sect2">
1.4 rillig 8818: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8819: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8820: <p>Your package may also contain scripts with hardcoded paths to
8821: other interpreters besides (or as well as) perl. To correct the
8822: full pathname to the script interpreter, you need to set the
8823: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8824: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8825: <pre class="programlisting">
8826: REPLACE_INTERPRETER+= tcl
8827: REPLACE.tcl.old= .*/bin/tclsh
8828: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8829: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8830: # relative to ${WRKSRC}, just as in REPLACE_PERL
8831: </pre>
1.41 asau 8832: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8833: <h3 class="title">Note</h3>
8834: <p>Before March 2006, these variables were called
8835: <code class="varname">_REPLACE.*</code> and
8836: <code class="varname">_REPLACE_FILES.*</code>.</p>
8837: </div>
8838: </div>
1.41 asau 8839: <div class="sect2">
1.1 dsieger 8840: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8841: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8842: <p>Makefiles of packages providing perl5 modules should include
8843: the Makefile fragment
8844: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8845: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8846: configuration for such modules as well as various hooks to tune
8847: this configuration. See comments in this file for
8848: details.</p>
8849: <p>Perl5 modules will install into different places depending
8850: on the version of perl used during the build process. To
8851: address this, pkgsrc will append lines to the
8852: <code class="filename">PLIST</code> corresponding to the files listed in
8853: the installed <code class="filename">.packlist</code> file generated by
8854: most perl5 modules. This is invoked by defining
8855: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8856: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8857: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8858: e.g.:</p>
1.1 dsieger 8859: <pre class="programlisting">
1.47 wiz 8860: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 8861: </pre>
1.47 wiz 8862: <p>The perl5 config variables
8863: <code class="varname">installarchlib</code>,
8864: <code class="varname">installscript</code>,
8865: <code class="varname">installvendorbin</code>,
8866: <code class="varname">installvendorscript</code>,
8867: <code class="varname">installvendorarch</code>,
8868: <code class="varname">installvendorlib</code>,
8869: <code class="varname">installvendorman1dir</code>, and
8870: <code class="varname">installvendorman3dir</code> represent those
8871: locations in which components of perl5 modules may be installed,
8872: provided as variable with uppercase and prefixed with
8873: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8874: and may be used by perl5 packages that don't have a packlist.
8875: These variables are also substituted for in the
8876: <code class="filename">PLIST</code> as uppercase prefixed with
8877: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8878: </div>
1.41 asau 8879: <div class="sect2">
1.1 dsieger 8880: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8881: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8882: <p>Some packages install info files or use the
1.23 wiz 8883: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8884: commands. <code class="varname">INFO_FILES</code> should be defined in
8885: the package Makefile so that <code class="filename">INSTALL</code> and
8886: <code class="filename">DEINSTALL</code> scripts will be generated to
8887: handle registration of the info files in the Info directory
1.23 wiz 8888: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8889: files registration is either provided by the system, or by a
8890: special purpose package automatically added as dependency if
8891: needed.</p>
8892: <p><code class="varname">PKGINFODIR</code> is the directory under
8893: <code class="filename">${PREFIX}</code> where info files are primarily
8894: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8895: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8896: <p>The info files for the package should be listed in the
8897: package <code class="filename">PLIST</code>; however any split info files
8898: need not be listed.</p>
1.23 wiz 8899: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8900: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8901: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8902: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8903: should be noted with the <code class="varname">TEXINFO_REQD</code>
8904: variable in the package <code class="filename">Makefile</code>. By
8905: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8906: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8907: does not match the required minimum, a build dependency on the
1.79 snj 8908: <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 8909: be added automatically.</p>
8910: <p>The build and installation process of the software provided
8911: by the package should not use the
1.10 hubertf 8912: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8913: info files is the task of the package
8914: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8915: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8916: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8917: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8918: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8919: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8920: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8921: no effect except the logging of a message. The script overriding
1.10 hubertf 8922: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8923: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8924: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8925: </div>
1.41 asau 8926: <div class="sect2">
1.1 dsieger 8927: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8928: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8929: <p>All packages that install manual pages should install them
8930: into the same directory, so that there is one common place to look
8931: for them. In pkgsrc, this place is
8932: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8933: should be used in packages. The default for
8934: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8935: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8936: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8937: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8938: <h3 class="title">Note</h3>
8939: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8940: is far from complete.</p>
8941: </div>
8942: <p>The <code class="filename">PLIST</code> files can just use
8943: <code class="filename">man/</code> as the top level directory for the man
8944: page file entries, and the pkgsrc framework will convert as
8945: needed. In all other places, the correct
8946: <code class="varname">PKGMANDIR</code> must be used.</p>
8947: <p>Packages that are
8948: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8949: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8950: <code class="filename">./configure</code>
8951: --mandir switch to set where the man pages should be installed.
8952: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8953: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8954: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8955: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8956: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8957: Or if the <code class="filename">./configure</code> script uses
8958: a non-standard use of --mandir, you can set
8959: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8960: <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 8961: information on installation of compressed manual pages.</p>
8962: </div>
1.41 asau 8963: <div class="sect2">
1.1 dsieger 8964: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8965: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8966: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8967: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8968: you need to take some extra steps to make sure they get registered
8969: in the database:</p>
1.23 wiz 8970: <div class="orderedlist"><ol class="orderedlist" type="1">
8971: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8972: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8973: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8974: deinstallation time, and tells the package where to install
1.7 rillig 8975: GConf data files using some standard configure arguments. It
1.1 dsieger 8976: also disallows any access to the database directly from the
8977: package.</p></li>
1.23 wiz 8978: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8979: <code class="filename">.schemas</code> files under
8980: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8981: installed under <code class="filename">${PREFIX}/etc</code>, you will
8982: need to manually patch the package.</p></li>
1.23 wiz 8983: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8984: directory, as they will be handled automatically. See
1.84 wiz 8985: <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 8986: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8987: your <code class="filename">Makefile</code> with a list of all
8988: <code class="filename">.schemas</code> files installed by the package, if
8989: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8990: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8991: your <code class="filename">Makefile</code> with a
8992: list of all <code class="filename">.entries</code> files installed by the
8993: package, if any. Names must not contain any directories in
8994: them.</p></li>
8995: </ol></div>
8996: </div>
1.41 asau 8997: <div class="sect2">
1.1 dsieger 8998: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8999: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 9000: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 9001: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 9002: get registered in the database:</p>
1.23 wiz 9003: <div class="orderedlist"><ol class="orderedlist" type="1">
9004: <li class="listitem"><p>Include
1.18 snj 9005: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9006: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 9007: takes care of rebuilding the scrollkeeper database at
9008: installation and deinstallation time, and disallows any access
9009: to it directly from the package.</p></li>
1.23 wiz 9010: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9011: <code class="filename">libdata/scrollkeeper</code> directory, as they
9012: will be handled automatically.</p></li>
1.23 wiz 9013: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 9014: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9015: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 9016: </ol></div>
9017: </div>
1.41 asau 9018: <div class="sect2">
1.1 dsieger 9019: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9020: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9021: <p>If a package installs font files, you will need to rebuild
9022: the fonts database in the directory where they get installed at
9023: installation and deinstallation time. This can be automatically
9024: done by using the pkginstall framework.</p>
9025: <p>You can list the directories where fonts are installed in the
9026: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9027: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9028: <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 9029: Also make sure that the database file
9030: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9031: <p>Note that you should not create new directories for fonts;
9032: instead use the standard ones to avoid that the user needs to
9033: manually configure his X server to find them.</p>
9034: </div>
1.41 asau 9035: <div class="sect2">
1.1 dsieger 9036: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9037: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 9038: <p>If a package installs GTK2 immodules or loaders, you need to
9039: take some extra steps to get them registered in the GTK2 database
9040: properly:</p>
1.23 wiz 9041: <div class="orderedlist"><ol class="orderedlist" type="1">
9042: <li class="listitem"><p>Include
1.1 dsieger 9043: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9044: <code class="filename">buildlink3.mk</code> file. This takes care of
9045: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 9046: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 9047: your package installs GTK2 immodules.</p></li>
1.23 wiz 9048: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 9049: GTK2 loaders.</p></li>
1.23 wiz 9050: <li class="listitem">
1.1 dsieger 9051: <p>Patch the package to not touch any of the GTK2
9052: databases directly. These are:</p>
1.41 asau 9053: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9054: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9055: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 9056: </ul></div>
9057: </li>
1.23 wiz 9058: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 9059: any entries under the <code class="filename">libdata/gtk-2.0</code>
9060: directory, as they will be handled automatically.</p></li>
9061: </ol></div>
9062: </div>
1.41 asau 9063: <div class="sect2">
1.1 dsieger 9064: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9065: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9066: <p>If a package installs SGML or XML data files that need to be
9067: registered in system-wide catalogs (like DTDs, sub-catalogs,
9068: etc.), you need to take some extra steps:</p>
1.23 wiz 9069: <div class="orderedlist"><ol class="orderedlist" type="1">
9070: <li class="listitem"><p>Include
1.1 dsieger 9071: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9072: your <code class="filename">Makefile</code>, which takes care of
9073: registering those files in system-wide catalogs at
9074: installation and deinstallation time.</p></li>
1.23 wiz 9075: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9076: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9077: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9078: any XML catalogs installed by the package.</p></li>
1.23 wiz 9079: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9080: to be added to the SGML catalog. These come in groups of
9081: three strings; see xmlcatmgr(1) for more information
9082: (specifically, arguments recognized by the 'add' action).
9083: Note that you will normally not use this variable.</p></li>
1.23 wiz 9084: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9085: to be added to the XML catalog. These come in groups of three
9086: strings; see xmlcatmgr(1) for more information (specifically,
9087: arguments recognized by the 'add' action). Note that you will
9088: normally not use this variable.</p></li>
9089: </ol></div>
9090: </div>
1.41 asau 9091: <div class="sect2">
1.1 dsieger 9092: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9093: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9094: <p>If a package provides extensions to the MIME database by
9095: installing <code class="filename">.xml</code> files inside
9096: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9097: need to take some extra steps to ensure that the database is kept
9098: consistent with respect to these new files:</p>
1.23 wiz 9099: <div class="orderedlist"><ol class="orderedlist" type="1">
9100: <li class="listitem"><p>Include
1.1 dsieger 9101: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9102: (avoid using the <code class="filename">buildlink3.mk</code> file from
9103: this same directory, which is reserved for inclusion from
9104: other <code class="filename">buildlink3.mk</code> files). It takes
9105: care of rebuilding the MIME database at installation and
9106: deinstallation time, and disallows any access to it directly
9107: from the package.</p></li>
1.23 wiz 9108: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9109: <code class="filename">share/mime</code> directory,
9110: <span class="emphasis"><em>except</em></span> for files saved under
9111: <code class="filename">share/mime/packages</code>. The former are
9112: handled automatically by
9113: the update-mime-database program, but the latter are
9114: package-dependent and must be removed by the package that
9115: installed them in the first place.</p></li>
1.23 wiz 9116: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9117: from the PLIST. They will be handled by the shared-mime-info
9118: package.</p></li>
9119: </ol></div>
9120: </div>
1.41 asau 9121: <div class="sect2">
1.1 dsieger 9122: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9123: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9124: <p>If a package uses intltool during its build, add
9125: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9126: which forces it to use the intltool package provided by pkgsrc,
9127: instead of the one bundled with the distribution file.</p>
9128: <p>This tracks intltool's build-time dependencies and uses the
9129: latest available version; this way, the package benefits of any
9130: bug fixes that may have appeared since it was released.</p>
9131: </div>
1.41 asau 9132: <div class="sect2">
1.1 dsieger 9133: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9134: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9135: <p>If a package contains a rc.d script, it won't be copied into
9136: the startup directory by default, but you can enable it, by adding
9137: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9138: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9139: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9140: it will automatically remove the scripts when the package is
9141: deinstalled.</p>
9142: </div>
1.41 asau 9143: <div class="sect2">
1.1 dsieger 9144: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9145: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9146: <p>If a package installs TeX packages into the texmf tree,
9147: the <code class="filename">ls-R</code> database of the tree needs to be
9148: updated.</p>
1.41 asau 9149: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9150: <h3 class="title">Note</h3>
1.22 jakllsch 9151: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9152: packages should install files
1.22 jakllsch 9153: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9154: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9155: </div>
1.23 wiz 9156: <div class="orderedlist"><ol class="orderedlist" type="1">
9157: <li class="listitem"><p>Include
1.22 jakllsch 9158: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9159: takes care of rebuilding the <code class="filename">ls-R</code>
9160: database at installation and deinstallation time.</p></li>
1.23 wiz 9161: <li class="listitem">
1.1 dsieger 9162: <p>If your package installs files into a texmf
9163: tree other than the one
1.22 jakllsch 9164: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9165: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9166: trees that need database update.</p>
9167: <p>If your package also installs font map files that need
1.10 hubertf 9168: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9169: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9170: set <code class="varname">TEX_MAP_FILES</code> and/or
9171: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9172: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9173: be run automatically at installation/deinstallation to
9174: enable/disable font map files for TeX output
9175: drivers.</p>
9176: </li>
1.23 wiz 9177: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9178: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9179: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9180: </ol></div>
9181: </div>
1.41 asau 9182: <div class="sect2">
1.1 dsieger 9183: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9184: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9185: emulation</h3></div></div></div>
9186: <p>There are some packages that provide libraries and
9187: executables for running binaries from a one operating system
9188: on a different one (if the latter supports it). One example
9189: is running Linux binaries on NetBSD.</p>
1.79 snj 9190: <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 9191: helps in extracting and packaging Linux rpm packages.</p>
9192: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9193: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9194: if all libraries for each installed executable can be found by
9195: the dynamic linker. Since the standard dynamic linker is run,
9196: this fails for emulation packages, because the libraries used
9197: by the emulation are not in the standard directories.</p>
9198: </div>
1.41 asau 9199: <div class="sect2">
1.1 dsieger 9200: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9201: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9202: <p>If a package installs images under the
9203: <code class="filename">share/icons/hicolor</code> and/or updates the
9204: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9205: database, you need to take some extra steps to make sure that the
9206: shared theme directory is handled appropriately and that the cache
9207: database is rebuilt:</p>
1.23 wiz 9208: <div class="orderedlist"><ol class="orderedlist" type="1">
9209: <li class="listitem"><p>Include
1.1 dsieger 9210: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 9211: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 9212: entry that refers to the theme cache.</p></li>
1.23 wiz 9213: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 9214: directories from the <code class="filename">share/icons/hicolor</code>
9215: hierarchy because they will be handled automatically.</p></li>
9216: </ol></div>
9217: <p>The best way to verify that the PLIST is correct with
9218: respect to the last two points is to regenerate it using
1.10 hubertf 9219: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9220: </div>
1.41 asau 9221: <div class="sect2">
1.1 dsieger 9222: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9223: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9224: <p>If a package installs <code class="filename">.desktop</code> files
9225: under <code class="filename">share/applications</code> and these include
1.53 rodent 9226: MIME information (MimeType key), you need to take extra steps to
9227: ensure that they are registered into the MIME database:</p>
1.23 wiz 9228: <div class="orderedlist"><ol class="orderedlist" type="1">
9229: <li class="listitem"><p>Include
1.1 dsieger 9230: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 9231: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 9232: <code class="filename">share/applications/mimeinfo.cache</code> file.
9233: It will be handled automatically.</p></li>
9234: </ol></div>
9235: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9236: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9237: print-PLIST</strong></span>.</p>
9238: </div>
9239: </div>
1.41 asau 9240: <div class="sect1">
1.1 dsieger 9241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9242: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9243: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 9244: immediately. In this case, one can plainly mark a package as broken. For
9245: this, one just sets the variable <code class="varname">BROKEN</code> to the
9246: reason why the package is broken (similar to the
9247: <code class="varname">RESTRICTED</code> variable). A user trying to build
9248: the package will immediately be shown this message, and the build
9249: will not be even tried.</p>
9250: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 9251: intervals.</p>
9252: </div>
9253: </div>
1.41 asau 9254: <div class="chapter">
1.1 dsieger 9255: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9256: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9257: <p>To check out all the gotchas when building a package, here are
9258: the steps that I do in order to get a package working. Please note
9259: this is basically the same as what was explained in the previous
9260: sections, only with some debugging aids.</p>
1.41 asau 9261: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9262: <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>
9263: <li class="listitem">
1.79 snj 9264: <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 9265: create a directory for a new package, change into it, then run
1.10 hubertf 9266: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9267: <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>
9268: <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>
9269: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9270: </li>
1.23 wiz 9271: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9272: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9273: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9274: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 9275: configure step to the package's
9276: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 9277: <li class="listitem">
1.1 dsieger 9278: <p>Make the package compile, doing multiple rounds of</p>
9279: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9280: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9281: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9282: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9283: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9284: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9285: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9286: <p>Doing this step as non-root user will ensure that no files
9287: are modified that shouldn't be, especially during the build
1.10 hubertf 9288: phase. <span class="command"><strong>mkpatches</strong></span>,
9289: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.79 snj 9290: 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 9291: package.</p>
9292: </li>
1.23 wiz 9293: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9294: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9295: <li class="listitem">
1.1 dsieger 9296: <p>Generate a <code class="filename">PLIST</code>:</p>
9297: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9298: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9299: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9300: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9301: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9302: <p>You usually need to be <code class="username">root</code> to do
9303: this. Look if there are any files left:</p>
9304: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9305: <p>If this reveals any files that are missing in
9306: <code class="filename">PLIST</code>, add them.</p>
9307: </li>
1.23 wiz 9308: <li class="listitem">
1.1 dsieger 9309: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9310: package again and make a binary package:</p>
9311: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9312: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9313: </li>
1.23 wiz 9314: <li class="listitem">
1.1 dsieger 9315: <p>Delete the installed package:</p>
9316: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9317: </li>
1.23 wiz 9318: <li class="listitem">
1.10 hubertf 9319: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9320: command, which shouldn't find anything now:</p>
9321: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9322: </li>
1.23 wiz 9323: <li class="listitem">
1.1 dsieger 9324: <p>Reinstall the binary package:</p>
9325: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9326: </li>
1.23 wiz 9327: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9328: <li class="listitem">
1.79 snj 9329: <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 9330: reports:</p>
9331: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9332: </li>
1.23 wiz 9333: <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 9334: </ul></div>
9335: </div>
1.41 asau 9336: <div class="chapter">
1.1 dsieger 9337: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9338: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9339: <div class="toc">
9340: <p><b>Table of Contents</b></p>
1.100 leot 9341: <dl class="toc">
1.6 rillig 9342: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9343: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9344: <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 9345: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 9346: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 9347: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9348: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9349: </dl>
9350: </div>
1.41 asau 9351: <div class="sect1">
1.1 dsieger 9352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9353: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9354: <p>Our policy is that we accept binaries only from pkgsrc
9355: developers to guarantee that the packages don't contain any
9356: trojan horses etc. This is not to annoy anyone but rather to
9357: protect our users! You're still free to put up your home-made
9358: binary packages and tell the world where to get them. NetBSD
9359: developers doing bulk builds and wanting to upload them please
1.66 asau 9360: 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
9361: builds)</i></a>.</p>
1.1 dsieger 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-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9366: <p>First, check that your package is complete, compiles and
1.10 hubertf 9367: 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 9368: 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 9369: archive that contains all files that make up the package.
9370: Finally, send this package to the pkgsrc bug tracking system,
1.79 snj 9371: 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 9372: that, go to the web page
1.10 hubertf 9373: <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 9374: which contains some instructions and a link to a form where you
9375: can submit packages. The
1.79 snj 9376: <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 9377: also available as a substitute for either of the above two tools.
9378: </p>
1.1 dsieger 9379: <p>In the form of the problem report, the category should be
1.23 wiz 9380: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9381: and version number, and the description field should contain a
9382: short description of your package (contents of the COMMENT
9383: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9384: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9385: <p>If you want to submit several packages, please send a
9386: separate PR for each one, it's easier for us to track things
9387: that way.</p>
9388: <p>Alternatively, you can also import new packages into
1.23 wiz 9389: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.10 hubertf 9390: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1 dsieger 9391: for details.</p>
9392: </div>
1.41 asau 9393: <div class="sect1">
1.1 dsieger 9394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9395: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9396: <p>Please note all package additions, updates, moves, and
9397: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9398: important to keep this file up to date and conforming to the
9399: existing format, because it will be used by scripts to
1.10 hubertf 9400: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9401: sites. Additionally, check the
9402: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9403: for the package you updated or removed, in case it was mentioned
9404: there.</p>
9405: <p>When the <code class="varname">PKGREVISION</code> of a package is
9406: bumped, the change should appear in
9407: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9408: related or otherwise relevant. Mass bumps that result from a
9409: dependency being updated should not be mentioned. In all other
9410: cases it's the developer's decision.</p>
9411: <p>There is a make target that helps in creating proper
1.10 hubertf 9412: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9413: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9414: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9415: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9416: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9417: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9418: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9419: For new packages, or package moves or removals, set the
9420: <code class="varname">CTYPE</code> variable on the command line to "Added",
9421: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9422: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9423: not the same as your NetBSD login name. The target also automatically
9424: removes possibly existing entries for the package in the
9425: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9426: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9427: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9428: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9429: makes the cvs commands use the main repository.
9430: </p>
1.1 dsieger 9431: </div>
1.41 asau 9432: <div class="sect1">
1.1 dsieger 9433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 9434: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9435: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9436: access to the pkgsrc repository.</p>
9437: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9438: Start by adding the directory and then files in the directory. Don't
9439: forget to add the new package to the category's
9440: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9441: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9442: <pre class="programlisting">
9443: <code class="prompt">$</code> cd .../pkgsrc/category
9444: <code class="prompt">$</code> cvs add pkgname
9445: <code class="prompt">$</code> cd pkgname
9446: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9447: <code class="prompt">$</code> cvs add patches/p*
9448: <code class="prompt">$</code> cvs status | less
1.34 wiz 9449: <code class="prompt">$</code> cvs commit
1.33 wiz 9450: <code class="prompt">$</code> cd ..
9451: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9452: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9453: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9454: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9455: </pre>
1.1 dsieger 9456: <p>The commit message of the initial import should include part of the
9457: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9458: what the package is/does.</p>
1.33 wiz 9459: <p>Also mention the new package in
9460: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9461: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9462: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9463: </div>
1.41 asau 9464: <div class="sect1">
1.1 dsieger 9465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9466: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9467: <p>Please always put a concise, appropriate and relevant summary of the
9468: changes between old and new versions into the commit log when updating
9469: a package. There are various reasons for this:</p>
1.41 asau 9470: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9471: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9472: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9473: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9474: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9475: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9476: repository is very useful for people who read the pkgsrc-changes mailing
9477: list, so that they can make tactical decisions about when to upgrade
9478: the package.</p></li>
9479: </ul></div>
9480: <p>Please also recognize that, just because a new version of a package
9481: has been released, it should not automatically be upgraded in the CVS
9482: repository. We prefer to be conservative in the packages that are
9483: included in pkgsrc - development or beta packages are not really the
9484: best thing for most places in which pkgsrc is used. Please use your
9485: judgement about what should go into pkgsrc, and bear in mind that
9486: stability is to be preferred above new and possibly untested features.</p>
9487: </div>
1.41 asau 9488: <div class="sect1">
1.1 dsieger 9489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 9490: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9491: <p>Renaming packages is not recommended.</p>
9492: <p>When renaming packages, be sure to fix any references to old name
9493: in other Makefiles, options, buildlink files, etc.</p>
9494: <p>Also When renaming a package, please define
9495: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9496: pattern(s) of the previous package name.
9497: This may be repeated for multiple renames.
9498: The new package would be an exact replacement.
9499: </p>
1.23 wiz 9500: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9501: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9502: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9503: not be an exact replacement but is a suggestion for the replaced
9504: functionality.</p>
9505: </div>
1.41 asau 9506: <div class="sect1">
1.20 snj 9507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9508: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9509: <p>It is preferred that packages are not renamed or moved, but if needed
9510: please follow these steps.
9511: </p>
1.23 wiz 9512: <div class="orderedlist"><ol class="orderedlist" type="1">
9513: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9514: <li class="listitem">
1.1 dsieger 9515: <p>Remove all CVS dirs.</p>
9516: <p>Alternatively to the first two steps you can also do:</p>
9517: <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>
9518: <p>and use that for further work.</p>
9519: </li>
1.23 wiz 9520: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9521: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9522: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9523: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9524: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9525: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9526: for doing an update using pkgsrc building; for example, it can
1.79 snj 9527: 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 9528: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9529: new <code class="varname">PKGPATH</code> for that moved package. Note that
9530: it may have multiple matches, so the tool should also check on the
9531: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9532: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9533: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9534: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9535: place.</p></li>
1.23 wiz 9536: <li class="listitem">
1.1 dsieger 9537: <p>Check if any package depends on it:
9538: </p>
9539: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9540: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9541: </li>
1.23 wiz 9542: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9543: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9544: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9545: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9546: <li class="listitem">
1.1 dsieger 9547: <p>Commit the changed and removed files:</p>
9548: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9549: <p>(and any packages from step 5, of course).</p>
9550: </li>
9551: </ol></div>
9552: </div>
9553: </div>
1.41 asau 9554: <div class="chapter">
1.1 dsieger 9555: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9556: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9557: <p>This section contains the answers to questions that may
9558: arise when you are writing a package. If you don't find your
9559: question answered here, first have a look in the other chapters,
9560: and if you still don't have the answer, ask on the
9561: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9562: <div class="qandaset">
1.104 ! sevan 9563: <a name="idp2091429044"></a><dl>
1.6 rillig 9564: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9565: MAKEFLAGS, .MAKEFLAGS and
9566: MAKE_FLAGS?</a>
9567: </dt>
1.6 rillig 9568: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9569: MAKE, GMAKE and
9570: MAKE_PROGRAM?</a>
9571: </dt>
1.6 rillig 9572: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9573: CC, PKG_CC and
9574: PKGSRC_COMPILER?</a>
9575: </dt>
1.6 rillig 9576: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9577: BUILDLINK_LDFLAGS,
9578: BUILDLINK_LDADD and
9579: BUILDLINK_LIBS?</a>
9580: </dt>
1.6 rillig 9581: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9582: VARNAME=BUILDLINK_PREFIX.foo
9583: say it's empty?</a>
9584: </dt>
1.6 rillig 9585: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9586: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9587: don't understand the := inside
9588: it.</a>
9589: </dt>
1.6 rillig 9590: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9591: developers?</a>
9592: </dt>
1.6 rillig 9593: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9594: documentation?</a>
9595: </dt>
1.6 rillig 9596: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9597: do?</a>
9598: </dt>
9599: </dl>
1.41 asau 9600: <table border="0" style="width: 100%;">
9601: <colgroup>
1.1 dsieger 9602: <col align="left" width="1%">
1.23 wiz 9603: <col>
1.41 asau 9604: </colgroup>
1.1 dsieger 9605: <tbody>
1.41 asau 9606: <tr class="question">
1.1 dsieger 9607: <td align="left" valign="top">
1.104 ! sevan 9608: <a name="devfaq.makeflags"></a><a name="idp2091427972"></a><p><b>22.1.</b></p>
1.1 dsieger 9609: </td>
9610: <td align="left" valign="top"><p>What is the difference between
9611: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9612: <code class="varname">MAKE_FLAGS</code>?</p></td>
9613: </tr>
9614: <tr class="answer">
9615: <td align="left" valign="top"></td>
9616: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.79 snj 9617: 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 9618: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9619: the <code class="varname">MAKE_PROGRAM</code> when building the
9620: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9621: </tr>
1.41 asau 9622: <tr class="question">
1.1 dsieger 9623: <td align="left" valign="top">
1.104 ! sevan 9624: <a name="devfaq.make"></a><a name="idp2091431876"></a><p><b>22.2.</b></p>
1.1 dsieger 9625: </td>
9626: <td align="left" valign="top"><p>What is the difference between
9627: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9628: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9629: </tr>
9630: <tr class="answer">
9631: <td align="left" valign="top"></td>
9632: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.79 snj 9633: <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 9634: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9635: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9636: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9637: Make program that is used for building the
9638: package.</p></td>
9639: </tr>
1.41 asau 9640: <tr class="question">
1.1 dsieger 9641: <td align="left" valign="top">
1.104 ! sevan 9642: <a name="devfaq.cc"></a><a name="idp2091434644"></a><p><b>22.3.</b></p>
1.1 dsieger 9643: </td>
9644: <td align="left" valign="top"><p>What is the difference between
9645: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9646: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9647: </tr>
9648: <tr class="answer">
9649: <td align="left" valign="top"></td>
9650: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9651: compiler, which can be configured by the pkgsrc user.
9652: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9653: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9654: path to a compiler, but the type of compiler that should be
9655: used. See <code class="filename">mk/compiler.mk</code> for more
9656: information about the latter variable.</p></td>
9657: </tr>
1.41 asau 9658: <tr class="question">
1.1 dsieger 9659: <td align="left" valign="top">
1.104 ! sevan 9660: <a name="devfaq.bl3flags"></a><a name="idp2091437380"></a><p><b>22.4.</b></p>
1.1 dsieger 9661: </td>
9662: <td align="left" valign="top"><p>What is the difference between
9663: <code class="varname">BUILDLINK_LDFLAGS</code>,
9664: <code class="varname">BUILDLINK_LDADD</code> and
9665: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9666: </tr>
9667: <tr class="answer">
9668: <td align="left" valign="top"></td>
9669: <td align="left" valign="top"><p>[FIXME]</p></td>
9670: </tr>
1.41 asau 9671: <tr class="question">
1.1 dsieger 9672: <td align="left" valign="top">
1.104 ! sevan 9673: <a name="devfaq.bl3prefix"></a><a name="idp2091438804"></a><p><b>22.5.</b></p>
1.1 dsieger 9674: </td>
1.10 hubertf 9675: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9676: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9677: say it's empty?</p></td>
9678: </tr>
9679: <tr class="answer">
9680: <td align="left" valign="top"></td>
9681: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9682: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9683: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9684: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9685: command.</p></td>
9686: </tr>
1.41 asau 9687: <tr class="question">
1.1 dsieger 9688: <td align="left" valign="top">
1.104 ! sevan 9689: <a name="devfaq.master_sites"></a><a name="idp2091440980"></a><p><b>22.6.</b></p>
1.1 dsieger 9690: </td>
9691: <td align="left" valign="top"><p>What does
9692: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9693: don't understand the <code class="literal">:=</code> inside
9694: it.</p></td>
9695: </tr>
9696: <tr class="answer">
9697: <td align="left" valign="top"></td>
9698: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9699: assignment operator, like you might expect at first sight.
9700: Instead, it is a degenerate form of
9701: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.79 snj 9702: 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 9703: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9704: case of <code class="varname">MASTER_SITE_*</code>,
9705: <em class="replaceable"><code>old_string</code></em> is the empty string and
9706: <em class="replaceable"><code>new_string</code></em> is
9707: <code class="literal">package/</code>. That's where the
9708: <code class="literal">:</code> and the <code class="literal">=</code> fall
9709: together.</p></td>
9710: </tr>
1.41 asau 9711: <tr class="question">
1.1 dsieger 9712: <td align="left" valign="top">
1.104 ! sevan 9713: <a name="devfaq.mailinglists"></a><a name="idp2091446276"></a><p><b>22.7.</b></p>
1.1 dsieger 9714: </td>
9715: <td align="left" valign="top"><p>Which mailing lists are there for package
9716: developers?</p></td>
9717: </tr>
9718: <tr class="answer">
9719: <td align="left" valign="top"></td>
1.41 asau 9720: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9721: <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 9722: <dd><p>This is a list for technical discussions related
9723: to pkgsrc development, e.g. soliciting feedback for changes to
9724: pkgsrc infrastructure, proposed new features, questions related
9725: to porting pkgsrc to a new platform, advice for maintaining a
9726: package, patches that affect many packages, help requests moved
9727: from pkgsrc-users when an infrastructure bug is found,
9728: etc.</p></dd>
1.10 hubertf 9729: <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 9730: <dd><p>All bug reports in category "pkg" sent with
1.79 snj 9731: <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 9732: directly; use one of the other mailing
9733: lists.</p></dd>
9734: </dl></div></td>
9735: </tr>
1.41 asau 9736: <tr class="question">
1.1 dsieger 9737: <td align="left" valign="top">
1.104 ! sevan 9738: <a name="devfaq.documentation"></a><a name="idp2091449204"></a><p><b>22.8.</b></p>
1.1 dsieger 9739: </td>
9740: <td align="left" valign="top"><p>Where is the pkgsrc
9741: documentation?</p></td>
9742: </tr>
9743: <tr class="answer">
9744: <td align="left" valign="top"></td>
9745: <td align="left" valign="top">
9746: <p>There are many places where you can find
9747: documentation about pkgsrc:</p>
1.41 asau 9748: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9749: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9750: of chapters that explain large parts of pkgsrc, but some
9751: chapters tend to be outdated. Which ones they are is hard to
9752: say.</p></li>
1.23 wiz 9753: <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 9754: about certain features, announcements of new parts of the pkgsrc
9755: infrastructure and sometimes even announcements that a certain
9756: feature has been marked as obsolete. The benefit here is that
9757: each message has a date appended to it.</p></li>
1.23 wiz 9758: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9759: <code class="filename">mk/</code> directory start with a comment that
9760: describes the purpose of the file and how it can be used by the
9761: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9762: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9763: help</strong></span>.</p></li>
1.23 wiz 9764: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9765: information, but they tend to be highly abbreviated, especially
9766: for actions that occur often. Some contain a detailed
9767: description of what has changed, but they are geared towards the
9768: other pkgsrc developers, not towards an average pkgsrc user.
9769: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9770: don't know what has been before, these messages may not be worth
9771: too much to you.</p></li>
1.23 wiz 9772: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9773: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9774: mind of the developer who wrote the code. To get this
1.10 hubertf 9775: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9776: to see who has written it and ask on the
9777: <code class="literal">tech-pkg</code> mailing list, so that others can
9778: find your questions later (see above). To be sure that the
9779: developer in charge reads the mail, you may CC him or
9780: her.</p></li>
9781: </ul></div>
9782: </td>
9783: </tr>
1.41 asau 9784: <tr class="question">
1.1 dsieger 9785: <td align="left" valign="top">
1.104 ! sevan 9786: <a name="devfaq.too-much-time"></a><a name="idp2091454564"></a><p><b>22.9.</b></p>
1.1 dsieger 9787: </td>
9788: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9789: do?</p></td>
9790: </tr>
9791: <tr class="answer">
9792: <td align="left" valign="top"></td>
9793: <td align="left" valign="top">
9794: <p>This is not really an FAQ yet, but here's the answer
9795: anyway.</p>
1.41 asau 9796: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9797: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.79 snj 9798: <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 9799: will tell you about newer versions of installed packages that are
9800: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9801: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9802: — it contains a list of suggested new packages and a list of
1.1 dsieger 9803: cleanups and enhancements for pkgsrc that would be nice to
9804: have.</p></li>
1.23 wiz 9805: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9806: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9807: mailing list.</p></li>
9808: </ul></div>
9809: </td>
9810: </tr>
9811: </tbody>
9812: </table>
9813: </div>
9814: </div>
1.41 asau 9815: <div class="chapter">
1.1 dsieger 9816: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9817: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9818: <div class="toc">
9819: <p><b>Table of Contents</b></p>
1.100 leot 9820: <dl class="toc">
1.6 rillig 9821: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9822: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9823: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9824: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9825: </dl>
9826: </div>
1.10 hubertf 9827: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9828: site</a>:</p>
9829: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9830: environment, an intuitive and attractive desktop for users, and the
9831: GNOME development platform, an extensive framework for building
9832: applications that integrate into the rest of the desktop.</p></blockquote></div>
9833: <p>pkgsrc provides a seamless way to automatically build and install
9834: a complete GNOME environment <span class="emphasis"><em>under many different
9835: platforms</em></span>. We can say with confidence that pkgsrc is one of
9836: the most advanced build and packaging systems for GNOME due to its
9837: included technologies buildlink3, the wrappers and tools framework and
9838: automatic configuration file management. Lots of efforts are put into
9839: achieving a completely clean deinstallation of installed software
9840: components.</p>
1.10 hubertf 9841: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9842: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9843: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9844: pkgsrc as its preferred packaging system, contributing lots of
9845: portability fixes to make GNOME build and install under it.</p>
9846: <p>This chapter is aimed at pkgsrc developers and other people
9847: interested in helping our GNOME porting and packaging efforts. It
9848: provides instructions on how to manage the existing packages and some
9849: important information regarding their internals.</p>
1.41 asau 9850: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9851: <h3 class="title">We need your help!</h3>
9852: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9853: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9854: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9855: work</a> list! There is still a long way to go to get a
9856: fully-functional GNOME desktop under NetBSD and we need your help to
9857: achieve it!</p>
9858: </div>
1.41 asau 9859: <div class="sect1">
1.1 dsieger 9860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9861: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9862: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9863: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.79 snj 9864: <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 9865: the core GNOME desktop environment. It only includes the necessary
9866: bits to get it to boot correctly, although it may lack important
9867: functionality for daily operation. The idea behind this package is
9868: to let end users build their own configurations on top of this one,
9869: first installing this meta package to achieve a functional setup and
9870: then adding individual applications.</p></li>
1.79 snj 9871: <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 9872: complete installation of the GNOME platform and desktop as defined
9873: by the GNOME project; this is based on the components distributed in
9874: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9875: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9876: official FTP server. Developer-only tools found in those
9877: directories are not installed unless required by some other
9878: component to work properly. Similarly, packages from the bindings
9879: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9880: in unless required as a dependency for an end-user component. This
1.79 snj 9881: 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>
9882: <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 9883: Installs all the tools required to build a GNOME component when
9884: fetched from the CVS repository. These are required to let the
1.10 hubertf 9885: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9886: </ul></div>
9887: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9888: sorted in a way that eases updates: a package may depend on other
9889: packages listed before it but not on any listed after it. It is very
9890: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9891: change it to alphabetical sorting!</em></span></p>
9892: </div>
1.41 asau 9893: <div class="sect1">
1.1 dsieger 9894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9895: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9896: <p>Almost all GNOME applications are written in C and use a common
9897: set of tools as their build system. Things get different with the new
9898: bindings to other languages (such as Python), but the following will
9899: give you a general idea on the minimum required tools:</p>
1.41 asau 9900: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9901: <li class="listitem">
1.1 dsieger 9902: <p>Almost all GNOME applications use the GNU Autotools as their
9903: build system. As a general rule you will need to tell this to your
9904: package:</p>
9905: <pre class="programlisting">
9906: GNU_CONFIGURE=yes
9907: USE_LIBTOOL=yes
9908: USE_TOOLS+=gmake
9909: </pre>
9910: </li>
1.23 wiz 9911: <li class="listitem">
1.1 dsieger 9912: <p>If the package uses pkg-config to detect dependencies, add this
9913: tool to the list of required utilities:</p>
9914: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.79 snj 9915: <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 9916: the end of the build process to ensure that you did not miss to
9917: specify any dependency in your package and that the version
9918: requirements are all correct.</p>
9919: </li>
1.23 wiz 9920: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9921: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9922: to handle dependencies and to force the package to use the latest
9923: available version.</p></li>
1.23 wiz 9924: <li class="listitem">
1.1 dsieger 9925: <p>If the package uses gtk-doc (a documentation generation
9926: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9927: tool is rather big and the distfile should come with pregenerated
9928: documentation anyway; if it does not, it is a bug that you ought to
9929: report. For such packages you should disable gtk-doc (unless it is
9930: the default):</p>
9931: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9932: <p>The default location of installed HTML files
9933: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9934: and should not be changed unless the package insists on installing
9935: them somewhere else. Otherwise programs as
1.10 hubertf 9936: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9937: do that with an entry similar to:</p>
9938: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9939: </li>
9940: </ul></div>
9941: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9942: files under the installation prefix to maintain databases. In this
9943: context, shared means that those exact same directories and files are
9944: used among several different packages, leading to conflicts in the
9945: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9946: handle the most common cases, so you have to forget about using
9947: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9948: omitting shared files from them. If you find yourself doing those,
9949: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9950: <p>The following table lists the common situations that result in
9951: using shared directories or files. For each of them, the appropriate
9952: solution is given. After applying the solution be sure to
9953: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9954: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9955: <div class="table">
1.6 rillig 9956: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 9957: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
9958: <colgroup>
9959: <col>
9960: <col>
9961: </colgroup>
9962: <thead><tr>
9963: <th>If the package...</th>
9964: <th>Then...</th>
9965: </tr></thead>
9966: <tbody>
9967: <tr>
9968: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9969: <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 9970: </tr>
9971: <tr>
9972: <td>Installs icons under the
9973: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9974: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9975: <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 9976: </tr>
9977: <tr>
9978: <td>Installs files under
9979: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9980: <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 9981: </tr>
9982: <tr>
9983: <td>Installs <code class="filename">.desktop</code> files under
9984: <code class="filename">share/applications</code> and these include MIME
9985: information.</td>
1.10 hubertf 9986: <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 9987: </tr>
9988: </tbody>
9989: </table></div>
9990: </div>
9991: <br class="table-break">
9992: </div>
1.41 asau 9993: <div class="sect1">
1.1 dsieger 9994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9995: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9996: <p>When seeing GNOME as a whole, there are two kinds of
9997: updates:</p>
1.41 asau 9998: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9999: <dt><span class="term">Major update</span></dt>
10000: <dd>
10001: <p>Given that there is still a very long way for GNOME 3 (if it
10002: ever appears), we consider a major update one that goes from a
10003: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10004: where <code class="literal">Y</code> is even and greater than
10005: <code class="literal">X</code>. These are hard to achieve because they
10006: introduce lots of changes in the components' code and almost all
10007: GNOME distfiles are updated to newer versions. Some of them can
10008: even break API and ABI compatibility with the previous major
10009: version series. As a result, the update needs to be done all at
10010: once to minimize breakage.</p>
10011: <p>A major update typically consists of around 80 package
10012: updates and the addition of some new ones.</p>
10013: </dd>
10014: <dt><span class="term">Minor update</span></dt>
10015: <dd>
10016: <p>We consider a minor update one that goes from a
10017: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10018: one where <code class="literal">Y</code> is greater than
10019: <code class="literal">X</code>. These are easy to achieve because they do
10020: not update all GNOME components, can be done in an incremental way
10021: and do not break API nor ABI compatibility.</p>
10022: <p>A minor update typically consists of around 50 package
10023: updates, although the numbers here may vary a lot.</p>
10024: </dd>
10025: </dl></div>
10026: <p>In order to update the GNOME components in pkgsrc to a new stable
10027: release (either major or minor), the following steps should be
10028: followed:</p>
1.23 wiz 10029: <div class="orderedlist"><ol class="orderedlist" type="1">
10030: <li class="listitem">
1.1 dsieger 10031: <p>Get a list of all the tarballs that form the new release by
10032: using the following commands. These will leave the full list of the
1.18 snj 10033: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 10034: file:</p>
10035: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10036: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10037: awk '{ print $9 }' >list.txt</code></strong>
10038: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10039: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10040: awk '{ print $9 }' >>list.txt</code></strong></pre>
10041: </li>
1.23 wiz 10042: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 10043: bump their version to the release you are updating them to. The
10044: three meta packages should be always consistent with versioning.
10045: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10046: in them.</p></li>
1.23 wiz 10047: <li class="listitem">
1.1 dsieger 10048: <p>For each meta package, update all its
10049: <code class="varname">DEPENDS</code> lines to match the latest versions as
10050: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10051: newer version (even if found in the FTP) because the meta packages
10052: are supposed to list the exact versions that form a specific GNOME
10053: release. Exceptions are permitted here if a newer version solves a
10054: serious issue in the overall desktop experience; these typically
10055: come in the form of a revision bump in pkgsrc, not in newer versions
10056: from the developers.</p>
10057: <p>Packages not listed in the <code class="filename">list.txt</code> file
10058: should be updated to the latest version available (if found in
10059: pkgsrc). This is the case, for example, of the dependencies on the
1.79 snj 10060: 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 10061: </li>
1.23 wiz 10062: <li class="listitem">
1.1 dsieger 10063: <p>Generate a patch from the modified meta packages and extract the
10064: list of "new" lines. This will provide you an outline on what
10065: packages need to be updated in pkgsrc and in what order:</p>
10066: <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>
10067: </li>
1.23 wiz 10068: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 10069: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 10070: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 10071: of <code class="filename">todo.txt</code> and update the packages listed in
10072: it in order. For major desktop updates none of these should be
10073: committed until the entire set is completed because there are chances
10074: of breaking not-yet-updated packages.</p></li>
1.23 wiz 10075: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 10076: the tree one by one with appropriate log messages. At the end,
10077: commit the three meta package updates and all the corresponding
10078: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10079: <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>
10080: </ol></div>
10081: </div>
1.41 asau 10082: <div class="sect1">
1.1 dsieger 10083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10084: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 10085: <p>GNOME is a very big component in pkgsrc which approaches 100
10086: packages. Please, it is very important that you always, always,
10087: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 10088: 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 10089: their attention on portability issues and to ensure that future versions
10090: can be built out-of-the box on NetBSD. The less custom patches in
10091: pkgsrc, the easier further updates are. Those developers in charge of
10092: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 10093: <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 10094: Bugzilla</a>. Not all components use these to track bugs, but most
10095: of them do. Do not be short on your reports: always provide detailed
10096: explanations of the current failure, how it can be improved to achieve
10097: maximum portability and, if at all possible, provide a patch against CVS
10098: head. The more verbose you are, the higher chances of your patch being
10099: accepted.</p>
10100: <p>Also, please avoid using preprocessor magic to fix portability
10101: issues. While the FreeBSD GNOME people are doing a great job in porting
10102: GNOME to their operating system, the official GNOME sources are now
10103: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10104: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 10105: 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 10106: details.</p>
10107: </div>
10108: </div>
10109: </div>
1.41 asau 10110: <div class="part">
1.1 dsieger 10111: <div class="titlepage"><div><div><h1 class="title">
10112: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10113: <div class="partintro">
1.1 dsieger 10114: <div></div>
10115: <p>This part of the guide deals with everything
10116: from the infrastructure that is behind the interfaces described
10117: in the developer's guide. A casual package maintainer should not
10118: need anything from this part.</p>
10119: <div class="toc">
10120: <p><b>Table of Contents</b></p>
1.100 leot 10121: <dl class="toc">
1.6 rillig 10122: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10123: <dd><dl>
1.6 rillig 10124: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10125: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10126: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10127: <dd><dl>
1.6 rillig 10128: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10129: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10130: </dl></dd>
1.6 rillig 10131: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10132: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10133: <dd><dl>
1.6 rillig 10134: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10135: <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 10136: </dl></dd>
1.6 rillig 10137: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10138: <dd><dl>
1.23 wiz 10139: <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>
10140: <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 10141: </dl></dd>
10142: </dl></dd>
1.6 rillig 10143: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10144: <dd><dl>
1.6 rillig 10145: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10146: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10147: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10148: <dd><dl>
1.6 rillig 10149: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10150: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10151: </dl></dd>
10152: </dl></dd>
1.6 rillig 10153: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10154: <dd><dl>
1.6 rillig 10155: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10156: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10157: </dl></dd>
10158: </dl>
10159: </div>
10160: </div>
1.41 asau 10161: <div class="chapter">
1.1 dsieger 10162: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10163: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10164: <div class="toc">
10165: <p><b>Table of Contents</b></p>
1.100 leot 10166: <dl class="toc">
1.6 rillig 10167: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10168: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10169: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10170: <dd><dl>
1.6 rillig 10171: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10172: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10173: </dl></dd>
1.6 rillig 10174: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10175: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10176: <dd><dl>
1.6 rillig 10177: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10178: <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 10179: </dl></dd>
1.6 rillig 10180: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10181: <dd><dl>
1.23 wiz 10182: <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>
10183: <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 10184: </dl></dd>
10185: </dl>
10186: </div>
10187: <p>The pkgsrc infrastructure consists of many small Makefile
10188: fragments. Each such fragment needs a properly specified
10189: interface. This chapter explains how such an interface looks
10190: like.</p>
1.41 asau 10191: <div class="sect1">
1.1 dsieger 10192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10193: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10194: <p>Whenever a variable is defined in the pkgsrc
10195: infrastructure, the location and the way of definition provide
10196: much information about the intended use of that variable.
10197: Additionally, more documentation may be found in a header
10198: comment or in this pkgsrc guide.</p>
10199: <p>A special file is
10200: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10201: variables that are intended to be user-defined. They are either
10202: defined using the <code class="literal">?=</code> operator or they are
10203: left undefined because defining them to anything would
1.23 wiz 10204: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10205: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10206: file.</p>
10207: <p>Outside this file, the following conventions apply:
10208: Variables that are defined using the <code class="literal">?=</code>
10209: operator may be overridden by a package.</p>
10210: <p>Variables that are defined using the <code class="literal">=</code>
10211: operator may be used read-only at run-time.</p>
10212: <p>Variables whose name starts with an underscore must not be
10213: accessed outside the pkgsrc infrastructure at all. They may
10214: change without further notice.</p>
1.41 asau 10215: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10216: <h3 class="title">Note</h3>
10217: <p>These conventions are currently not applied
10218: consistently to the complete pkgsrc
10219: infrastructure.</p>
10220: </div>
10221: </div>
1.41 asau 10222: <div class="sect1">
1.1 dsieger 10223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10224: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10225: <p>All variables that contain lists of things should default
10226: to being empty. Two examples that do not follow this rule are
10227: <code class="varname">USE_LANGUAGES</code> and
10228: <code class="varname">DISTFILES</code>. These variables cannot simply be
10229: modified using the <code class="literal">+=</code> operator in package
10230: <code class="filename">Makefile</code>s (or other files included by
10231: them), since there is no guarantee whether the variable is
10232: already set or not, and what its value is. In the case of
1.23 wiz 10233: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10234: the default value and just define it as in the following
10235: example.</p>
10236: <pre class="programlisting">
10237: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10238: </pre>
10239: <p>Because of the selection of this default value, the same
10240: value appears in many package Makefiles. Similarly for
10241: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10242: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10243: doesn't stand out. Nevertheless it is mentioned in many
10244: files.</p>
10245: </div>
1.41 asau 10246: <div class="sect1">
1.1 dsieger 10247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10248: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 10249: <div class="sect2">
1.1 dsieger 10250: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10251: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10252: <p>Variable evaluation takes place either at load time or at
10253: runtime, depending on the context in which they occur. The
10254: contexts where variables are evaluated at load time are:</p>
1.41 asau 10255: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10256: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10257: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10258: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10259: <code class="literal">.for</code>,</p></li>
1.23 wiz 10260: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10261: </ul></div>
10262: <p>A special exception are references to the iteration
10263: variables of <code class="literal">.for</code> loops, which are expanded
10264: inline, no matter in which context they appear.</p>
10265: <p>As the values of variables may change during load time,
10266: care must be taken not to evaluate them by accident. Typical
10267: examples for variables that should not be evaluated at load time
10268: are <code class="varname">DEPENDS</code> and
10269: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10270: clear, here is an example:</p>
10271: <pre class="programlisting">
10272: CONFIGURE_ARGS= # none
10273: CFLAGS= -O
10274: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10275:
10276: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10277:
10278: CFLAGS+= -Wall
10279: </pre>
10280: <p>This code shows how the use of the <code class="literal">:=</code>
10281: operator can quickly lead to unexpected results. The first
10282: paragraph is fairly common code. The second paragraph evaluates
10283: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10284: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10285: <code class="literal">-Wall</code> is appended to the
10286: <code class="varname">CFLAGS</code>, but this addition will not appear in
10287: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10288: paragraphs from above typically occur in completely unrelated
10289: files.</p>
10290: </div>
1.41 asau 10291: <div class="sect2">
1.1 dsieger 10292: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10293: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10294: <p>After all the files have been loaded, the values of the
10295: variables cannot be changed anymore. Variables that are used in
10296: the shell commands are expanded at this point.</p>
10297: </div>
10298: </div>
1.41 asau 10299: <div class="sect1">
1.1 dsieger 10300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10301: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10302: <p>There are many ways in which the definition and use of a
10303: variable can be restricted in order to detect bugs and
10304: violations of the (mostly unwritten) policies. See the
10305: <code class="literal">pkglint</code> developer's documentation for further
10306: details.</p>
10307: </div>
1.41 asau 10308: <div class="sect1">
1.1 dsieger 10309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10310: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10311: <p>Most of the <code class="filename">.mk</code> files fall into one
10312: of the following classes. Cases where a file falls into more
10313: than one class should be avoided as it often leads to subtle
10314: bugs.</p>
1.41 asau 10315: <div class="sect2">
1.1 dsieger 10316: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10317: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10318: <p>In a traditional imperative programming language some of
10319: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10320: procedures. They take some input parameters and—after
10321: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10322: variables in <code class="filename">Makefile</code>s have global scope
10323: care must be taken not to use parameter names that have already
10324: another meaning. For example, <code class="varname">PKGNAME</code> is a
10325: bad choice for a parameter name.</p>
10326: <p>Procedures are completely evaluated at preprocessing time.
10327: That is, when calling a procedure all input parameters must be
10328: completely resolvable. For example,
10329: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10330: parameter since it is very likely that further text will be
10331: added after calling the procedure, which would effectively apply
10332: the procedure to only a part of the variable. Also, references
10333: to other variables wit will be modified after calling the
10334: procedure.</p>
10335: <p>A procedure can declare its output parameters either as
10336: suitable for use in preprocessing directives or as only
10337: available at runtime. The latter alternative is for variables
10338: that contain references to other runtime variables.</p>
10339: <p>Procedures shall be written such that it is possible to
10340: call the procedure more than once. That is, the file must not
10341: contain multiple-inclusion guards.</p>
10342: <p>Examples for procedures are
10343: <code class="filename">mk/bsd.options.mk</code> and
10344: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10345: that the parameters are evaluated at load time, they should be
10346: assigned using the <code class="literal">:=</code> operator, which should
10347: be used only for this purpose.</p>
10348: </div>
1.41 asau 10349: <div class="sect2">
1.1 dsieger 10350: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10351: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10352: <p>Action files take some input parameters and may define
10353: runtime variables. They shall not define loadtime variables.
10354: There are action files that are included implicitly by the
10355: pkgsrc infrastructure, while other must be included
10356: explicitly.</p>
10357: <p>An example for action files is
10358: <code class="filename">mk/subst.mk</code>.</p>
10359: </div>
10360: </div>
1.41 asau 10361: <div class="sect1">
1.1 dsieger 10362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10363: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10364: <p>Package <code class="filename">Makefile</code>s usually consist of
10365: a set of variable definitions, and include the file
10366: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10367: Before that, they may also include various other
10368: <code class="filename">*.mk</code> files if they need to query the
10369: availability of certain features like the type of compiler or
10370: the X11 implementation. Due to the heavy use of preprocessor
10371: directives like <code class="literal">.if</code> and
10372: <code class="literal">.for</code>, the order in which the files are loaded
10373: matters.</p>
10374: <p>This section describes at which point the various files
10375: are loaded and gives reasons for that order.</p>
1.41 asau 10376: <div class="sect2">
1.1 dsieger 10377: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10378: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10379: </h3></div></div></div>
10380: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10381: is to define some essential variables like
10382: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10383: <code class="varname">MACHINE_ARCH</code>.</p>
10384: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10385: 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 10386: After that, those variables
1.1 dsieger 10387: that have not been overridden by the user are loaded from
10388: <code class="filename">mk/defaults/mk.conf</code>.</p>
10389: <p>After the user settings, the system settings and platform
10390: settings are loaded, which may override the user
10391: settings.</p>
10392: <p>Then, the tool definitions are loaded. The tool wrappers
10393: are not yet in effect. This only happens when building a
10394: package, so the proper variables must be used instead of the
10395: direct tool names.</p>
10396: <p>As the last steps, some essential variables from the
10397: wrapper and the package system flavor are loaded, as well as the
10398: variables that have been cached in earlier phases of a package
10399: build.</p>
10400: </div>
1.41 asau 10401: <div class="sect2">
1.1 dsieger 10402: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10403: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10404: </h3></div></div></div>
10405: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10406: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10407: loaded, which fill default values for those variables that have
10408: not been defined by the package. These variables may later
10409: be used even in unrelated files.</p>
10410: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10411: provides the target <code class="literal">error-check</code> that is added
10412: as a special dependency to all other targets that use
10413: <code class="varname">DELAYED_ERROR_MSG</code> or
10414: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10415: <p>Then, the package-specific hacks from
10416: <code class="filename">hacks.mk</code> are included.</p>
10417: <p>Then, various other files follow. Most of them don't have
10418: any dependencies on what they need to have included before or
10419: after them, though some do.</p>
10420: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10421: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10422: restricts the use of these variables to all the files that have
10423: been included before. Appearances in later files will be
10424: silently ignored.</p>
10425: <p>Then, the files for the main targets are included, in the
10426: order of later execution, though the actual order should not
10427: matter.</p>
10428: <p>At last, some more files are included that don't set any
10429: interesting variables but rather just define make targets to be
10430: executed.</p>
10431: </div>
10432: </div>
10433: </div>
1.41 asau 10434: <div class="chapter">
1.1 dsieger 10435: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10436: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10437: <div class="toc">
10438: <p><b>Table of Contents</b></p>
1.100 leot 10439: <dl class="toc">
1.6 rillig 10440: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10441: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10442: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10443: <dd><dl>
1.6 rillig 10444: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10445: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10446: </dl></dd>
10447: </dl>
10448: </div>
10449: <p>The pkgsrc infrastructure consists of a large codebase,
10450: and there are many corners where every little bit of a file is
10451: well thought out, making pkgsrc likely to fail as soon as
10452: anything is changed near those parts. To prevent most changes
10453: from breaking anything, a suite of regression tests should go
10454: along with every important part of the pkgsrc infrastructure.
10455: This chapter describes how regression tests work in pkgsrc and
10456: how you can add new tests.</p>
1.41 asau 10457: <div class="sect1">
1.1 dsieger 10458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10459: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10460: <p></p>
10461: </div>
1.41 asau 10462: <div class="sect1">
1.1 dsieger 10463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10464: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.79 snj 10465: <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 10466: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10467: can simply run that command, which will run all tests in the
10468: <code class="filename">regress</code> category.</p>
10469: </div>
1.41 asau 10470: <div class="sect1">
1.1 dsieger 10471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10472: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10473: <p>Every directory in the <code class="filename">regress</code>
10474: category that contains a file called <code class="filename">spec</code>
10475: is considered a regression test. This file is a shell program
1.10 hubertf 10476: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10477: The following functions can be overridden to suit your
10478: needs.</p>
1.41 asau 10479: <div class="sect2">
1.1 dsieger 10480: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10481: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10482: <p>These functions do not take any parameters. They are all
1.23 wiz 10483: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.1 dsieger 10484: to check the exitcodes of any commands you run in the
10485: test.</p>
1.41 asau 10486: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10487: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10488: <dd><p>This function prepares the environment for the
10489: test. By default it does nothing.</p></dd>
10490: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10491: <dd><p>This function runs the actual test. By default,
10492: it calls <code class="varname">TEST_MAKE</code> with the arguments
10493: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10494: error messages into the file
10495: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10496: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10497: <dd><p>This function is run after the test and is
10498: typically used to compare the actual output from the one that is
10499: expected. It can make use of the various helper functions from
10500: the next section.</p></dd>
10501: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10502: <dd><p>This function cleans everything up after the
10503: test has been run. By default it does nothing.</p></dd>
10504: </dl></div>
10505: </div>
1.41 asau 10506: <div class="sect2">
1.1 dsieger 10507: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10508: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.41 asau 10509: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10510: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10511: <dd><p>This function compares the exitcode of the
1.10 hubertf 10512: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1 dsieger 10513: If they differ, the test will fail.</p></dd>
10514: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10515: <dd><p>This function checks for each of its parameters
1.10 hubertf 10516: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1 dsieger 10517: extended regular expression. If it does not, the test will
10518: fail.</p></dd>
10519: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10520: <dd><p>This function checks for each of its parameters
1.10 hubertf 10521: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10522: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10523: If any of the regular expressions matches, the test will
10524: fail.</p></dd>
10525: </dl></div>
10526: </div>
10527: </div>
10528: </div>
1.41 asau 10529: <div class="chapter">
1.1 dsieger 10530: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10531: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10532: <div class="toc">
10533: <p><b>Table of Contents</b></p>
1.100 leot 10534: <dl class="toc">
1.6 rillig 10535: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10536: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10537: </dl>
10538: </div>
10539: <p>The pkgsrc system has already been ported to many
10540: operating systems, hardware architectures and compilers. This
10541: chapter explains the necessary steps to make pkgsrc even more
10542: portable.</p>
1.41 asau 10543: <div class="sect1">
1.1 dsieger 10544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10545: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10546: <p>To port pkgsrc to a new operating system (called
10547: <code class="literal">MyOS</code> in this example), you need to touch the
10548: following files:</p>
1.41 asau 10549: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10550: <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>
10551: <dd><p>This file contains some basic definitions, for
10552: example the name of the C
10553: compiler.</p></dd>
10554: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10555: <dd><p>Insert code that defines the variables
10556: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10557: <code class="varname">LOWER_OS_VERSION</code>,
10558: <code class="varname">LOWER_VENDOR</code>,
10559: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10560: <code class="varname">APPEND_ELF</code>, and the other variables that
10561: appear in this file.</p></dd>
10562: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10563: <dd><p>This file contains the platform-specific
10564: definitions that are used by pkgsrc. Start by copying one of the
10565: other files and edit it to your
10566: needs.</p></dd>
10567: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10568: <dd><p>This file defines the paths to all the tools
10569: that are needed by one or the other package in pkgsrc, as well
10570: as by pkgsrc itself. Find out where these tools are on your
10571: platform and add them.</p></dd>
10572: </dl></div>
10573: <p>Now, you should be able to build some basic packages, like
1.79 snj 10574: <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 10575: </div>
1.41 asau 10576: <div class="sect1">
1.1 dsieger 10577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10578: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10579: <p>TODO</p>
10580: </div>
10581: </div>
10582: </div>
1.41 asau 10583: <div class="appendix">
10584: <div class="titlepage"><div><div><h1 class="title">
10585: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10586: <div class="toc">
10587: <p><b>Table of Contents</b></p>
1.100 leot 10588: <dl class="toc">
1.1 dsieger 10589: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10590: <dd><dl>
10591: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10592: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10593: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10594: <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 10595: </dl></dd>
10596: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10597: </dl>
10598: </div>
10599: <p>We checked to find a piece of software that wasn't in the packages
10600: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10601: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10602: present in the tree is beyond us, but it's useful for the purposes of
10603: this exercise.</p>
1.41 asau 10604: <div class="sect1">
1.1 dsieger 10605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10606: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10607: <div class="sect2">
1.1 dsieger 10608: <div class="titlepage"><div><div><h3 class="title">
10609: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10610: <pre class="programlisting">
10611: # $NetBSD$
10612: #
10613:
10614: DISTNAME= bison-1.25
10615: CATEGORIES= devel
10616: MASTER_SITES= ${MASTER_SITE_GNU}
10617:
1.29 dholland 10618: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10619: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10620: COMMENT= GNU yacc clone
10621:
10622: GNU_CONFIGURE= yes
1.46 wiz 10623: INFO_FILES= yes
1.1 dsieger 10624:
10625: .include "../../mk/bsd.pkg.mk"
10626: </pre>
10627: </div>
1.41 asau 10628: <div class="sect2">
1.1 dsieger 10629: <div class="titlepage"><div><div><h3 class="title">
10630: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10631: <pre class="programlisting">
10632: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.79 snj 10633: 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 10634: of the NetBSD source tree is beyond me.
10635: </pre>
10636: </div>
1.41 asau 10637: <div class="sect2">
1.1 dsieger 10638: <div class="titlepage"><div><div><h3 class="title">
10639: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10640: <pre class="programlisting">
10641: @comment $NetBSD$
10642: bin/bison
10643: man/man1/bison.1.gz
10644: share/bison.simple
10645: share/bison.hairy
10646: </pre>
10647: </div>
1.41 asau 10648: <div class="sect2">
1.1 dsieger 10649: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10650: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10651: </h3></div></div></div>
10652: <p>The NetBSD package system comes with
1.79 snj 10653: <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 10654: which helps to check the contents of these
10655: files. After installation it is quite easy to use, just change to the
10656: directory of the package you wish to examine and execute
1.10 hubertf 10657: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10658: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10659: looks fine.</pre>
10660: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10661: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10662: -Wall</strong></span> for a very thorough check.</p>
10663: </div>
10664: </div>
1.41 asau 10665: <div class="sect1">
1.1 dsieger 10666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10667: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10668: <p>Create the directory where the package lives,
10669: plus any auxiliary directories:</p>
10670: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10671: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10672: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10673: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10674: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 10675: <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 10676: then continue with fetching the distfile:</p>
10677: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10678: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10679: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10680: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10681: ftp: Error retrieving file: 500 Internal error
10682:
10683: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10684: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10685: ftp: Error retrieving file: 500 Internal error
10686:
10687: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10688: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10689: Successfully retrieved file.</pre>
10690: <p>Generate the checksum of the distfile into
10691: <code class="filename">distinfo</code>:</p>
10692: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10693: <p>Now compile:</p>
10694: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10695: >> Checksum OK for bison-1.25.tar.gz.
10696: ===> Extracting for bison-1.25
10697: ===> Patching for bison-1.25
10698: ===> Ignoring empty patch directory
10699: ===> Configuring for bison-1.25
10700: creating cache ./config.cache
10701: checking for gcc... cc
10702: checking whether we are using GNU C... yes
10703: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10704: checking how to run the C preprocessor... cc -E
10705: checking for minix/config.h... no
10706: checking for POSIXized ISC... no
10707: checking whether cross-compiling... no
10708: checking for ANSI C header files... yes
10709: checking for string.h... yes
10710: checking for stdlib.h... yes
10711: checking for memory.h... yes
10712: checking for working const... yes
10713: checking for working alloca.h... no
10714: checking for alloca... yes
10715: checking for strerror... yes
10716: updating cache ./config.cache
10717: creating ./config.status
10718: creating Makefile
10719: ===> Building for bison-1.25
10720: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10721: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10722: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10723: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10724: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
10725: 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
10726: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10727: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10728: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
10729: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lex.c
10730: 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
10731: 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
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 output.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 print.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 reader.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 reduce.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 symtab.c
10737: 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
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 version.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 getopt.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 getopt1.c
10741: 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
10742: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10743: rm -f bison.s1
10744: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10745: <p>Everything seems OK, so install the files:</p>
10746: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10747: >> Checksum OK for bison-1.25.tar.gz.
10748: ===> Installing for bison-1.25
10749: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10750: rm -f /usr/pkg/bin/bison
10751: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10752: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10753: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10754: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10755: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10756: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10757: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10758: ===> Registering installation for bison-1.25</pre>
10759: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10760: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10761: binary package, do this now:</p>
10762: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10763: >> Checksum OK for bison-1.25.tar.gz.
10764: ===> Building package for bison-1.25
10765: Creating package bison-1.25.tgz
10766: Registering depends:.
10767: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10768: <p>Now that you don't need the source and object files
10769: any more, clean up:</p>
10770: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10771: ===> Cleaning for bison-1.25</pre>
10772: </div>
10773: </div>
1.41 asau 10774: <div class="appendix">
10775: <div class="titlepage"><div><div><h1 class="title">
10776: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10777: <div class="toc">
10778: <p><b>Table of Contents</b></p>
1.100 leot 10779: <dl class="toc">
1.1 dsieger 10780: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10781: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10782: </dl>
10783: </div>
1.41 asau 10784: <div class="sect1">
1.1 dsieger 10785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10786: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10787: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10788: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10789: => figlet221.tar.gz doesn't seem to exist on this system.
10790: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10791: => [172219 bytes]
10792: Connected to ftp.plig.net.
10793: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10794: 331 Guest login ok, send your complete e-mail address as password.
10795: 230-You are user #5 of 500 simultaneous users allowed.
10796: 230-
10797: 230- ___ _ _ _
10798: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10799: 230- | _| _| . |_| . | | | . |_| . | _| . |
10800: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10801: 230- |_| |_| |___| |___|
10802: 230-
10803: 230-** Welcome to ftp.plig.org **
10804: 230-
10805: 230-Please note that all transfers from this FTP site are logged. If you
10806: 230-do not like this, please disconnect now.
10807: 230-
1.18 snj 10808: 230-This archive is available via
1.1 dsieger 10809: 230-
10810: 230-HTTP: http://ftp.plig.org/
10811: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10812: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10813: 230-
10814: 230-Please email comments, bug reports and requests for packages to be
10815: 230-mirrored to ftp-admin@plig.org.
10816: 230-
10817: 230-
10818: 230 Logged in anonymously.
10819: Remote system type is UNIX.
10820: Using binary mode to transfer files.
10821: 200 Type okay.
10822: 250 "/pub" is new cwd.
10823: 250-"/pub/figlet" is new cwd.
10824: 250-
10825: 250-Welcome to the figlet archive at ftp.figlet.org
10826: 250-
10827: 250- ftp://ftp.figlet.org/pub/figlet/
10828: 250-
10829: 250-The official FIGlet web page is:
10830: 250- http://www.figlet.org/
10831: 250-
10832: 250-If you have questions, please mailto:info@figlet.org. If you want to
10833: 250-contribute a font or something else, you can email us.
10834: 250
10835: 250 "/pub/figlet/program" is new cwd.
10836: 250 "/pub/figlet/program/unix" is new cwd.
10837: local: figlet221.tar.gz remote: figlet221.tar.gz
10838: 502 Unimplemented command.
10839: 227 Entering Passive Mode (195,40,6,41,246,104)
10840: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10841: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10842: 226 Transfer completed.
10843: 172219 bytes received in 00:02 (75.99 KB/s)
10844: 221 Goodbye.
10845: => Checksum OK for figlet221.tar.gz.
10846: ===> Extracting for figlet-2.2.1nb2
10847: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10848: ===> Patching for figlet-2.2.1nb2
10849: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10850: ===> Overriding tools for figlet-2.2.1nb2
10851: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10852: ===> Configuring for figlet-2.2.1nb2
10853: ===> Building for figlet-2.2.1nb2
10854: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10855: chmod a+x figlet
10856: gcc -O2 -o chkfont chkfont.c
10857: => Unwrapping files-to-be-installed.
10858: <code class="prompt">#</code>
10859: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10860: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10861: ===> Installing for figlet-2.2.1nb2
10862: install -d -o root -g wheel -m 755 /usr/pkg/bin
10863: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10864: mkdir -p /usr/pkg/share/figlet
10865: cp figlet /usr/pkg/bin
10866: cp chkfont /usr/pkg/bin
10867: chmod 555 figlist showfigfonts
10868: cp figlist /usr/pkg/bin
10869: cp showfigfonts /usr/pkg/bin
10870: cp fonts/*.flf /usr/pkg/share/figlet
10871: cp fonts/*.flc /usr/pkg/share/figlet
10872: cp figlet.6 /usr/pkg/man/man6
10873: ===> Registering installation for figlet-2.2.1nb2
10874: <code class="prompt">#</code></pre>
10875: </div>
1.41 asau 10876: <div class="sect1">
1.1 dsieger 10877: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10878: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10879: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10880: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10881: ===> Packaging figlet-2.2.1nb2
10882: ===> Building binary package for figlet-2.2.1nb2
10883: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10884: Using SrcDir value of /usr/pkg
10885: Registering depends:.
10886: <code class="prompt">#</code></pre>
10887: </div>
10888: </div>
1.41 asau 10889: <div class="appendix">
10890: <div class="titlepage"><div><div><h1 class="title">
10891: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10892: <div class="toc">
10893: <p><b>Table of Contents</b></p>
1.100 leot 10894: <dl class="toc">
1.23 wiz 10895: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10896: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10897: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10898: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10899: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10900: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10901: source packages</a></span></dt>
10902: </dl>
10903: </div>
10904: <p>As in other big projects, the directory layout of pkgsrc
10905: is quite complex for newbies. This chapter explains where you
10906: find things on the FTP server. The base directory on
1.10 hubertf 10907: <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 10908: On other servers it may be different, but inside this directory,
10909: everything should look the same, no matter on which server you
10910: are. This directory contains some subdirectories, which are
10911: explained below.</p>
1.41 asau 10912: <div class="sect1">
1.1 dsieger 10913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10914: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10915: <p>The directory <code class="filename">distfiles</code> contains lots
10916: of archive files from all pkgsrc packages, which are mirrored
10917: here. The subdirectories are called after their package names
10918: and are used when the distributed files have names that don't
10919: explicitly contain a version number or are otherwise too generic
10920: (for example <code class="filename">release.tar.gz</code>).</p>
10921: </div>
1.41 asau 10922: <div class="sect1">
1.1 dsieger 10923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10924: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10925: <p>This directory contains things that individual pkgsrc
10926: developers find worth publishing.</p>
10927: </div>
1.41 asau 10928: <div class="sect1">
1.1 dsieger 10929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10930: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10931: <p>This directory contains binary packages for the various
10932: platforms that are supported by pkgsrc.
10933: 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 10934: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10935: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10936: operating system for which the packages have been built. The
1.10 hubertf 10937: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10938: command, so it may differ from the one you are used to
10939: hear.</p></li>
1.23 wiz 10940: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10941: architecture of the platform for which the packages have been
1.10 hubertf 10942: built. It also includes the <code class="varname">ABI</code> (Application
10943: Binary Interface) for platforms that have several of
10944: them.</p></li>
1.23 wiz 10945: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10946: the operating system. For version numbers that change often (for
10947: example NetBSD-current), the often-changing part should be
10948: replaced with an <code class="literal">x</code>, for example
10949: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10950: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10951: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10952: for a stable branch, or <code class="literal">head</code> for packages
10953: built from the HEAD branch. The latter should only be used when
10954: the packages are updated on a regular basis. Otherwise the date
10955: from checking out pkgsrc should be appended, for example
10956: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10957: </ul></div>
10958: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10959: can quickly click through the directories on the
10960: server and find the best binary packages for their machines. Since they
10961: usually know the operating system and the hardware architecture, OPSYS
10962: and ARCH are placed first. After these choices, they can select the
10963: best combination of OSVERSION and TAG together, since it is usually the
10964: case that packages stay compatible between different version of the
10965: operating system.</p>
10966: <p>In each of these directories, there is a
10967: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10968: <code class="filename">All</code> which contains all binary packages.
10969: Besides that, there are various category directories that
10970: contain symbolic links to the real binary packages.</p>
10971: </div>
1.41 asau 10972: <div class="sect1">
1.1 dsieger 10973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10974: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10975: <p>Here are the reports from bulk builds, for those who want
10976: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10977: 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 10978: </div>
1.41 asau 10979: <div class="sect1">
1.8 rillig 10980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10981: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10982: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10983: source packages</h2></div></div></div>
1.23 wiz 10984: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10985: that is the files that define how to create binary packages from
10986: source archives.</p>
10987: <p>The directory <code class="filename">pkgsrc</code> contains a
10988: snapshot of the CVS repository, which is updated regularly. The
10989: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10990: directory, ready to be downloaded as a whole.</p>
10991: <p>In the directories for the quarterly branches, there is an
10992: additional file called
1.22 jakllsch 10993: <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 10994: which contains the state of pkgsrc when it was branched.</p>
10995: </div>
10996: </div>
1.41 asau 10997: <div class="appendix">
10998: <div class="titlepage"><div><div><h1 class="title">
10999: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 11000: <div class="toc">
11001: <p><b>Table of Contents</b></p>
1.100 leot 11002: <dl class="toc">
1.1 dsieger 11003: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11004: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11005: </dl>
11006: </div>
11007: <p>This section contains information on editing the pkgsrc
11008: guide itself.</p>
1.41 asau 11009: <div class="sect1">
1.1 dsieger 11010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11011: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11012: <p>The pkgsrc guide's source code is stored in
11013: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11014: are created from it:</p>
1.41 asau 11015: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 11016: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11017: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11018: <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>
11019: <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 11020: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 11021: <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 11022: PostScript version of the pkgsrc guide.</p></li>
11023: </ul></div>
11024: </div>
1.41 asau 11025: <div class="sect1">
1.1 dsieger 11026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11027: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11028: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 11029: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 11030: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 11031: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 11032: documentation) installed. These are automatically installed when
1.79 snj 11033: 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 11034: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 11035: right directory. All further steps will take place
11036: here.</p></li>
1.41 asau 11037: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 11038: <code class="filename">files/</code>.</p></li>
1.41 asau 11039: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 11040: guide for valid XML and to build the final output files. If you
11041: get any errors at this stage, you can just edit the files, as
11042: there are only symbolic links in the working directory, pointing
11043: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 11044: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 11045: commit)</strong></span></p></li>
1.41 asau 11046: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 11047: regenerate the output files with the proper RCS
11048: Ids.</p></li>
1.41 asau 11049: <li class="step">
1.10 hubertf 11050: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 11051: commit the files in both <code class="filename">pkgsrc/doc</code> and
11052: <code class="filename">htdocs</code>.</p>
1.41 asau 11053: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 11054: <h3 class="title">Note</h3>
11055: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 11056: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11057: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 11058: directory.</p>
11059: </div>
11060: </li>
11061: </ol></div>
11062: </div>
11063: </div>
11064: </div></body>
11065: </html>
CVSweb <webmaster@jp.NetBSD.org>