Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.66
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.4 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.6 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig 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>
48: <dl>
49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
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.6 rillig 136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
1.66 ! asau 138: <dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
1.6 rillig 139: <dd><dl>
1.66 ! asau 140: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
! 141: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
1.6 rillig 142: </dl></dd>
1.66 ! asau 143: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
! 144: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 145: </dl></dd>
146: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
147: <dd><dl>
1.23 wiz 148: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
149: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 150: </dl></dd>
151: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
152: <dd><dl>
153: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
154: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
155: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
156: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
157: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
158: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
159: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.65 wiz 160: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
161: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
162: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
163: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 164: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.65 wiz 165: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
166: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
167: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
168: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
169: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
170: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
171: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 172: </dl></dd>
173: </dl></dd>
174: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
175: <dd><dl>
1.6 rillig 176: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 177: <dd><dl>
1.6 rillig 178: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 179: <dd><dl>
1.6 rillig 180: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 ! asau 181: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 182: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 183: </dl></dd>
1.6 rillig 184: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
185: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
186: </dl></dd>
187: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
188: <dd><dl>
1.23 wiz 189: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
190: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 191: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
192: <dd><dl>
193: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
194: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
195: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
196: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
197: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
198: </dl></dd>
199: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
200: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
201: <dd><dl>
202: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
203: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
204: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
205: </dl></dd>
1.23 wiz 206: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
207: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 208: </dl></dd>
1.23 wiz 209: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 210: <dd><dl>
211: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 212: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 213: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
214: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
215: <dd><dl>
216: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
217: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
218: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
219: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
220: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
221: </dl></dd>
222: </dl></dd>
223: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
224: <dd><dl>
225: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 226: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
227: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 228: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
229: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 230: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 231: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
232: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
233: </dl></dd>
234: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
235: <dd><dl>
236: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 237: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 238: <dd><dl>
239: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 240: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
241: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
242: and
243: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
244: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 245: </dl></dd>
1.23 wiz 246: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 247: <dd><dl>
1.23 wiz 248: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 249: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
250: </dl></dd>
251: </dl></dd>
252: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
253: <dd><dl>
254: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
255: <dd><dl>
256: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
257: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
258: </dl></dd>
259: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
260: <dd><dl>
1.23 wiz 261: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 262: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
263: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
264: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
265: </dl></dd>
266: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
267: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
268: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
269: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
270: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
271: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
272: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
273: </dl></dd>
274: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
275: <dd><dl>
276: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 277: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 278: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 279: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 280: </dl></dd>
281: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
282: <dd><dl>
283: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
284: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
285: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
286: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 287: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 288: <dd><dl>
289: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
290: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
291: </dl></dd>
1.23 wiz 292: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
299: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
301: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 302: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
303: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
304: </dl></dd>
305: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
306: <dd><dl>
307: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
308: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
309: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
310: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
311: </dl></dd>
312: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
315: <dd><dl>
316: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 317: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6 rillig 318: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
319: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
320: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
321: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
322: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
323: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
324: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
325: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
326: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
327: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
328: </dl></dd>
1.23 wiz 329: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 330: <dd><dl>
331: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
332: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
333: </dl></dd>
1.23 wiz 334: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 335: <dd><dl>
336: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
337: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
338: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
339: </dl></dd>
340: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
341: <dd><dl>
342: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
343: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
344: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 345: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
346: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 347: </dl></dd>
1.23 wiz 348: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 349: <dd><dl>
350: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
351: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 352: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 353: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
354: </dl></dd>
1.23 wiz 355: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 356: <dd><dl>
357: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
358: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
359: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
360: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
361: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
362: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
363: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
364: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 365: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 366: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 367: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
368: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
369: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
370: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
371: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
372: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
373: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
374: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 375: emulation</a></span></dt>
1.6 rillig 376: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
377: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 378: </dl></dd>
1.6 rillig 379: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 380: </dl></dd>
1.6 rillig 381: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
382: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 383: <dd><dl>
1.6 rillig 384: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
385: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
386: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 387: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 388: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 389: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
390: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 391: </dl></dd>
392: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
393: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
394: <dd><dl>
395: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
396: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
397: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
398: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 399: </dl></dd>
400: </dl></dd>
401: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
402: <dd><dl>
1.6 rillig 403: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 404: <dd><dl>
1.6 rillig 405: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
406: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
407: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 408: <dd><dl>
1.6 rillig 409: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
410: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 411: </dl></dd>
1.6 rillig 412: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
413: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 414: <dd><dl>
1.6 rillig 415: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
416: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 417: </dl></dd>
1.6 rillig 418: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 419: <dd><dl>
1.23 wiz 420: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
421: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 422: </dl></dd>
423: </dl></dd>
1.6 rillig 424: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 425: <dd><dl>
1.6 rillig 426: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
427: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
428: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 429: <dd><dl>
1.6 rillig 430: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
431: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 432: </dl></dd>
433: </dl></dd>
1.6 rillig 434: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 435: <dd><dl>
1.6 rillig 436: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
437: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 438: </dl></dd>
439: </dl></dd>
440: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
441: <dd><dl>
442: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
443: <dd><dl>
444: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
445: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
446: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 447: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 448: </dl></dd>
449: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
450: </dl></dd>
451: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
452: <dd><dl>
453: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
454: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
455: </dl></dd>
456: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
457: <dd><dl>
1.23 wiz 458: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
459: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
460: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
461: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
462: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
463: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 464: source packages</a></span></dt>
465: </dl></dd>
466: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
467: <dd><dl>
468: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
469: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
470: </dl></dd>
471: </dl>
472: </div>
473: <div class="list-of-tables">
474: <p><b>List of Tables</b></p>
475: <dl>
476: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
477: </dt>
1.6 rillig 478: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 479: </dt>
1.6 rillig 480: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 481: </dt>
482: </dl>
483: </div>
1.41 asau 484: <div class="chapter">
485: <div class="titlepage"><div><div><h1 class="title">
486: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 487: <div class="toc">
488: <p><b>Table of Contents</b></p>
489: <dl>
490: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
491: <dd><dl>
492: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
493: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
494: </dl></dd>
495: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
496: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
497: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
498: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
499: </dl>
500: </div>
1.41 asau 501: <div class="sect1">
1.1 dsieger 502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
503: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
504: <p>There is a lot of software freely available for Unix-based
505: systems, which is usually available in form of the source code. Before
506: such software can be used, it needs to be configured to the local
507: system, compiled and installed, and this is exactly what The NetBSD
508: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
509: to handle binary packages, so that not every user has to build the
510: packages for himself, which is a time-costly task.</p>
511: <p>pkgsrc currently contains several thousand packages,
512: including:</p>
1.41 asau 513: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 514: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.1 dsieger 515: web server</p></li>
1.23 wiz 516: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 517: web browser</p></li>
1.23 wiz 518: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 519: Desktop Environment</p></li>
1.23 wiz 520: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.1 dsieger 521: Desktop Environment</p></li>
522: </ul></div>
523: <p>...just to name a few.</p>
524: <p>pkgsrc has built-in support for handling varying dependencies,
525: such as pthreads and X11, and extended features such as IPv6 support on
526: a range of platforms.</p>
1.41 asau 527: <div class="sect2">
1.1 dsieger 528: <div class="titlepage"><div><div><h3 class="title">
529: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
530: <p>
531: pkgsrc provides the following key features:
532: </p>
1.41 asau 533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 534: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 535: and installation of binary packages. The source and latest
536: patches are retrieved from a master or mirror download site, checksum
537: verified, then built on your system. Support for binary-only
538: distributions is available for both native platforms and NetBSD
539: emulated platforms.</p></li>
1.23 wiz 540: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 541: including binaries, libraries, man pages and other
542: documentation.</p></li>
1.23 wiz 543: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1 dsieger 544: are handled automatically. The configuration files of various
545: packages are handled automatically during updates, so local changes
546: are preserved.</p></li>
1.23 wiz 547: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 548: consists of highly portable code. This allows the greatest speed of
1.25 spz 549: development when porting to a new platform. This portability also
1.1 dsieger 550: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
551: platforms</em></span>.</p></li>
1.23 wiz 552: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 553: international encryption requirements and build-time options for a
554: large number of packages are all set in a simple, central
555: configuration file.</p></li>
1.23 wiz 556: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 557: freely available under a BSD license, so you may extend and adapt
558: pkgsrc to your needs. Support for local packages and patches is
559: available right out of the box, so you can configure it specifically
560: for your environment.</p></li>
561: </ul></div>
562: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 564: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 565: — That means, if a package contains bugs, it's better to find
1.1 dsieger 566: them and to complain about them rather than to just install the package
567: and hope that it works. There are numerous checks in pkgsrc that try to
568: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
569: of shell scripts), and post-installation checks (installed files,
570: references to shared libraries, script interpreters).</p></li>
1.23 wiz 571: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 572: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 573: pkgsrc has been ported to many operating systems. Care is taken that
574: packages behave the same on all platforms.</p></li>
575: </ul></div>
576: </div>
1.41 asau 577: <div class="sect2">
1.1 dsieger 578: <div class="titlepage"><div><div><h3 class="title">
579: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
580: <p>pkgsrc consists of both a source distribution and a binary
581: distribution for these operating systems. After retrieving the required
582: source or binaries, you can be up and running with pkgsrc in just
583: minutes!</p>
584: <p>pkgsrc was derived from FreeBSD's ports system, and
585: initially developed for NetBSD only. Since then, pkgsrc has
586: grown a lot, and now supports the following platforms:</p>
587: <div class="table">
588: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
589: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
590: <colgroup>
591: <col>
592: <col>
593: </colgroup>
594: <thead><tr>
595: <th>Platform</th>
596: <th>Date Support Added</th>
597: </tr></thead>
598: <tbody>
599: <tr>
1.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>
602: </tr>
603: <tr>
1.10 hubertf 604: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 605: <td align="center">Mar 1999</td>
606: </tr>
607: <tr>
1.10 hubertf 608: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 609: <td align="center">Jun 1999</td>
610: </tr>
611: <tr>
612: <td>
1.10 hubertf 613: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
614: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 615: </td>
616: <td align="center">Oct 2001</td>
617: </tr>
618: <tr>
1.10 hubertf 619: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 620: <td align="center">Nov 2002</td>
621: </tr>
622: <tr>
1.10 hubertf 623: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 624: <td align="center">Nov 2002</td>
625: </tr>
626: <tr>
1.10 hubertf 627: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 628: <td align="center">Dec 2002</td>
629: </tr>
630: <tr>
631: <td>BSD/OS</td>
632: <td align="center">Dec 2003</td>
633: </tr>
634: <tr>
1.10 hubertf 635: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 636: <td align="center">Dec 2003</td>
637: </tr>
638: <tr>
639: <td>
1.10 hubertf 640: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 641: (Microsoft Windows Services for Unix)
642: </td>
643: <td align="center">Mar 2004</td>
644: </tr>
645: <tr>
1.10 hubertf 646: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 647: <td align="center">Oct 2004</td>
648: </tr>
649: <tr>
1.10 hubertf 650: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 651: <td align="center">Nov 2004</td>
652: </tr>
653: <tr>
1.10 hubertf 654: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 655: <td align="center">Apr 2007</td>
656: </tr>
1.23 wiz 657: <tr>
658: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
659: <td align="center">Sep 2010</td>
660: </tr>
1.45 obache 661: <tr>
662: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 663: <td align="center">Jan 2011</td>
1.45 obache 664: </tr>
665: <tr>
666: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
667: <td align="center">Nov 2011</td>
668: </tr>
669: <tr>
670: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
671: <td align="center">Mar 2013</td>
672: </tr>
1.58 ryoon 673: <tr>
674: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
675: <td align="center">Jul 2013</td>
676: </tr>
1.1 dsieger 677: </tbody>
678: </table></div>
679: </div>
680: <br class="table-break">
681: </div>
682: </div>
1.41 asau 683: <div class="sect1">
1.1 dsieger 684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
685: <a name="overview"></a>1.2. Overview</h2></div></div></div>
686: <p>This document is divided into three parts. The first,
1.10 hubertf 687: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 688: describes how one can use one of the packages in the Package
689: Collection, either by installing a precompiled binary package,
690: or by building one's own copy using the NetBSD package system.
1.10 hubertf 691: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 692: package so it can be easily built by other NetBSD users without
693: knowing about the package's building details. The third part,
1.10 hubertf 694: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 695: is intended for those who want to understand how pkgsrc is
696: implemented.</p>
697: <p>This document is available in various formats:
1.10 hubertf 698: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 699: </div>
1.41 asau 700: <div class="sect1">
1.1 dsieger 701: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
702: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 703: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
704: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 705: terminology used within this document.</p>
1.41 asau 706: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 707: <dt><span class="term">Package</span></dt>
708: <dd><p>A set of files and building instructions
709: that describe what's necessary
710: to build a certain piece of software using
711: pkgsrc. Packages are traditionally stored under
712: <code class="filename">/usr/pkgsrc</code>.</p></dd>
713: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 714: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 715: is part of the NetBSD operating system and can be bootstrapped
716: to run on non-NetBSD operating systems as well. It handles
717: building (compiling), installing, and removing of
718: packages.</p></dd>
719: <dt><span class="term">Distfile</span></dt>
720: <dd><p>This term describes the file or files that are
721: provided by the author of the piece of software to
722: distribute his work. All the changes necessary to build on
723: NetBSD are reflected in the corresponding package. Usually
724: the distfile is in the form of a compressed tar-archive,
725: but other types are possible, too. Distfiles are usually
726: stored below
727: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
728: <dt><span class="term">Port</span></dt>
729: <dd><p>This is the term used by FreeBSD and OpenBSD people
730: for what we call a package.
1.23 wiz 731: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 732: architecture.</p></dd>
733: <dt><span class="term">Precompiled/binary package</span></dt>
734: <dd>
735: <p>A set of binaries built with pkgsrc from a distfile
736: and stuffed together in a single <code class="filename">.tgz</code>
737: file so it can be installed on machines of the same
738: machine architecture without the need to
739: recompile. Packages are usually generated in
740: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 741: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 742: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 743: especially in the context of precompiled packages.</p>
744: </dd>
745: <dt><span class="term">Program</span></dt>
746: <dd><p>The piece of software to be installed which will be
747: constructed from all the files in the distfile by the
748: actions defined in the corresponding package.</p></dd>
749: </dl></div>
1.41 asau 750: <div class="sect2">
1.1 dsieger 751: <div class="titlepage"><div><div><h3 class="title">
752: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 753: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 754: <dt><span class="term">pkgsrc users</span></dt>
755: <dd>
756: <p>The
757: pkgsrc users are people who use the packages provided by pkgsrc.
758: Typically they are system administrators. The people using the
1.23 wiz 759: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
760: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 761: <p>There are two kinds of pkgsrc users: Some only want to
762: install pre-built binary packages. Others build the pkgsrc
763: packages from source, either for installing them directly or for
1.10 hubertf 764: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 765: documentation.</p>
766: </dd>
767: <dt><span class="term">package maintainers</span></dt>
768: <dd><p>A
1.10 hubertf 769: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 770: <dt><span class="term">infrastructure developers</span></dt>
771: <dd><p>These people are involved in all those files
772: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 773: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 774: too.</p></dd>
775: </dl></div>
776: </div>
777: </div>
1.41 asau 778: <div class="sect1">
1.1 dsieger 779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
780: <a name="typography"></a>1.4. Typography</h2></div></div></div>
781: <p>When giving examples for commands, shell prompts are used to
782: show if the command should/can be issued as root, or if
1.23 wiz 783: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 784: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
785: shell prompt, assuming they use the C-shell or tcsh.</p>
786: </div>
787: </div>
1.41 asau 788: <div class="part">
1.1 dsieger 789: <div class="titlepage"><div><div><h1 class="title">
790: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
791: <div class="toc">
792: <p><b>Table of Contents</b></p>
793: <dl>
794: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
795: <dd><dl>
796: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
797: <dd><dl>
1.51 asau 798: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 799: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 800: </dl></dd>
801: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
802: <dd><dl>
803: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
804: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
805: </dl></dd>
806: </dl></dd>
807: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
808: <dd><dl>
809: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
810: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
811: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
812: <dd><dl>
1.45 obache 813: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
814: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
815: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 816: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
817: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
818: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
819: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
820: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
821: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
822: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 823: </dl></dd>
824: </dl></dd>
825: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
826: <dd><dl>
827: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
828: <dd><dl>
829: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
830: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
831: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
832: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
833: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
834: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
835: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
836: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
837: </dl></dd>
838: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
839: <dd><dl>
840: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
841: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
842: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
843: </dl></dd>
844: </dl></dd>
845: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
846: <dd><dl>
847: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
848: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 849: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 850: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 851: <dd><dl>
1.4 rillig 852: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 853: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
854: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 855: </dl></dd>
1.4 rillig 856: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
857: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 858: </dl></dd>
859: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
860: <dd><dl>
861: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
862: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 863: </dl></dd>
864: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
865: builds)</a></span></dt>
1.1 dsieger 866: <dd><dl>
1.6 rillig 867: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
868: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
1.66 ! asau 869: <dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
1.15 rillig 870: <dd><dl>
1.66 ! asau 871: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
! 872: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
1.15 rillig 873: </dl></dd>
1.66 ! asau 874: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
! 875: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 876: </dl></dd>
877: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
878: <dd><dl>
1.23 wiz 879: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
880: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 881: </dl></dd>
882: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
883: <dd><dl>
884: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
885: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
886: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
887: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
888: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
889: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
890: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.65 wiz 891: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
892: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
893: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
894: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 895: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.65 wiz 896: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
897: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
898: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
899: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
900: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
901: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
902: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 903: </dl></dd>
904: </dl>
905: </div>
1.41 asau 906: <div class="chapter">
1.1 dsieger 907: <div class="titlepage"><div><div><h2 class="title">
908: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
909: <div class="toc">
910: <p><b>Table of Contents</b></p>
911: <dl>
912: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
913: <dd><dl>
1.51 asau 914: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 915: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 916: </dl></dd>
917: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
918: <dd><dl>
919: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
920: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
921: </dl></dd>
922: </dl>
923: </div>
924: <p>Before you download and extract the files, you need to decide
925: where you want to extract them. When using pkgsrc as root user, pkgsrc
926: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
927: free to install the sources and binary packages wherever you want in
928: your filesystem, provided that the pathname does not contain white-space
929: or other characters that are interpreted specially by the shell and some
930: other programs. A safe bet is to use only letters, digits, underscores
931: and dashes.</p>
1.41 asau 932: <div class="sect1">
1.1 dsieger 933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
934: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
935: <p>Before you download any pkgsrc files, you should decide
936: whether you want the <span class="emphasis"><em>current</em></span> branch or the
937: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
938: quarterly basis from the current branch and only gets modified
939: for security updates. The names of the stable branches are built
940: from the year and the quarter, for example
1.21 snj 941: <code class="literal">2009Q1</code>.</p>
1.1 dsieger 942: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 943: want to download pkgsrc. You can get it as a tar file or via CVS.
944: Both ways are described here.</p>
1.51 asau 945: <p>Note that tar archive contains CVS working copy.
946: Thus you can switch to using CVS at any later time.</p>
947: <p>Note also that quarterly branch is not frozen in stone.
948: It receives critical updates.</p>
1.41 asau 949: <div class="sect2">
1.1 dsieger 950: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 951: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 952: <p>The primary download location for all pkgsrc files is
1.51 asau 953: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
954: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
955: (it points to the same location).
956: There are a number of subdirectories for different purposes,
957: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
958: <p>The tar archive for the current branch is in the directory
959: <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.1 dsieger 960: It is autogenerated daily.</p>
1.51 asau 961: <p>To save download time we provide bzip2- and
962: xz-compressed archives which are published at
963: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
964: and
965: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
966: respectively.
967: </p>
968: <p>You can fetch the same files using FTP.</p>
1.59 jnemeth 969: <p>The tar file for the stable branch 2013Q1 is in the
970: directory <code class="filename">pkgsrc-2013Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2013Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.12 weinem 971: <p>To download a pkgsrc stable tarball, run:</p>
972: <pre class="screen">
1.59 jnemeth 973: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.22 jakllsch 974: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 975: stable branch to be downloaded, for example,
1.59 jnemeth 976: <span class="quote">“<span class="quote">pkgsrc-2013Q1</span>”</span>.</p>
1.51 asau 977: <p>You can use fetch it also using "wget", "curl",
978: or your web browser.</p>
1.12 weinem 979: <p>Then, extract it with:</p>
1.22 jakllsch 980: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.12 weinem 981: <p>This will create the directory <code class="filename">pkgsrc/</code>
982: in <code class="filename">/usr/</code> and all the package source will be
983: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
984: <p>To download pkgsrc-current, run:</p>
985: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 986: </div>
1.41 asau 987: <div class="sect2">
1.1 dsieger 988: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 989: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
990: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 991: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.23 wiz 992: </pre>
993: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
994: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
995: <p>This will create the directory <code class="filename">pkgsrc/</code>
996: in your <code class="filename">/usr/</code> directory and all the package source
997: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
998: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 999: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1000: </pre>
1.29 dholland 1001: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 1002: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 1003: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 1004: </pre>
1005: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1006: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1007: or better globally in <code class="filename">/etc/profile</code>:</p>
1008: <pre class="programlisting">
1009: # set CVS remote shell command
1010: CVS_RSH=ssh
1011: export CVS_RSH
1012: </pre>
1013: <p>By default, CVS doesn't do things like most people would expect it to do.
1014: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1015: in your home directory and saving the following lines to it.
1016: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1017: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1018: <pre class="programlisting">
1019: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1020: cvs -q -z2
1.2 rillig 1021: checkout -P
1.4 rillig 1022: update -dP
1023: diff -upN
1.2 rillig 1024: rdiff -u
1.23 wiz 1025: release -d
1.2 rillig 1026: </pre>
1.1 dsieger 1027: </div>
1028: </div>
1.41 asau 1029: <div class="sect1">
1.1 dsieger 1030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1031: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1032: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1033: (which also works if you have first installed it via a tar
1034: file). It saves bandwidth and hard disk activity, compared to
1035: downloading the tar file again.</p>
1.41 asau 1036: <div class="sect2">
1.1 dsieger 1037: <div class="titlepage"><div><div><h3 class="title">
1038: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1039: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1040: <h3 class="title">Warning</h3>
1041: <p>When updating from a tar file, you first need to
1042: completely remove the old pkgsrc directory. Otherwise those
1043: files that have been removed from pkgsrc in the mean time will
1044: not be removed on your local disk, resulting in inconsistencies.
1045: When removing the old files, any changes that you have done to
1046: the pkgsrc files will be lost after updating. Therefore updating
1047: via CVS is strongly recommended.</p>
1048: </div>
1049: <p>Note that by default the distfiles and the binary packages
1050: are saved in the pkgsrc tree, so don't forget to rescue them
1051: before updating. You can also configure pkgsrc to use other than
1052: the default directories by setting the
1053: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1054: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1055: <p>To update pkgsrc from a tar file, download the tar file as
1056: explained above. Then, make sure that you have not made any
1057: changes to the files in the pkgsrc directory. Remove the pkgsrc
1058: directory and extract the new tar file. Done.</p>
1059: </div>
1.41 asau 1060: <div class="sect2">
1.1 dsieger 1061: <div class="titlepage"><div><div><h3 class="title">
1062: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1063: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1064: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1065: </pre>
1066: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1067: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1068: </pre>
1.41 asau 1069: <div class="sect3">
1.1 dsieger 1070: <div class="titlepage"><div><div><h4 class="title">
1071: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1072: <p>When updating pkgsrc, the CVS program keeps track of the
1073: branch you selected. But if you, for whatever reason, want to
1074: switch from the stable branch to the current one, you can do it
1.23 wiz 1075: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1076: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1077: back to the stable branch, add the
1.23 wiz 1078: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.1 dsieger 1079: </div>
1.41 asau 1080: <div class="sect3">
1.1 dsieger 1081: <div class="titlepage"><div><div><h4 class="title">
1082: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1083: <p>When you update pkgsrc, the CVS program will only touch
1084: those files that are registered in the CVS repository. That
1085: means that any packages that you created on your own will stay
1086: unmodified. If you change files that are managed by CVS, later
1087: updates will try to merge your changes with those that have been
1088: done by others. See the CVS manual, chapter
1.23 wiz 1089: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1090: </div>
1091: </div>
1092: </div>
1093: </div>
1.41 asau 1094: <div class="chapter">
1.1 dsieger 1095: <div class="titlepage"><div><div><h2 class="title">
1096: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1097: <div class="toc">
1098: <p><b>Table of Contents</b></p>
1099: <dl>
1100: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1101: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1102: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1103: <dd><dl>
1.45 obache 1104: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1105: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1106: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 1107: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1108: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1109: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1110: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1111: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1112: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1113: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 1114: </dl></dd>
1115: </dl>
1116: </div>
1.41 asau 1117: <div class="sect1">
1.1 dsieger 1118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1119: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1120: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.1 dsieger 1121: </div>
1.41 asau 1122: <div class="sect1">
1.1 dsieger 1123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1124: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1125: <p>pkgsrc can be bootstrapped for use in two different modes:
1126: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1127: to privileged one all programs are installed under one particular user
1.43 asau 1128: and cannot utilise privileged operations (packages don't create
1129: special users and all special file permissions like setuid are ignored).
1130: </p>
1.1 dsieger 1131: <p>Installing the bootstrap kit from source should be as simple as:</p>
1132: <pre class="screen">
1.60 asau 1133: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1134: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1135: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1136: </pre>
1.43 asau 1137: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1138: <p>By default, in privileged mode pkgsrc uses
1139: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1140: where programs will be installed in,
1.1 dsieger 1141: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1142: directory where pkgsrc will do its internal bookkeeping,
1143: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1144: where packages install their persistent data.
1145: In unprivileged mode pkgsrc uses
1146: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1147: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1148: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1149: </p>
1150: <p>You can change default layout using command-line arguments.
1151: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1152: </p>
1.41 asau 1153: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1154: <h3 class="title">Note</h3>
1.10 hubertf 1155: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1156: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1157: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1158: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1159: </div>
1.43 asau 1160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1161: <h3 class="title">Note</h3>
1162: <p>It is possible to bootstrap multiple instances of pkgsrc
1163: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1164: corresponding to the installation you're working with to build
1165: and install packages.
1166: </p>
1167: </div>
1.1 dsieger 1168: </div>
1.41 asau 1169: <div class="sect1">
1.1 dsieger 1170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1171: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1172: <p>Here are some platform-specific notes you should be aware of.</p>
1.41 asau 1173: <div class="sect2">
1.1 dsieger 1174: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1175: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1176: <p>Cygwin 1.7.x and later are supported.</p>
1177: <p>You need to install minimal base packages in `Base' category
1178: plus any of compiler, gcc, gcc4, and/or clang.
1179: For gcc and gcc4, C and C++ compiler will be installed by default,
1180: but you can install Fortran compiler additionally
1181: because it will be required to use libtool.
1182: If it is not installed (or too old), Fortran compiler will be
1183: installed with pkgsrc automatically.</p>
1184: <p>As noted in
1185: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1186: su(1) command has been in Cygwin distribution, but it has never worked.
1187: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1188: </p>
1189: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1190: then pick "Run as administrator".</p></li></ul></div>
1191: </div>
1192: <div class="sect2">
1193: <div class="titlepage"><div><div><h3 class="title">
1194: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.41 asau 1195: <p>Darwin 5.x and up are supported.</p>
1196: <p>Before you start, you need to download and install
1197: the Mac OS X Developer Tools from Apple's Developer Connection.
1198: This requires (free) membership. See
1.22 jakllsch 1199: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.41 asau 1200: for details. Also, make sure you install X11 (an optional
1201: package included with the Developer Tools) if you intend
1202: to build packages that use the X11 Window System.
1203: (If you don't want or need the full Xcode GUI,
1204: download and install Command Line Tools for Xcode.)</p>
1.1 dsieger 1205: </div>
1.41 asau 1206: <div class="sect2">
1.1 dsieger 1207: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1208: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.29 dholland 1209: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1 dsieger 1210: other versions may work.</p>
1211: <p>Care should be taken so that the tools that this kit installs do not conflict
1212: with the FreeBSD userland tools. There are several steps:</p>
1.23 wiz 1213: <div class="orderedlist"><ol class="orderedlist" type="1">
1214: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1 dsieger 1215: <code class="filename">/var/db/pkg</code>. It is therefore
1216: recommended that you choose a different location (e.g.
1217: <code class="filename">/usr/pkgdb</code>) by
1218: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1219: <li class="listitem">
1.1 dsieger 1220: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1221: good idea to move them out of the way to avoid confusion, e.g.</p>
1222: <pre class="screen">
1223: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1224: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1225: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1226: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1227: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1228: </pre>
1229: </li>
1.23 wiz 1230: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1231: <code class="filename">/etc/mk.conf.example</code> file
1232: when you use the bootstrap script.</p></li>
1233: </ol></div>
1234: </div>
1.41 asau 1235: <div class="sect2">
1.1 dsieger 1236: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1237: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1238: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1239: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1240: <p> You should install ncurses (libncurses and libncurses-dev)
1241: packages.</p>
1242: </div>
1243: <div class="sect2">
1244: <div class="titlepage"><div><div><h3 class="title">
1245: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.1 dsieger 1246: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1247: providing a Unix-like environment with a tighter kernel integration than
1248: available with Cygwin. It is part of the Windows Services for Unix
1249: package, available for free for any licensed copy of Windows 2000, XP
1.10 hubertf 1250: (not including XP Home), or 2003. SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.1 dsieger 1251: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1252: are not officially supported. (The main difference in 3.0/3.1 is lack
1253: of pthreads, but other parts of libc may also be lacking.)</p>
1.24 wiz 1254: <p>Services for Unix Applications (aka SUA) is an integrated
1255: component of Windows Server 2003 R2 (5.2), Windows Vista and
1256: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1257: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1258: 6.1 (64bit) subsystems have been tested. Other versions may
1259: work as well. The Interix 5.x subsystem has not yet been tested
1260: with pkgsrc.</p>
1.41 asau 1261: <div class="sect3">
1.1 dsieger 1262: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1263: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.1 dsieger 1264: <p>At an absolute minimum, the following packages must be installed from
1265: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.41 asau 1266: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1267: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1268: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1269: <li class="listitem"><p>Remote Connectivity</p></li>
1270: <li class="listitem"><p>Interix SDK</p></li>
1.1 dsieger 1271: </ul></div>
1272: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1273: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1274: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1275: pkgsrc (or from a binary package).</p>
1276: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1277: not need to be installed, but Remote Connectivity itself should be
1278: installed in order to have a working inetd.</p>
1279: <p>During installation you may be asked whether to enable setuid
1280: behavior for Interix programs, and whether to make pathnames default to
1281: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1282: enabled. (Without case-sensitivity, a large number of packages including
1283: perl will not build.)</p>
1284: <p>NOTE: Newer Windows service packs change the way binary execution
1285: works (via the Data Execution Prevention feature). In order to use
1286: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1287: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1288: must be installed. Hotfixes are available from Microsoft through a
1.14 jmcneill 1289: support contract; however, Debian Interix Port has made most Interix
1290: hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.1 dsieger 1291: <p>In addition to the hotfix noted above, it may be necessary to
1292: disable Data Execution Prevention entirely to make Interix functional.
1293: This may happen only with certain types of CPUs; the cause is not fully
1294: understood at this time. If gcc or other applications still segfault
1295: repeatedly after installing one of the hotfixes note above, the
1296: following option can be added to the appropriate "boot.ini" line on the
1297: Windows boot drive: /NoExecute=AlwaysOff
1298: (WARNING, this will disable DEP completely, which may be a security
1299: risk if applications are often run as a user in the Administrators
1300: group!)</p>
1301: </div>
1.41 asau 1302: <div class="sect3">
1.1 dsieger 1303: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1304: <a name="platform.interix-sfu-postinstall"></a>3.3.5.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.1 dsieger 1305: <p>If SFU is already installed and you wish to alter these settings to work
1306: with pkgsrc, note the following things.</p>
1.41 asau 1307: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1308: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1 dsieger 1309: Windows Services for UNIX, then click Change. In the installer, choose
1310: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.23 wiz 1311: <li class="listitem">
1.1 dsieger 1312: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1313: change the following registry key:</p>
1314: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1315: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1316: </li>
1.23 wiz 1317: <li class="listitem">
1.1 dsieger 1318: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1319: following registry key:</p>
1320: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1321: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1322: </li>
1323: </ul></div>
1324: </div>
1.41 asau 1325: <div class="sect3">
1.1 dsieger 1326: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1327: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.1 dsieger 1328: <p>The package manager (either the pkgsrc "su" user, or the user
1329: running "pkg_add") must be a member of the local Administrators
1330: group. Such a user must also be used to run the bootstrap. This is
1331: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1332: <p>The package manager should use a umask of 002. "make install" will
1333: automatically complain if this is not the case. This ensures that
1334: directories written in /var/db/pkg are Administrators-group writeable.</p>
1335: <p>The popular Interix binary packages from http://www.interopsystems.com/
1336: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1337: NOT be used in conjunction with pkgsrc. If you choose to use them at
1338: the same time as the pkgsrc packages, ensure that you use the proper
1339: pkg_* tools for each type of binary package.</p>
1340: <p>The TERM setting used for DOS-type console windows (including those
1341: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1342: don't have a termcap/terminfo entry for it, but the following .termcap
1343: entry provides adequate emulation in most cases:</p>
1344: <pre class="programlisting">
1345: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1346: </pre>
1347: </div>
1.41 asau 1348: <div class="sect3">
1.1 dsieger 1349: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1350: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.1 dsieger 1351: <p>Though Interix suffices as a familiar and flexible substitute
1352: for a full Unix-like platform, it has some drawbacks that should
1353: be noted for those desiring to make the most of Interix.</p>
1.41 asau 1354: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1355: <li class="listitem">
1.1 dsieger 1356: <p><span class="strong"><strong>X11:</strong></span></p>
1357: <p>Interix comes with the standard set of X11R6 client libraries,
1358: and can run X11 based applications, but it does
1359: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.10 hubertf 1360: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1361: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1 dsieger 1362: (available in a trimmed version for Interix from Interop Systems as the
1.10 hubertf 1363: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1 dsieger 1364: and the free X11 server included with
1.10 hubertf 1365: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1 dsieger 1366: </li>
1.23 wiz 1367: <li class="listitem">
1.1 dsieger 1368: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1369: <p>Because Interix runs in a completely different NT subsystem from
1370: Win32 applications, it does not currently support various X11
1371: protocol extensions for acceleration (such as MIT-SHM or DGA).
1372: Most interactive applications to a local X server will run
1373: reasonably fast, but full motion video and other graphics
1374: intensive applications may require a faster-than-expected CPU.</p>
1375: </li>
1.23 wiz 1376: <li class="listitem">
1.1 dsieger 1377: <p><span class="strong"><strong>Audio:</strong></span></p>
1378: <p>Interix has no native support for audio output. For audio
1.10 hubertf 1379: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1 dsieger 1380: audio system on Interix. Unlike on most platforms, the
1381: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.10 hubertf 1382: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1 dsieger 1383: server component. To output audio via an Interix host, the
1384: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1385: must also be installed.</p>
1386: </li>
1.23 wiz 1387: <li class="listitem">
1.1 dsieger 1388: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1389: <p>Direct device access is not currently supported in Interix, so it
1390: is not currently possible to access CD/DVD drives, USB devices,
1391: or SCSI devices through non-filesystem means. Among other things,
1392: this makes it impossible to use Interix directly for CD/DVD
1393: burning.</p>
1394: </li>
1.23 wiz 1395: <li class="listitem">
1.1 dsieger 1396: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1397: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1398: drives are also not directly accessible in Interix. However,
1399: support is in work to make tape drive access possible by using
1400: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1401: esound server).</p>
1402: </li>
1403: </ul></div>
1404: </div>
1.41 asau 1405: <div class="sect3">
1.1 dsieger 1406: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1407: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.1 dsieger 1408: <p>It is not necessary, in general, to have a "root" user on the
1409: Windows system; any member of the local Administrators group will
1410: suffice. However, some packages currently assume that the user
1411: named "root" is the privileged user. To accommodate these, you
1412: may create such a user; make sure it is in the local group
1413: Administrators (or your language equivalent).</p>
1.10 hubertf 1414: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1 dsieger 1415: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1416: time being, install packages as the local Administrator (or
1417: your language equivalent), or run the following command after
1418: installing a package to work around the issue:</p>
1419: <pre class="screen">
1420: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1421: </pre>
1422: </div>
1423: </div>
1.41 asau 1424: <div class="sect2">
1.1 dsieger 1425: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1426: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.1 dsieger 1427: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1428: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1429: according to your preference. If you do not have a license for the MIPSpro
1.10 hubertf 1430: compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.1 dsieger 1431: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.29 dholland 1432: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.1 dsieger 1433: etc.</p>
1434: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1435: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1436: you start out using "abi=n32", that's what all your packages will be built
1437: with.</p>
1438: <p>Therefore, please make sure that you have no conflicting
1439: <code class="varname">CFLAGS</code> in your environment or the
1.10 hubertf 1440: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1441: try to link n32 object files with lib64 or vice versa. Check your
1442: <code class="filename">/etc/compiler.defaults</code>!</p>
1443: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1444: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1445: as it appears that IRIX linker occasionally runs into issues when trying to
1446: link over a network-mounted file system.</p>
1447: <p>The bootstrapping process should set all the right options for programs such
1448: as imake(1), but you may want to set some options depending on your local
1449: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1450: course, your compiler's man pages for details.</p>
1451: <p>If you are using SGI's MIPSPro compiler, please set
1452:
1453: </p>
1454: <pre class="programlisting">
1455: PKGSRC_COMPILER= mipspro
1456: </pre>
1457: <p>
1458:
1.10 hubertf 1459: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1460: are using gcc and may end up passing invalid flags to the compiler. Note that
1461: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1462: default.</p>
1463: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1464: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1465: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1466: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1467: '--preserve-path' flag.</p>
1468: </div>
1.41 asau 1469: <div class="sect2">
1.1 dsieger 1470: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1471: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.1 dsieger 1472: <p>Some versions of Linux (for example Debian GNU/Linux) need
1473: either libtermcap or libcurses (libncurses). Installing the
1474: distributions libncurses-dev package (or equivalent) should fix
1475: the problem.</p>
1476: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1477: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1478: i386 have been tested.</p>
1479: <p>To bootstrap using icc, assuming the default icc installation
1480: directory:</p>
1481: <pre class="programlisting">
1.31 wiz 1482: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1 dsieger 1483: </pre>
1.41 asau 1484: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1485: <h3 class="title">Note</h3>
1.31 wiz 1486: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1487: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1488: <p>For icc 10.1 neither of these appears to be necessary.</p>
1489: </div>
1490: <p>Use a value for ICCBASE that corresponds to the directory
1491: where icc is installed. After bootstrapping, set
1492: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30 wiz 1493: <pre class="programlisting">
1.31 wiz 1494: ICCBASE= /opt/intel/cc/10.1.008
1.1 dsieger 1495: </pre>
1.31 wiz 1496: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1497: <code class="filename">/opt/intel_cc_80</code>. This is the default
1498: install directory for icc 8.0. If you are using a more recent
1499: version, be sure to set the correct path explicitly.
1500: </p>
1.1 dsieger 1501: <p>pkgsrc uses the static linking method of the runtime libraries
1502: provided by icc, so binaries can be run on other systems which do not
1503: have the shared libraries installed.</p>
1504: <p>Libtool, however, extracts a list of libraries from the
1.29 dholland 1505: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.1 dsieger 1506: records it, throwing away the -Bstatic and -Bdynamic options
1507: interspersed between the libraries. This means that
1508: libtool-linked C++ shared libraries will have a runtime
1509: dependency on the icc libraries until this is fixed in
1510: libtool.</p>
1511: </div>
1.41 asau 1512: <div class="sect2">
1.1 dsieger 1513: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1514: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.57 bsiegert 1515: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1516: Older versions might also work. Releases before #10 are not
1517: supported.</p>
1518: <p>The package tools of the (older) native ports tree,
1519: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1520: have the same names as the ones used by pkgsrc. Care should be taken
1521: that the right tools are used. When installing packages from source,
1522: use the <code class="filename">bmake</code> command for pkgsrc and
1523: <code class="filename">mmake</code> for MirPorts.</p>
1524: <p>pkgsrc and MirPorts use the same location for the package
1525: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1526: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1527: tree is self-contained. This is also the default setting used in the
1528: binary package builds.</p>
1529: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1530: server. The bootstrap kit there already contains the
1531: <span class="command"><strong>pkgin</strong></span> package manager. See the
1532: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1533: page for more details.</p>
1534: </div>
1535: <div class="sect2">
1536: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1537: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.29 dholland 1538: <p>OpenBSD 5.1 has been tested and supported,
1539: other versions may work.</p>
1.1 dsieger 1540: <p>Care should be taken so that the tools that this kit installs do not conflict
1541: with the OpenBSD userland tools. There are several steps:</p>
1.23 wiz 1542: <div class="orderedlist"><ol class="orderedlist" type="1">
1543: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1 dsieger 1544: <code class="filename">/var/db/pkg</code>. It is therefore
1545: recommended that you choose a different location (e.g.
1546: <code class="filename">/usr/pkgdb</code>) by
1547: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1548: <li class="listitem">
1.1 dsieger 1549: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1550: good idea to move them out of the way to avoid confusion, e.g.</p>
1551: <pre class="screen">
1552: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1553: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1554: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1555: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1556: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1557: </pre>
1558: </li>
1.23 wiz 1559: <li class="listitem">
1.10 hubertf 1560: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1561: <code class="filename">/etc/mk.conf.example</code> file
1562: when you use the bootstrap script. OpenBSD's make program uses
1.10 hubertf 1563: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1564: as well. You can work around this by enclosing all the pkgsrc-specific parts
1565: of the file with:</p>
1566: <pre class="programlisting">
1567: .ifdef BSD_PKG_MK
1568: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1569: .else
1570: # OpenBSD stuff
1571: .endif
1572: </pre>
1573: </li>
1574: </ol></div>
1575: </div>
1.41 asau 1576: <div class="sect2">
1.1 dsieger 1577: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1578: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.35 wiz 1579: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1580: You will need a working C compiler. Both gcc 4.5.3 and
1.1 dsieger 1581: Sun WorkShop 5 have been tested.</p>
1582: <p>The following packages are required on Solaris 8 for the bootstrap
1583: process and to build packages.</p>
1.41 asau 1584: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1585: <li class="listitem"><p>SUNWsprot</p></li>
1586: <li class="listitem"><p>SUNWarc</p></li>
1587: <li class="listitem"><p>SUNWbtool</p></li>
1588: <li class="listitem"><p>SUNWtoo</p></li>
1589: <li class="listitem"><p>SUNWlibm</p></li>
1.1 dsieger 1590: </ul></div>
1591: <p>Please note that the use of GNU binutils on Solaris is
1592: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1593: <p>Whichever compiler you use, please ensure the compiler tools and
1594: your $prefix are in your <code class="varname">PATH</code>. This includes
1595: <code class="filename">/usr/ccs/{bin,lib}</code>
1596: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.41 asau 1597: <div class="sect3">
1.1 dsieger 1598: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1599: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.1 dsieger 1600: <p>It makes life much simpler if you only use the same gcc consistently
1601: for building all packages.</p>
1602: <p>It is recommended that an external gcc be used only for bootstrapping,
1603: then either build gcc from
1.35 wiz 1604: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.1 dsieger 1605: package, then remove gcc used during bootstrapping.</p>
1.10 hubertf 1606: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.1 dsieger 1607: </div>
1.41 asau 1608: <div class="sect3">
1.1 dsieger 1609: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1610: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.1 dsieger 1611: <p>You will need at least the following packages installed (from WorkShop
1612: 5.0)</p>
1.41 asau 1613: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1614: <li class="listitem"><p>SPROcc
1.1 dsieger 1615: - Sun WorkShop Compiler C 5.0</p></li>
1.23 wiz 1616: <li class="listitem"><p>SPROcpl
1.1 dsieger 1617: - Sun WorkShop Compiler C++ 5.0</p></li>
1.23 wiz 1618: <li class="listitem"><p>SPROild
1.1 dsieger 1619: - Sun WorkShop Incremental Linker</p></li>
1.23 wiz 1620: <li class="listitem"><p>SPROlang
1.1 dsieger 1621: - Sun WorkShop Compilers common components</p></li>
1622: </ul></div>
1623: <p>You should set the following variables in your
1.10 hubertf 1624: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1625: <pre class="programlisting">
1626: CC= cc
1627: CXX= CC
1628: CPP= cc -E
1629: CXXCPP= CC -E
1630: </pre>
1.41 asau 1631: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1632: <h3 class="title">Note</h3>
1633: <p>The <code class="varname">CPP</code> setting might break some
1634: packages that use the C preprocessor for processing things other
1635: than C source code.</p>
1636: </div>
1637: </div>
1.41 asau 1638: <div class="sect3">
1.1 dsieger 1639: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1640: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.1 dsieger 1641: <p>To build 64-bit packages, you just need to have the
1.10 hubertf 1642: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1643: <pre class="programlisting">
1644: PKGSRC_COMPILER= sunpro
1645: ABI= 64
1646: </pre>
1.41 asau 1647: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1648: <h3 class="title">Note</h3>
1649: <p>This setting has been tested for the SPARC
1650: architecture. Intel and AMD machines need some more
1651: work.</p>
1652: </div>
1653: </div>
1.41 asau 1654: <div class="sect3">
1.1 dsieger 1655: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1656: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.10 hubertf 1657: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1 dsieger 1658: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1659: The workaround is to use another shell for the configure
1660: scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.10 hubertf 1661: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1662: <pre class="programlisting">
1663: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1664: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1665: </pre>
1666: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1667: </div>
1668: </div>
1669: </div>
1670: </div>
1.41 asau 1671: <div class="chapter">
1.1 dsieger 1672: <div class="titlepage"><div><div><h2 class="title">
1673: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1674: <div class="toc">
1675: <p><b>Table of Contents</b></p>
1676: <dl>
1677: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1678: <dd><dl>
1679: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1680: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1681: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1682: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1683: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1684: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1685: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1686: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1687: </dl></dd>
1688: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1689: <dd><dl>
1690: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1691: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1692: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1693: </dl></dd>
1694: </dl>
1695: </div>
1696: <p>Basically, there are two ways of using pkgsrc. The first
1697: is to only install the package tools and to use binary packages
1.23 wiz 1698: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1699: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1700: of pkgsrc, too. Then you are able to build your own packages,
1701: and you can still use binary packages from someone else.</p>
1.41 asau 1702: <div class="sect1">
1.1 dsieger 1703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1704: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1705: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1706: server and its mirrors, there are collections of binary packages,
1707: ready to be installed. These binary packages have been built using the
1708: default settings for the directories, that is:</p>
1.41 asau 1709: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1710: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1711: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1712: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1713: </ul></div>
1714: <p>If you cannot use these directories for whatever reasons (maybe
1715: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1716: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1717: <div class="sect2">
1.1 dsieger 1718: <div class="titlepage"><div><div><h3 class="title">
1719: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1720: <p>To install binary packages, you first need to know from where
1721: to get them. The first place where you should look is on the main
1.10 hubertf 1722: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1723: <p>This directory contains binary packages for multiple
1724: platforms. First, select your operating system. (Ignore the
1725: directories with version numbers attached to it, they just exist for
1726: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1727: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1728: <p>In this directory, you often find a file called
1729: <code class="filename">bootstrap.tar.gz</code> which contains the package
1730: management tools. If the file is missing, it is likely that your
1731: operating system already provides those tools. Download the file and
1732: extract it in the <code class="filename">/</code> directory. It will create
1733: the directories <code class="filename">/usr/pkg</code> (containing the tools
1734: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1735: (the database of installed packages).</p>
1.1 dsieger 1736: </div>
1.41 asau 1737: <div class="sect2">
1.1 dsieger 1738: <div class="titlepage"><div><div><h3 class="title">
1739: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1740: <p>In the directory from the last section, there is a
1741: subdirectory called <code class="filename">All</code>, which contains all the
1742: binary packages that are available for the platform, excluding those
1743: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1744: medium you are using).</p>
1.9 rillig 1745: <p>To install packages directly from an FTP or HTTP server, run
1746: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1747: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1748: <pre class="screen">
1749: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1750: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All"</code></strong>
1751: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1752: </pre>
1753: <p>Instead of URLs, you can also use local paths, for example if
1754: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1755: repository. If you want to install packages from multiple sources,
1756: you can separate them by a semicolon in
1757: <code class="varname">PKG_PATH</code>.</p>
1758: <p>After these preparations, installing a package is very
1759: easy:</p>
1760: <pre class="screen">
1761: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1762: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1763: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1764: </pre>
1.1 dsieger 1765: <p>Note that any prerequisite packages needed to run the
1766: package in question will be installed, too, assuming they are
1767: present where you install from.</p>
1.23 wiz 1768: <p>Adding packages might install vulnerable packages.
1769: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1770: regularly, especially after installing new packages, and verify
1771: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1772: <p>After you've installed packages, be sure to have
1773: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1774: <code class="varname">PATH</code> so you can actually start the just
1775: installed program.</p>
1776: </div>
1.41 asau 1777: <div class="sect2">
1.1 dsieger 1778: <div class="titlepage"><div><div><h3 class="title">
1779: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1780: <p>To deinstall a package, it does not matter whether it was
1781: installed from source code or from a binary package. The
1.10 hubertf 1782: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1783: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1784: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1785: name can be given with or without version number. Wildcards can
1786: also be used to deinstall a set of packages, for example
1787: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1788: so that the shell does not expand them before
1789: <code class="literal">pkg_delete</code> sees them.</p>
1790: <p>The <code class="option">-r</code> option is very powerful: it
1791: removes all the packages that require the package in question
1792: and then removes the package itself. For example:
1793:
1794: </p>
1795: <pre class="screen">
1796: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1797: </pre>
1798: <p>
1799:
1800: will remove jpeg and all the packages that used it; this allows
1801: upgrading the jpeg package.</p>
1802: </div>
1.41 asau 1803: <div class="sect2">
1.1 dsieger 1804: <div class="titlepage"><div><div><h3 class="title">
1805: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1806: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1807: installed packages or binary package files.</p>
1808: </div>
1.41 asau 1809: <div class="sect2">
1.1 dsieger 1810: <div class="titlepage"><div><div><h3 class="title">
1811: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1812: <p>
1813: The NetBSD Security-Officer and Packages Groups maintain a list of
1814: known security vulnerabilities to packages which are (or have been)
1815: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1816: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1 dsieger 1817: </p>
1818: <p>
1.22 jakllsch 1819: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1820: this list can be downloaded
1821: automatically, and a security audit of all packages installed on a system
1822: can take place.
1823: </p>
1824: <p>
1.22 jakllsch 1825: There are two components to auditing. The first
1826: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1827: is for downloading
1.1 dsieger 1828: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1829: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1830: installed packages are vulnerable. If a package is vulnerable, you
1831: will see output similar to the following:
1832: </p>
1833: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1834: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1835: <p>
1.22 jakllsch 1836: You may wish to have the
1.10 hubertf 1837: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1838: file downloaded daily so that
1839: it remains current. This may be done by adding an appropriate entry
1.29 dholland 1840: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1841: </p>
1842: <pre class="screen">
1843: # download vulnerabilities file
1844: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1845: </pre>
1846: <p>
1847: will update the vulnerability list every day at 3AM. You may wish to do
1848: this more often than once a day.
1849:
1850: In addition, you may wish to run the package audit from the daily
1851: security script. This may be accomplished by adding the following
1852: line to <code class="filename">/etc/security.local</code>:
1853: </p>
1854: <pre class="screen">
1855: /usr/sbin/pkg_admin audit
1856: </pre>
1857: <p>
1.1 dsieger 1858: </p>
1859: </div>
1.41 asau 1860: <div class="sect2">
1.1 dsieger 1861: <div class="titlepage"><div><div><h3 class="title">
1862: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1863: <p>
1.12 weinem 1864: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1865: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1866: argument to check if your packages are up-to-date, e.g.
1867: </p>
1868: <pre class="screen">
1869: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1870: ...
1871: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1872: </pre>
1.10 hubertf 1873: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1874: package on your system and rebuild any dependencies.
1875: </p>
1876: </div>
1.41 asau 1877: <div class="sect2">
1.1 dsieger 1878: <div class="titlepage"><div><div><h3 class="title">
1879: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1880: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1881: administrative functions on the package system.</p>
1882: </div>
1.41 asau 1883: <div class="sect2">
1.1 dsieger 1884: <div class="titlepage"><div><div><h3 class="title">
1885: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1886: <p>Please pay very careful attention to the warnings
1.29 dholland 1887: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.1 dsieger 1888: inherent dangers of installing binary packages which you did
1889: not create yourself, and the security holes that can be
1890: introduced onto your system by indiscriminate adding of such
1891: files.</p>
1892: <p>The same warning of course applies to every package you
1893: install from source when you haven't completely read and
1894: understood the source code of the package, the compiler that
1895: is used to build the package and all the other tools that are
1896: involved.</p>
1897: </div>
1898: </div>
1.41 asau 1899: <div class="sect1">
1.1 dsieger 1900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1901: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1902: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1903: directory now contains a set of packages, organized into
1904: categories. You can browse the online index of packages, or run
1.10 hubertf 1905: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1906: directory to build local <code class="filename">README.html</code> files for
1907: all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1908: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1909: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1910: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1911: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1912: different <code class="varname">LOCALBASE</code> definitions on the same
1913: system (inside a chroot is an exception). </p>
1914: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1915: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1916: instructions how to create your own packages.</p>
1.41 asau 1917: <div class="sect2">
1.1 dsieger 1918: <div class="titlepage"><div><div><h3 class="title">
1919: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1920: <p>To build packages from source, you need a working C
1921: compiler. On NetBSD, you need to install the
1.23 wiz 1922: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1923: sets. If you want to build X11-related packages, the
1.23 wiz 1924: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1925: sets are required, too.</p>
1926: </div>
1.41 asau 1927: <div class="sect2">
1.1 dsieger 1928: <div class="titlepage"><div><div><h3 class="title">
1929: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1930: <p>The first step for building a package is downloading the
1931: distfiles (i.e. the unmodified source). If they have not yet been
1932: downloaded, pkgsrc will fetch them automatically.</p>
1933: <p>If you have all files that you need in the
1934: <code class="filename">distfiles</code> directory,
1935: you don't need to connect. If the distfiles are on CD-ROM, you can
1936: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1937: </p>
1938: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1939: <p>
1.10 hubertf 1940: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1941: <p>By default a list of distribution sites will be randomly
1942: intermixed to prevent huge load on servers which holding popular
1943: packages (for example, SourceForge.net mirrors). Thus, every
1944: time when you need to fetch yet another distfile all the mirrors
1945: will be tried in new (random) order. You can turn this feature
1946: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1947: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1948: <p>You can overwrite some of the major distribution sites to
1949: fit to sites that are close to your own. By setting one or two
1950: variables you can modify the order in which the master sites are
1951: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1952: delimited list of domain suffixes.
1953: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1954: contains a whitespace delimited list of regular expressions. It
1955: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1956: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1957: some examples. This may save some of your bandwidth and
1958: time.</p>
1959: <p>You can change these settings either in your shell's environment, or,
1960: if you want to keep the settings, by editing the
1.10 hubertf 1961: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1962: and adding the definitions there.</p>
1963: <p>
1964: If a package depends on many other packages (such as
1965: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1966: alternate between periods of
1967: downloading source, and compiling. To ensure you have all the source
1968: downloaded initially you can run the command:
1969: </p>
1970: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1971: <p>
1972: which will output and run a set of shell commands to fetch the
1973: necessary files into the <code class="filename">distfiles</code> directory. You can
1974: also choose to download the files manually.
1975: </p>
1976: </div>
1.41 asau 1977: <div class="sect2">
1.1 dsieger 1978: <div class="titlepage"><div><div><h3 class="title">
1979: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1980: <p>
1981: Once the software has downloaded, any patches will be applied, then it
1982: will be compiled for you. This may take some time depending on your
1983: computer, and how many other packages the software depends on and their
1984: compile time.
1985: </p>
1.41 asau 1986: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1987: <h3 class="title">Note</h3>
1988: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1989: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1990: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1991: </div>
1992: <p>For example, type</p>
1993: <pre class="screen">
1994: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1995: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1996: </pre>
1997: <p>at the shell prompt to build the various components of the
1998: package.</p>
1999: <p>The next stage is to actually install the newly compiled
2000: program onto your system. Do this by entering:
2001:
2002: </p>
2003: <pre class="screen">
2004: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2005: </pre>
2006: <p>
2007:
2008: while you are still in the directory for whatever package you
2009: are installing.</p>
2010: <p>Installing the package on your system may require you to
2011: be root. However, pkgsrc has a
2012: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2013: to only become root for the actual installation step.</p>
2014: <p>That's it, the software should now be installed and setup for use.
2015: You can now enter:
2016:
2017: </p>
2018: <pre class="screen">
2019: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2020: </pre>
2021: <p>
2022:
2023: to remove the compiled files in the work directory, as you shouldn't need
2024: them any more. If other packages were also added to your system
2025: (dependencies) to allow your program to compile, you can tidy these up
2026: also with the command:</p>
2027: <pre class="screen">
2028: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2029: </pre>
2030: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 2031: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 2032: <p>The program is installed under the default root of the
2033: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2034: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2035: variable in your environment, and it will use that value as the
2036: root of your packages tree. So, to use
2037: <code class="filename">/usr/local</code>, set
2038: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2039: Please note that you should use a directory which is dedicated to
2040: packages and not shared with other programs (i.e., do not try and
2041: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2042: to add any of your own files or directories (such as
2043: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2044: <code class="filename">pkgsrc/</code>) below the
2045: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2046: conflicts between programs and other files installed by the
2047: package system and whatever else may have been installed
2048: there.</p>
1.10 hubertf 2049: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2050: alter some configuration options at build time. Have a look at
2051: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2052: of what will be set there by default. Environment variables such
2053: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 2054: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2055: set them each time you want to use pkgsrc.</p>
1.23 wiz 2056: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2057: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 2058: or being installed. This may be for debugging purposes, or out of
2059: simple curiosity. A number of utility values have been added to
2060: help with this.</p>
1.23 wiz 2061: <div class="orderedlist"><ol class="orderedlist" type="1">
2062: <li class="listitem">
1.29 dholland 2063: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 2064: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2065: information will be displayed. For example,</p>
2066: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2067: <p>will show all the commands that are invoked, up to and
1.23 wiz 2068: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 2069: </li>
1.23 wiz 2070: <li class="listitem">
1.29 dholland 2071: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2072: definition, then the <code class="varname">VARNAME</code> definition
2073: should be used, in conjunction with the show-var
1.29 dholland 2074: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2075: variable <code class="varname">LOCALBASE</code>:</p>
2076: <pre class="screen">
2077: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2078: /usr/pkg
2079: <code class="prompt">%</code>
2080: </pre>
2081: </li>
2082: </ol></div>
2083: <p>If you want to install a binary package that you've either
2084: created yourself (see next section), that you put into
2085: pkgsrc/packages manually or that is located on a remote FTP
2086: server, you can use the "bin-install" target. This target will
1.29 dholland 2087: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 2088: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 2089: sites searched is kept in the variable
2090: <code class="varname">BINPKG_SITES</code>, which defaults to
1.29 dholland 2091: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 2092: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2093: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2094: details.</p>
2095: <p>A final word of warning: If you set up a system that has a
2096: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2097: set that before any packages are installed, as you cannot use
2098: several directories for the same purpose. Doing so will result in
2099: pkgsrc not being able to properly detect your installed packages,
2100: and fail miserably. Note also that precompiled binary packages are
2101: usually built with the default <code class="varname">LOCALBASE</code> of
2102: <code class="filename">/usr/pkg</code>, and that you should
2103: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2104: <code class="varname">LOCALBASE</code>.</p>
2105: </div>
2106: </div>
2107: </div>
1.41 asau 2108: <div class="chapter">
1.1 dsieger 2109: <div class="titlepage"><div><div><h2 class="title">
2110: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2111: <div class="toc">
2112: <p><b>Table of Contents</b></p>
2113: <dl>
2114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 2116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 2117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2118: <dd><dl>
1.4 rillig 2119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 2120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 2122: </dl></dd>
1.4 rillig 2123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2125: </dl>
2126: </div>
1.4 rillig 2127: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2128: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2129: that file depends on the installation. On NetBSD, when you use
1.29 dholland 2130: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 2131: <code class="filename">/etc/</code>. In all other cases the default location is
2132: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2133: bootstrap program to install the binary packages.</p>
2134: <p>During the bootstrap, an example configuration file is created. To
2135: use that, you have to create the directory
2136: <code class="filename">${PREFIX}/etc</code> and copy the example file
2137: there.</p>
2138: <p>The format of the configuration file is that of the usual
2139: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2140: is done by setting variables in this file. Note that you can define all
2141: kinds of variables, and no special error checking (for example for
2142: spelling mistakes) takes place, so you have to try it out to see if it
2143: works.</p>
1.41 asau 2144: <div class="sect1">
1.1 dsieger 2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2146: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2147: <p>In this section, you can find some variables that apply to all
2148: pkgsrc packages. A complete list of the variables that can be
2149: configured by the user is available in
2150: <code class="filename">mk/defaults/mk.conf</code>, together with some
2151: comments that describe each variable's intent.</p>
1.41 asau 2152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2153: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 2154: packages will be installed. The default is
2155: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2156: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 2157: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2158: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 2159: installed. The default is
2160: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 2161: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 2162: X11 is installed on the system. The default is
2163: <code class="filename">/usr/X11R6</code>.</p></li>
1.23 wiz 2164: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 2165: downloaded copies of the original source distributions used
2166: for building pkgsrc packages. The default is
2167: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 2168: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 2169: database about installed packages is stored. The default is
2170: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 2171: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 2172: If set, override the packages'
2173: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 2174: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 2175: Backup location(s) for distribution files and patch files
2176: if not found locally or in
2177: <code class="filename">${MASTER_SITES}</code> or
2178: <code class="filename">${PATCH_SITES}</code> respectively.
2179: The defaults are
1.25 spz 2180: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 2181: and
2182: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 2183: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 2184: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2185: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 2186: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2187: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2188: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 2189: List of acceptable licenses. License names are case-sensitive.
2190: Whenever you try to build a package whose license is not in this
2191: list, you will get an error message. If the license condition is
2192: simple enough, the error message will include specific
2193: instructions on how to change this variable.</p></li>
1.1 dsieger 2194: </ul></div>
2195: </div>
1.41 asau 2196: <div class="sect1">
1.1 dsieger 2197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2198: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2199: <p>XXX
2200: </p>
1.41 asau 2201: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2202: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 2203: directory for the binary packages. The default is
2204: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 2205: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 2206: The top level directory where, if defined, the separate
2207: working directories will get created, and symbolically
2208: linked to from <code class="filename">${WRKDIR}</code> (see below).
2209: This is useful for building packages on several
2210: architectures, then <code class="filename">${PKGSRCDIR}</code>
2211: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2212: is local to every architecture. (It should be noted that
2213: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 2214: — it is an internal definition which refers to the
1.1 dsieger 2215: root of the pkgsrc tree. It is possible to have many
2216: pkgsrc tree instances.)</p></li>
1.23 wiz 2217: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 2218: Directory for local patches that aren't part of pkgsrc.
1.10 hubertf 2219: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2220: information.</p></li>
1.23 wiz 2221: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 2222: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2223: BSD-style Makefile. If this is not set,
2224: <code class="varname">MAKECONF</code> is set to
2225: <code class="filename">/dev/null</code> to avoid picking up
2226: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 2227: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 2228: By default, dependencies are only installed, and no binary
2229: package is created for them. You can set this variable to
1.66 ! asau 2230: <code class="literal">package-install</code> to automatically create binary
1.1 dsieger 2231: packages after installing dependencies.</p></li>
2232: </ul></div>
2233: </div>
1.41 asau 2234: <div class="sect1">
1.1 dsieger 2235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 2236: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24 wiz 2237: <p>Most packages support installation into a
1.4 rillig 2238: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2239: to be built, before the actual filesystem is touched. DESTDIR
2240: support exists in two variations:</p>
1.41 asau 2241: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2242: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 2243: installation and packaging is still run as root.</p></li>
2244: <li class="listitem"><p>Full DESTDIR support can run the complete
2245: build, installation and packaging as normal user. Root
2246: privileges are only needed to add packages.</p></li>
2247: </ul></div>
2248: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2249: you can set
2250: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2251: so it's preferable to convert a package to DESTDIR instead.</p>
1.4 rillig 2252: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2253: clean</code></strong> needs to be run as root.</p>
1.17 imil 2254: <p>Considering the <code class="filename">foo/bar</code> package,
2255: DESTDIR full support can be tested using the following commands
2256:
2257: </p>
2258: <pre class="programlisting">
2259: <code class="prompt">$</code> id
2260: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2261: <code class="prompt">$</code> mkdir $HOME/packages
2262: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2263: </pre>
2264: <p>
2265:
2266: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2267: should be needed
2268:
2269: </p>
2270: <pre class="programlisting">
1.66 ! asau 2271: <code class="prompt">$</code> make stage-install
1.17 imil 2272: </pre>
2273: <p>
2274:
2275: Create a package without root privileges
2276:
2277: </p>
2278: <pre class="programlisting">
1.66 ! asau 2279: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 2280: </pre>
2281: <p>
2282:
2283: For the following command, you must be able to gain root
1.29 dholland 2284: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 2285:
2286: </p>
2287: <pre class="programlisting">
1.66 ! asau 2288: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 2289: </pre>
2290: <p>
2291:
2292: Then, as a simple user
2293:
2294: </p>
2295: <pre class="programlisting">
2296: <code class="prompt">$</code> make clean
2297: </pre>
2298: <p>
2299:
2300: </p>
1.4 rillig 2301: </div>
1.41 asau 2302: <div class="sect1">
1.4 rillig 2303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2304: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 2305: <div class="sect2">
1.1 dsieger 2306: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2307: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2308: <p>By default, pkgsrc will use GCC to build packages. This may be
2309: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 2310: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2311: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2312: <dd>
2313: <p>This is a list of values specifying the chain of
2314: compilers to invoke when building packages. Valid values
2315: are:</p>
1.41 asau 2316: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 ! asau 2317: <li class="listitem"><p><code class="varname">ccc</code>:
! 2318: Compaq C Compilers (Tru64)</p></li>
! 2319: <li class="listitem"><p><code class="varname">ccache</code>:
! 2320: compiler cache (chainable)</p></li>
! 2321: <li class="listitem"><p><code class="varname">clang</code>:
! 2322: Clang C and Objective-C compiler</p></li>
1.23 wiz 2323: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 2324: distributed C/C++ (chainable)</p></li>
1.66 ! asau 2325: <li class="listitem"><p><code class="varname">f2c</code>:
! 2326: Fortran 77 to C compiler (chainable)</p></li>
! 2327: <li class="listitem"><p><code class="varname">icc</code>:
! 2328: Intel C++ Compiler (Linux)</p></li>
! 2329: <li class="listitem"><p><code class="varname">ido</code>:
! 2330: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 2331: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 2332: GNU C/C++ Compiler</p></li>
1.66 ! asau 2333: <li class="listitem"><p><code class="varname">hp</code>:
! 2334: HP-UX C/aC++ compilers</p></li>
1.23 wiz 2335: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2336: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 ! asau 2337: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 2338: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 2339: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 2340: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 ! asau 2341: <li class="listitem"><p><code class="varname">xlc</code>:
! 2342: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 2343: </ul></div>
2344: <p>The default is
1.23 wiz 2345: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 2346: <code class="varname">ccache</code> and/or
2347: <code class="varname">distcc</code> with an appropriate
2348: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 2349: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 2350: variable should always be terminated with a value for
2351: a real compiler. Note that only one real compiler
1.23 wiz 2352: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 2353: is not allowed).</p>
2354: </dd>
2355: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2356: <dd><p>This specifies the minimum version of GCC to use
2357: when building packages. If the system GCC doesn't
2358: satisfy this requirement, then pkgsrc will build and
2359: install one of the GCC packages to use instead.</p></dd>
2360: </dl></div>
2361: </div>
1.41 asau 2362: <div class="sect2">
1.1 dsieger 2363: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2364: <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 2365: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2366: please make sure to use the <code class="literal">+=</code> operator
2367: instead of the <code class="literal">=</code> operator:</p>
2368: <pre class="programlisting">
2369: CFLAGS+= -your -flags
2370: </pre>
2371: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2372: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2373: need to add their own flags. You may want to take a look
2374: at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 2375: package if you're interested in optimization specifically
2376: for the current CPU. </p>
1.1 dsieger 2377: </div>
1.41 asau 2378: <div class="sect2">
1.1 dsieger 2379: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2380: <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 2381: <p>If you want to pass flags to the linker, both in the configure
2382: step and the build step, you can do this in two ways. Either set
2383: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2384: between the two is that <code class="varname">LIBS</code> will be appended to
2385: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2386: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2387: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2388: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2389: <code class="varname">CFLAGS</code>, if you do not wish to override these
2390: settings, use the <code class="literal">+=</code> operator:</p>
2391: <pre class="programlisting">
2392: LDFLAGS+= -your -linkerflags
2393: </pre>
2394: </div>
2395: </div>
1.41 asau 2396: <div class="sect1">
1.1 dsieger 2397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2398: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 2399: <p>XXX
2400: </p>
1.41 asau 2401: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2402: <li class="listitem">
1.1 dsieger 2403: <p><code class="varname">PKG_DEVELOPER</code>:
2404: Run some sanity checks that package developers want:
2405: </p>
1.41 asau 2406: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2407: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 2408: fuzz</p></li>
1.23 wiz 2409: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 2410: binaries will find their shared libs.</p></li>
2411: </ul></div>
2412: <p>
2413: </p>
2414: </li>
1.23 wiz 2415: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 2416: of debugging output which is displayed whilst making and
2417: installing the package. The default value for this is 0,
2418: which will not display the commands as they are executed
2419: (normal, default, quiet operation); the value 1 will display
2420: all shell commands before their invocation, and the value 2
2421: will display both the shell commands before their invocation,
1.10 hubertf 2422: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 2423: -x</strong></span> will be displayed.</p></li>
2424: </ul></div>
2425: <p>
2426: </p>
2427: </div>
1.41 asau 2428: <div class="sect1">
1.1 dsieger 2429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2430: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2431: <p>Some packages have build time options, usually to select
2432: between different dependencies, enable optional support for big
2433: dependencies or enable experimental features.</p>
2434: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2435: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2436: show-options</strong></span>, for example:</p>
2437: <pre class="programlisting">
2438: The following options are supported by this package:
2439: ssl Enable SSL support.
2440: Exactly one of the following gecko options is required:
2441: firefox Use firefox as gecko rendering engine.
2442: mozilla Use mozilla as gecko rendering engine.
2443: At most one of the following database options may be selected:
2444: mysql Enable support for MySQL database.
2445: pgsql Enable support for PostgreSQL database.
2446:
2447: These options are enabled by default: firefox
2448: These options are currently enabled: mozilla ssl
2449: </pre>
2450: <p>The following variables can be defined in
1.10 hubertf 2451: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2452: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2453: which can be used to select or disable options for all packages
2454: that support them, and
2455: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2456: which can be used to select or disable options specifically for
2457: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2458: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2459: are disabled. A few examples:</p>
2460: <pre class="screen">
1.10 hubertf 2461: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2462: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2463: PKG_OPTIONS.kdebase= debug -sasl
2464: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2465: <p>It is important to note that options that were specifically
1.18 snj 2466: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2467: you do not wish to include the option. If you are unsure you can view
2468: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2469: <p>The following settings are consulted in the order given, and
2470: the last setting that selects or disables an option is
2471: used:</p>
1.23 wiz 2472: <div class="orderedlist"><ol class="orderedlist" type="1">
2473: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2474: maintainer</p></li>
1.23 wiz 2475: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2476: variables (see below)</p></li>
1.23 wiz 2477: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2478: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2479: </ol></div>
2480: <p>For groups of mutually exclusive options, the last option
2481: selected is used, all others are automatically disabled. If an
2482: option of the group is explicitly disabled, the previously
2483: selected option, if any, is used. It is an error if no option
2484: from a required group of options is selected, and building the
2485: package will fail.</p>
2486: <p>Before the options framework was introduced, build options
2487: were selected by setting a variable (often named
2488: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2489: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2490: transition to the options framework for the user, these legacy
2491: variables are converted to the appropriate options setting
2492: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2493: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2494: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2495: directly. Support for the legacy variables will be removed
2496: eventually.</p>
2497: </div>
2498: </div>
1.41 asau 2499: <div class="chapter">
1.1 dsieger 2500: <div class="titlepage"><div><div><h2 class="title">
2501: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2502: <div class="toc">
2503: <p><b>Table of Contents</b></p>
2504: <dl>
2505: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2506: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2507: </dl>
2508: </div>
1.41 asau 2509: <div class="sect1">
1.1 dsieger 2510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2511: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2512: <p>Once you have built and installed a package, you can create
2513: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.29 dholland 2514: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2515: the same package on a group of hosts and wasting CPU time. It also
2516: provides a simple means for others to install your package, should
2517: you distribute it.</p>
2518: <p>To create a binary package, change into the appropriate
1.10 hubertf 2519: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2520: package</strong></span>:</p>
2521: <pre class="screen">
2522: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2523: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2524: </pre>
2525: <p>This will build and install your package (if not already done),
2526: and then build a binary package from what was installed. You can
1.10 hubertf 2527: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2528: it. Binary packages are created by default in
2529: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2530: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.1 dsieger 2531: continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.10 hubertf 2532: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2533: such a binary package.</p>
2534: </div>
1.41 asau 2535: <div class="sect1">
1.1 dsieger 2536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2537: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2538: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.6 rillig 2539: </div>
2540: </div>
1.41 asau 2541: <div class="chapter">
1.6 rillig 2542: <div class="titlepage"><div><div><h2 class="title">
2543: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2544: builds)</h2></div></div></div>
2545: <div class="toc">
2546: <p><b>Table of Contents</b></p>
2547: <dl>
2548: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2549: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
1.66 ! asau 2550: <dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
1.6 rillig 2551: <dd><dl>
1.66 ! asau 2552: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
! 2553: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
1.6 rillig 2554: </dl></dd>
1.66 ! asau 2555: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
! 2556: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2557: </dl>
2558: </div>
2559: <p>When you have multiple machines that should run the same packages,
2560: it is wasted time if they all build their packages themselves from
1.66 ! asau 2561: source. There is a ways of getting a set of binary packages:
! 2562: The bulk build system, or pbulk ("p" stands for "parallel).
! 2563: This chapter describes how to set it up so that the packages
1.6 rillig 2564: are most likely to be usable later.</p>
1.41 asau 2565: <div class="sect1">
1.6 rillig 2566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2567: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2568: <p>Since a bulk build takes several days or even weeks to finish, you
2569: should think about the setup before you start everything. Pay attention
2570: to at least the following points:</p>
1.41 asau 2571: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2572: <li class="listitem">
1.6 rillig 2573: <p>If you want to upload the binary packages to
2574: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2575: packages:</p>
1.41 asau 2576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2577: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.6 rillig 2578: by a NetBSD developer on a trusted machine (that is, where you and only
2579: you have root access).</p></li>
1.23 wiz 2580: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.21 snj 2581: the stable branches (like 2009Q1), so that users browsing the available
1.6 rillig 2582: collections can see at a glance how old the packages
2583: are.</p></li>
1.23 wiz 2584: <li class="listitem"><p>The packages must be built as root, since some packages
1.6 rillig 2585: require set-uid binaries at runtime, and creating those packages as
2586: unprivileged user doesn't work well at the moment.</p></li>
2587: </ul></div>
2588: </li>
1.23 wiz 2589: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.6 rillig 2590: your system. Most bulk builds run as root, so they should be run at least
2591: in a chroot environment or something even more restrictive, depending on
2592: what the operating system provides. There have been numerous cases where
2593: certain packages tried to install files outside the
2594: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2595: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2596: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2597: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2598: that you don't need any package during the build.</p></li>
2599: </ul></div>
2600: </div>
1.41 asau 2601: <div class="sect1">
1.6 rillig 2602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2603: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2604: <p>A complete bulk build requires lots of disk space. Some of the
2605: disk space can be read-only, some other must be writable. Some can be on
2606: remote filesystems (such as NFS) and some should be local. Some can be
2607: temporary filesystems, others must survive a sudden reboot.</p>
1.41 asau 2608: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.62 jnemeth 2609: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2610: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2611: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
1.23 wiz 2612: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
1.62 jnemeth 2613: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
1.23 wiz 2614: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.6 rillig 2615: </ul></div>
1.1 dsieger 2616: </div>
1.41 asau 2617: <div class="sect1">
1.1 dsieger 2618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 ! asau 2619: <a name="bulk.pbulk"></a>7.3. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2620: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2621: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2622: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2623: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2624: </ul></div>
1.41 asau 2625: <div class="sect2">
1.15 rillig 2626: <div class="titlepage"><div><div><h3 class="title">
1.66 ! asau 2627: <a name="bulk.pbulk.prepare"></a>7.3.1. Preparation</h3></div></div></div>
1.15 rillig 2628: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
2629: <pre class="screen">
2630: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2631: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2632: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2633: </pre>
2634: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
1.41 asau 2635: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2636: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2637: <li class="listitem"><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
2638: <li class="listitem"><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
2639: <li class="listitem"><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
2640: <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.15 rillig 2641: </ul></div>
2642: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2643: <pre class="screen">
2644: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2645: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2646: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2647: </pre>
2648: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
2649: </div>
1.41 asau 2650: <div class="sect2">
1.6 rillig 2651: <div class="titlepage"><div><div><h3 class="title">
1.66 ! asau 2652: <a name="bulk.pbulk.conf"></a>7.3.2. Configuration</h3></div></div></div>
1.14 jmcneill 2653: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.15 rillig 2654: <p>TODO: continue writing</p>
1.6 rillig 2655: </div>
2656: </div>
1.41 asau 2657: <div class="sect1">
1.6 rillig 2658: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 ! asau 2659: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2660: <p>After your pkgsrc bulk-build has completed, you may wish to
2661: create a CD-ROM set of the resulting binary packages to assist
2662: in installing packages on other machines. The
2663: <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
2664: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2665: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2666: way that keeps all the dependencies for a given package on the same
2667: CD as that package.</p>
1.41 asau 2668: <div class="sect2">
1.1 dsieger 2669: <div class="titlepage"><div><div><h3 class="title">
1.66 ! asau 2670: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2671: <p>Complete documentation for cdpack is found in the cdpack(1)
2672: man page. The following short example assumes that the binary
2673: packages are left in
2674: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2675: sufficient disk space exists in <code class="filename">/u2</code> to
2676: hold the ISO 9660 images.</p>
2677: <pre class="screen">
2678: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2679: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2680: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2681: </pre>
2682: <p>If you wish to include a common set of files
2683: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2684: etc.) on each CD in the collection, then you need to create a
2685: directory which contains these files. e.g.</p>
2686: <pre class="screen">
2687: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2688: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2689: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2690: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2691: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2692: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2693: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2694: </pre>
2695: <p>Now create the images:</p>
2696: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2697: <p>Each image will contain <code class="filename">README</code>,
2698: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2699: in their root directories.</p>
2700: </div>
2701: </div>
2702: </div>
1.41 asau 2703: <div class="chapter">
1.1 dsieger 2704: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2705: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2706: <div class="toc">
2707: <p><b>Table of Contents</b></p>
2708: <dl>
1.23 wiz 2709: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2710: <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 2711: </dl>
2712: </div>
2713: <p>The files that are installed by pkgsrc are organized in a way that
2714: is similar to what you find in the <code class="filename">/usr</code> directory
2715: of the base system. But some details are different. This is because
2716: pkgsrc initially came from FreeBSD and had adopted its file system
2717: hierarchy. Later it was largely influenced by NetBSD. But no matter
2718: which operating system you are using pkgsrc with, you can expect the
2719: same layout for pkgsrc.</p>
2720: <p>There are mainly four root directories for pkgsrc, which are all
2721: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2722: When pkgsrc has been installed as root, the default locations
2723: are:</p>
2724: <pre class="programlisting">
2725: LOCALBASE= /usr/pkg
2726: PKG_SYSCONFBASE= /usr/pkg/etc
2727: VARBASE= /var
2728: PKG_DBDIR= /var/db/pkg
2729: </pre>
2730: <p>In unprivileged mode (when pkgsrc has been installed as any other
2731: user), the default locations are:</p>
2732: <pre class="programlisting">
2733: LOCALBASE= ${HOME}/pkg
2734: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2735: VARBASE= ${HOME}/pkg/var
2736: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2737: </pre>
2738: <p>What these four directories are for, and what they look like is
2739: explained below.</p>
1.41 asau 2740: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2741: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2742: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2743: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2744: the well-known subdirectories like <code class="filename">bin</code>,
2745: <code class="filename">include</code>, <code class="filename">lib</code>,
2746: <code class="filename">share</code> and
2747: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2748: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2749: <code class="filename">/var</code> in the base system. Some programs (especially
2750: games, network daemons) need write access to it during normal
2751: operation.</p></li>
1.23 wiz 2752: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2753: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2754: 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 2755: itself.</p></li>
2756: </ul></div>
1.41 asau 2757: <div class="sect1">
1.1 dsieger 2758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2759: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2760: </h2></div></div></div>
2761: <p>The following directories exist in a typical pkgsrc installation
2762: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2763: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2764: <dt><span class="term"><code class="filename">bin</code></span></dt>
2765: <dd><p>Contains executable programs that are intended to be
2766: directly used by the end user.</p></dd>
2767: <dt><span class="term"><code class="filename">emul</code></span></dt>
2768: <dd><p>Contains files for the emulation layers of various other
2769: operating systems, especially for
2770: NetBSD.</p></dd>
2771: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2772: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2773: <dd><p>Contains
2774: the configuration files.</p></dd>
2775: <dt><span class="term"><code class="filename">include</code></span></dt>
2776: <dd><p>Contains headers for the C and C++ programming
2777: languages.</p></dd>
2778: <dt><span class="term"><code class="filename">info</code></span></dt>
2779: <dd><p>Contains GNU info files of various
2780: packages.</p></dd>
2781: <dt><span class="term"><code class="filename">lib</code></span></dt>
2782: <dd><p>Contains shared and static
2783: libraries.</p></dd>
2784: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2785: <dd><p>Contains data files that don't change after
2786: installation. Other data files belong into
2787: <code class="filename">${VARBASE}</code>.</p></dd>
2788: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2789: <dd><p>Contains programs that are not intended to be used by
2790: end users, such as helper programs or network
2791: daemons.</p></dd>
2792: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2793: <dd><p>Contains programs that are intended to be executed as
2794: CGI scripts by a web server.</p></dd>
2795: <dt><span class="term"><code class="filename">man</code> (the usual value of
2796: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2797: <dd><p>Contains brief
2798: documentation in form of manual pages.</p></dd>
2799: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2800: <dd><p>Contains programs that are intended to be used only by
2801: the super-user.</p></dd>
2802: <dt><span class="term"><code class="filename">share</code></span></dt>
2803: <dd><p>Contains platform-independent data files that don't
2804: change after installation.</p></dd>
2805: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2806: <dd><p>Contains documentation files provided by the
2807: packages.</p></dd>
2808: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2809: <dd><p>Contains example files provided by the packages. Among
2810: others, the original configuration files are saved here and copied to
2811: <code class="filename">${PKG_SYSCONFDIR}</code> during
2812: installation.</p></dd>
2813: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2814: <dd><p>Contains the original files for rc.d
2815: scripts.</p></dd>
2816: <dt><span class="term"><code class="filename">var</code> (the usual location of
2817: <code class="filename">${VARBASE}</code>)</span></dt>
2818: <dd><p>Contains files
2819: that may be modified after
2820: installation.</p></dd>
2821: </dl></div>
2822: </div>
1.41 asau 2823: <div class="sect1">
1.1 dsieger 2824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2825: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2826: </h2></div></div></div>
1.41 asau 2827: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2828: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2829: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2830: <dd><p>Contains
2831: information about the currently installed
2832: packages.</p></dd>
2833: <dt><span class="term"><code class="filename">games</code></span></dt>
2834: <dd><p>Contains highscore
2835: files.</p></dd>
2836: <dt><span class="term"><code class="filename">log</code></span></dt>
2837: <dd><p>Contains log files.</p></dd>
2838: <dt><span class="term"><code class="filename">run</code></span></dt>
2839: <dd><p>Contains informational files about daemons that are
2840: currently running.</p></dd>
2841: </dl></div>
2842: </div>
2843: </div>
1.41 asau 2844: <div class="chapter">
1.1 dsieger 2845: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2846: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2847: <div class="toc">
2848: <p><b>Table of Contents</b></p>
2849: <dl>
1.6 rillig 2850: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2851: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
2852: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
2853: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
2854: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
2855: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2856: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.65 wiz 2857: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
2858: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2859: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
2860: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2861: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.65 wiz 2862: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
2863: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
2864: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
2865: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
2866: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2867: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
2868: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 2869: </dl>
2870: </div>
2871: <p>This section contains hints, tips & tricks on special things in
2872: pkgsrc that we didn't find a better place for in the previous chapters, and
2873: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2874: <div class="sect1">
1.1 dsieger 2875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2876: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2877: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2878: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2879: <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 2880: This is a general purpose list for most issues regarding
2881: pkgsrc, regardless of platform, e.g. soliciting user help
2882: for pkgsrc configuration, unexpected build failures, using
2883: particular packages, upgrading pkgsrc installations,
2884: questions regarding the pkgsrc release branches, etc. General announcements or
2885: proposals for changes that impact the pkgsrc user community,
2886: e.g. major infrastructure changes, new features, package
2887: removals, etc., may also be posted.</p></li>
1.23 wiz 2888: <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 2889: A list where the results of pkgsrc bulk builds are sent and
2890: discussed.</p></li>
1.23 wiz 2891: <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 2892: This list is for those who are interested in getting a
2893: commit message for every change committed to pkgsrc. It is
2894: also available in digest form, meaning one daily message
2895: containing all commit messages for changes to the package
2896: source tree in that 24 hour period.</p></li>
2897: </ul></div>
2898: <p>To subscribe, do:</p>
2899: <pre class="programlisting">
2900: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2901: </pre>
2902: <p>Archives for all these mailing lists are available from
1.10 hubertf 2903: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2904: </div>
1.41 asau 2905: <div class="sect1">
1.1 dsieger 2906: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2907: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1 dsieger 2908: <p>Pkgviews is tightly integrated with buildlink. You can find a
2909: pkgviews User's guide in
2910: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
2911: </div>
1.41 asau 2912: <div class="sect1">
1.1 dsieger 2913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2914: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2915: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2916: a number of useful utilities for both users and developers of pkgsrc. This
2917: section attempts only to make the reader aware of the utilities and when
2918: they might be useful, and not to duplicate the documentation that comes
2919: with each package.</p>
2920: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.41 asau 2921: <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 2922: Symlinks for use by buildlink.</p></li></ul></div>
2923: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2925: <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 2926: Calculates various kinds of checksums (including SHA1).</p></li>
1.23 wiz 2927: <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 2928: Compatibility library for pkgsrc tools.</p></li>
1.23 wiz 2929: <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 2930: non-BSD systems due to lack of native mtree.</p></li>
1.23 wiz 2931: <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 2932: Up-to-date replacement for
2933: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2934: systems where pkg_install is not present.</p></li>
2935: </ul></div>
2936: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2937: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2938: <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 2939: Create a binary package from an
1.10 hubertf 2940: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2941: save the old package.</p></li>
1.23 wiz 2942: <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 2943: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2944: from multiple locations. It currently supports the following
2945: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.23 wiz 2946: <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 2947: the best compiler flags to optimise code for your current
1.23 wiz 2948: CPU and compiler. </p></li>
1.1 dsieger 2949: </ul></div>
2950: <p>Utilities for keeping track of installed packages, being up to date,
2951: etc:</p>
1.41 asau 2952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.65 wiz 2953: <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
2954: update tool similar to apt(1). Download, install, and upgrade
2955: binary packages easily.</p></li>
1.23 wiz 2956: <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 2957: packages whose installed versions do not match the latest pkgsrc
2958: entries.</p></li>
1.23 wiz 2959: <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 2960: dependency graphs of packages, to aid in choosing a strategy for
2961: updating.</p></li>
1.23 wiz 2962: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
1.1 dsieger 2963: graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
1.23 wiz 2964: <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 2965: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.23 wiz 2966: <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 2967: does various checks on the complete pkgsrc system.</p></li>
1.23 wiz 2968: <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 2969: packages you have installed.</p></li>
2970: </ul></div>
2971: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2972: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2973: <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 2974: making and maintaining patches for a package (includes pkgdiff,
2975: pkgvi, mkpatches, etc.).</p></li>
1.65 wiz 2976: <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 2977: converting to pkgsrc.</p></li>
2978: </ul></div>
2979: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2980: utilities)</p>
1.41 asau 2981: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2982: <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 2983: packages in a chrooted area.</p></li>
1.23 wiz 2984: <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 2985: kernel version for chrooted cross builds.</p></li>
2986: </ul></div>
2987: </div>
1.41 asau 2988: <div class="sect1">
1.1 dsieger 2989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2990: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 2991: <p>If you want to use pkgsrc as non-root user, you can set some
2992: variables to make pkgsrc work under these conditions. At the very least,
1.23 wiz 2993: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.1 dsieger 2994: will turn on unprivileged mode and set multiple related variables to allow
2995: installation of packages as non-root.</p>
2996: <p>In case the defaults are not enough, you may want to tune some other
2997: variables used. For example, if the automatic user/group detection leads
2998: to incorrect values (or not the ones you would like to use), you can change
2999: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3000: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3001: <p>As regards bootstrapping, please note that the
1.10 hubertf 3002: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23 wiz 3003: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.1 dsieger 3004: use multiple default directories under <code class="filename">~/pkg</code> as the
3005: installation targets. These directories can be overridden by the
1.23 wiz 3006: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.1 dsieger 3007: that allow finer tuning of the tree layout.</p>
3008: </div>
1.41 asau 3009: <div class="sect1">
1.1 dsieger 3010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3011: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3012: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3013: enable this feature by adding the option
3014: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 3015: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3016: distfile is found, pkgsrc will try to resume it.</p>
3017: <p>You can also
1.61 wiz 3018: use a different program than the platform default program by changing the
1.16 jnemeth 3019: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3020: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3021: by using the value manual. A value of custom disables the system defaults
3022: and dependency tracking for the fetch program. In that case you have to
3023: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3024: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3025: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 3026: <p>For example, if you want to use
1.16 jnemeth 3027: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 3028: like:</p>
3029: <pre class="programlisting">
1.16 jnemeth 3030: FETCH_USING= wget
1.1 dsieger 3031: </pre>
3032: </div>
1.41 asau 3033: <div class="sect1">
1.1 dsieger 3034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3035: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 3036: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3037: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3038: you will have to add the following line into
1.10 hubertf 3039: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3040: <pre class="programlisting">
1.4 rillig 3041: X11_TYPE=modular
1.1 dsieger 3042: </pre>
1.41 asau 3043: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 3044: <h3 class="title">Note</h3>
1.4 rillig 3045: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3046: </p>
1.1 dsieger 3047: </div>
3048: </div>
1.41 asau 3049: <div class="sect1">
1.1 dsieger 3050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3051: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3052: <p>If you are sitting behind a firewall which does not allow direct
3053: connections to Internet hosts (i.e. non-NAT), you may specify the
3054: relevant proxy hosts. This is done using an environment variable in the
3055: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 3056: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3057: port 80 as the proxy port number. So the proxy environment variables
3058: are:</p>
3059: <pre class="programlisting">
3060: ftp_proxy=ftp://orpheus.amdahl.com:80/
3061: http_proxy=http://orpheus.amdahl.com:80/
3062: </pre>
3063: </div>
1.41 asau 3064: <div class="sect1">
1.1 dsieger 3065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3066: <a name="fetch-https"></a>9.8. How to fetch files from HTTPS sites</h2></div></div></div>
3067: <p>Some fetch tools are not prepared to support HTTPS by default
3068: (for example, the one in NetBSD 6.0), or the one installed by the
3069: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3070: dependency graph).</p>
3071: <p>Usually you won't notice, because distribution files are
3072: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3073: be often enough if you are following pkgsrc-current. In that case, set
3074: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3075: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3076: with HTTPS support by default. Of course, these tools need to be
3077: installed before you can use them this way.</p>
3078: </div>
3079: <div class="sect1">
3080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3081: <a name="passive-ftp"></a>9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 3082: <p>This depends on which utility is used to retrieve distfiles. From
3083: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3084: the first available command from the following list:</p>
1.41 asau 3085: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3086: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3087: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3088: </ul></div>
3089: <p>On a default NetBSD installation, this will be
3090: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3091: connections first, and falls back to active connections if the server
3092: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3093: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3094: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3095: <p>Having that option present will prevent
3096: <code class="filename">/usr/bin/ftp</code> from falling back to active
3097: transfers.</p>
3098: </div>
1.41 asau 3099: <div class="sect1">
1.1 dsieger 3100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3101: <a name="fetching-all-distfiles"></a>9.10. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3102: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3103: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3104: 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 3105: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3106: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3107: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3108: resulting list to your machine at work/school and use it there. If you
1.29 dholland 3109: 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 3110: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3111: URL:</p>
3112: <p>At home:</p>
3113: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3114: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3115: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3116: <p>At work:</p>
3117: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3118: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3119: home.</p>
3120: <p>If you have a machine running NetBSD, and you want to get
3121: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3122: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3123: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3124: directly by running:</p>
3125: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3126: <p>If you even decide to ignore
3127: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3128: by running:</p>
3129: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3130: </div>
1.41 asau 3131: <div class="sect1">
1.1 dsieger 3132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3133: <a name="tmac.andoc-missing"></a>9.11. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 3134: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3135: <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>
3136: package, you get the error from make that it doesn't know how to make
3137: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3138: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3139: the NetBSD base distribution on your machine. It is recommended to do
3140: that to format man pages.</p>
3141: <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
3142: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3143: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3144: </div>
1.41 asau 3145: <div class="sect1">
1.1 dsieger 3146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3147: <a name="bsd.own.mk-missing"></a>9.12. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3148: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3149: when you installed your NetBSD machine. Please get and install it, by
3150: extracting it in <code class="filename">/</code>:</p>
3151: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3152: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3153: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3154: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3155: -r</strong></span>).</p>
3156: </div>
1.41 asau 3157: <div class="sect1">
1.1 dsieger 3158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3159: <a name="using-sudo-with-pkgsrc"></a>9.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3160: <p>When installing packages as non-root user and using the just-in-time
1.29 dholland 3161: <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 3162: password for each required package installed. To avoid this, the sudo
3163: package can be used, which does password caching over a limited time. To
3164: use it, install sudo (either as binary package or from
3165: <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 3166: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3167: <span class="emphasis"><em>after</em></span> the definition of the
3168: <code class="varname">LOCALBASE</code> variable:</p>
3169: <pre class="programlisting">
3170: .if exists(${LOCALBASE}/bin/sudo)
3171: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3172: .endif
3173: </pre>
3174: </div>
1.41 asau 3175: <div class="sect1">
1.1 dsieger 3176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3177: <a name="faq.conf"></a>9.14. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3178: <p>As the system administrator, you can choose where configuration files
3179: are installed. The default settings make all these files go into
3180: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3181: be suboptimal depending on your expectations (e.g., a read-only,
3182: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3183: configuration of the provided packages).</p>
3184: <p>In order to change the defaults, you can modify the
3185: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3186: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3187: directory; some common examples include <code class="filename">/etc</code> or
3188: <code class="filename">/etc/pkg</code>.</p>
3189: <p>Furthermore, you can change this value on a per-package basis by
3190: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3191: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3192: package you would like to modify, that is, the contents of
3193: <code class="varname">PKGBASE</code>.</p>
3194: <p>Note that after changing these settings, you must rebuild and
3195: reinstall any affected packages.</p>
3196: </div>
1.41 asau 3197: <div class="sect1">
1.1 dsieger 3198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3199: <a name="audit-packages"></a>9.15. Automated security checks</h2></div></div></div>
1.1 dsieger 3200: <p>Please be aware that there can often be bugs in third-party software,
3201: and some of these bugs can leave a machine vulnerable to exploitation by
3202: attackers. In an effort to lessen the exposure, the NetBSD packages team
3203: maintains a database of known-exploits to packages which have at one time
3204: been included in pkgsrc. The database can be downloaded automatically, and
3205: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3206: do this, refer to the following two tools (installed as part of the
3207: <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 3208: <div class="orderedlist"><ol class="orderedlist" type="1">
3209: <li class="listitem">
1.20 snj 3210: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3211: download a list of the security vulnerabilities information. This list
1.25 spz 3212: is kept up to date by the pkgsrc security team, and is distributed
3213: from the NetBSD ftp server:</p>
3214: <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 3215: </li>
1.23 wiz 3216: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3217: current machine, checking each known vulnerability. If a
1.1 dsieger 3218: vulnerable package is installed, it will be shown by output to stdout,
3219: including a description of the type of vulnerability, and a URL
3220: containing more information.</p></li>
3221: </ol></div>
1.14 jmcneill 3222: <p>Use of these tools is strongly recommended! After
1.23 wiz 3223: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 3224: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 3225: pkg_install</code></strong>.</p>
1.1 dsieger 3226: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 3227: 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 3228: check.</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.65 wiz 3232: <a name="ufaq-cflags"></a>9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3233: <p>When you add your own preferences to the
3234: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3235: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3236: environment variables to the <code class="filename">./configure</code>
1.29 dholland 3237: 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 3238: <code class="varname">CFLAGS</code> from the environment variable by
3239: overriding them in the <code class="filename">Makefile</code>s of their
3240: package.</p>
3241: <p>Currently there is no solution to this problem. If you
3242: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3243: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3244: directory and then inspect any <code class="filename">Makefile</code> and
3245: <code class="filename">Makefile.in</code> for whether they define
3246: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3247: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3248: programmers write so bad code that it only works for the
3249: specific combination of <code class="varname">CFLAGS</code> they have
3250: chosen.</p>
3251: </div>
1.41 asau 3252: <div class="sect1">
1.1 dsieger 3253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3254: <a name="ufaq-fail"></a>9.17. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3255: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3256: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3257: case that occurs often is that people only update pkgsrc in
3258: parts, because of performance reasons. Since pkgsrc is one large
3259: system, not a collection of many small systems, there are
3260: sometimes changes that only work when the whole pkgsrc tree is
3261: updated.</p></li>
1.41 asau 3262: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3263: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3264: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3265: files.</p></li>
1.41 asau 3266: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3267: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3268: verify this.</p></li>
1.41 asau 3269: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3270: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3271: </ol></div>
3272: </div>
1.41 asau 3273: <div class="sect1">
1.1 dsieger 3274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3275: <a name="faq.rcs-conflicts"></a>9.18. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3276: <p>You have modified a file from pkgsrc, and someone else has
3277: modified that same file afterwards in the CVS repository. Both changes
3278: are in the same region of the file, so when you updated pkgsrc, the
3279: <code class="literal">cvs</code> command marked the conflicting changes in the
3280: file. Because of these markers, the file is no longer a valid
3281: <code class="filename">Makefile</code>.</p>
3282: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3283: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3284: -dP</strong></span> in that directory to download the current version.</p>
3285: </div>
3286: </div>
3287: </div>
1.41 asau 3288: <div class="part">
1.1 dsieger 3289: <div class="titlepage"><div><div><h1 class="title">
3290: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3291: <div class="partintro">
1.1 dsieger 3292: <div></div>
3293: <p>This part of the book deals with creating and
1.23 wiz 3294: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3295: guide on creating a new package. The remaining chapters are more
3296: like a reference manual for pkgsrc.</p>
3297: <div class="toc">
3298: <p><b>Table of Contents</b></p>
3299: <dl>
1.6 rillig 3300: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3301: <dd><dl>
1.6 rillig 3302: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3303: <dd><dl>
1.6 rillig 3304: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 ! asau 3305: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3306: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3307: </dl></dd>
1.6 rillig 3308: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3309: <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>
3310: </dl></dd>
3311: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3312: <dd><dl>
1.23 wiz 3313: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3314: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3315: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3316: <dd><dl>
3317: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3318: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3319: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3320: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3321: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3322: </dl></dd>
3323: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3324: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3325: <dd><dl>
3326: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3327: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3328: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3329: </dl></dd>
1.23 wiz 3330: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3331: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3332: </dl></dd>
1.23 wiz 3333: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3334: <dd><dl>
3335: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 3336: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 3337: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3338: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3339: <dd><dl>
3340: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3341: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3342: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3343: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3344: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3345: </dl></dd>
3346: </dl></dd>
3347: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3348: <dd><dl>
3349: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 3350: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3351: <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 3352: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3353: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 3354: <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 3355: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3356: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3357: </dl></dd>
3358: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3359: <dd><dl>
3360: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 3361: <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 3362: <dd><dl>
3363: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 3364: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3365: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3366: and
3367: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3368: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3369: </dl></dd>
1.23 wiz 3370: <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 3371: <dd><dl>
1.23 wiz 3372: <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 3373: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3374: </dl></dd>
3375: </dl></dd>
3376: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3377: <dd><dl>
3378: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3379: <dd><dl>
3380: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3381: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3382: </dl></dd>
3383: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3384: <dd><dl>
1.23 wiz 3385: <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 3386: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3387: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3388: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3389: </dl></dd>
3390: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3391: <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>
3392: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3393: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3394: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3395: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3396: <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>
3397: </dl></dd>
3398: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3399: <dd><dl>
3400: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 3401: <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 3402: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3403: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3404: </dl></dd>
3405: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3406: <dd><dl>
3407: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3408: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3409: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3410: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 3411: <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 3412: <dd><dl>
3413: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3414: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3415: </dl></dd>
1.23 wiz 3416: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3417: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3418: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3419: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3420: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3421: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3422: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3423: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3424: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3425: <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 3426: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3427: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3428: </dl></dd>
3429: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3430: <dd><dl>
3431: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3432: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3433: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3434: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3435: </dl></dd>
3436: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3437: <dd><dl>
3438: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3439: <dd><dl>
3440: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 3441: <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 3442: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3443: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3444: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3445: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3446: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3447: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3448: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3449: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3450: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3451: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3452: </dl></dd>
1.23 wiz 3453: <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 3454: <dd><dl>
3455: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3456: <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>
3457: </dl></dd>
1.23 wiz 3458: <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 3459: <dd><dl>
3460: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3461: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3462: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3463: </dl></dd>
3464: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3465: <dd><dl>
3466: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3467: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3468: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 3469: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3470: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 3471: </dl></dd>
1.23 wiz 3472: <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 3473: <dd><dl>
3474: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3475: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 3476: <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 3477: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3478: </dl></dd>
1.23 wiz 3479: <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 3480: <dd><dl>
3481: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3482: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3483: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3484: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3485: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3486: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3487: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3488: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3489: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 3490: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 3491: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3492: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3493: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3494: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3495: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3496: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3497: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3498: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3499: emulation</a></span></dt>
1.6 rillig 3500: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3501: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3502: </dl></dd>
1.6 rillig 3503: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3504: </dl></dd>
1.6 rillig 3505: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3506: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3507: <dd><dl>
1.6 rillig 3508: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3509: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3510: <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 3511: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 3512: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 3513: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3514: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 3515: </dl></dd>
3516: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3517: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3518: <dd><dl>
3519: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3520: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3521: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3522: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3523: </dl></dd>
3524: </dl>
3525: </div>
3526: </div>
1.41 asau 3527: <div class="chapter">
1.1 dsieger 3528: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3529: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3530: <div class="toc">
3531: <p><b>Table of Contents</b></p>
3532: <dl>
1.6 rillig 3533: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3534: <dd><dl>
1.6 rillig 3535: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 ! asau 3536: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3537: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3538: </dl></dd>
1.6 rillig 3539: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3540: <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 3541: </dl>
3542: </div>
3543: <p>When you find a package that is not yet in pkgsrc, you
3544: most likely have a URL from where you can download the source
3545: code. Starting with this URL, creating a package involves only a
3546: few steps.</p>
1.23 wiz 3547: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3548: <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>
3549: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3550: category in which you want to place your package. You can also create a
3551: directory of your own (maybe called <code class="filename">local</code>). In that
3552: category directory, create another directory for your package and change
3553: into it.</p></li>
1.41 asau 3554: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3555: you for a URL. Enter the URL of the distribution file (in most cases a
3556: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3557: of your package are created automatically. The distribution file is
3558: extracted automatically to fill in some details in the
3559: <code class="filename">Makefile</code> that would otherwise have to be done
3560: manually.</p></li>
1.41 asau 3561: <li class="step">
1.1 dsieger 3562: <p>Examine the extracted files to determine the dependencies of
3563: your package. Ideally, this is mentioned in some
3564: <code class="filename">README</code> file, but things may differ. For each of
3565: these dependencies, look where it exists in pkgsrc, and if there is a
3566: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3567: line to your package <code class="filename">Makefile</code> which includes that
3568: file just before the last line. If the
1.25 spz 3569: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3570: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3571: <p>If you just need binaries from a package, add a
1.1 dsieger 3572: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3573: version of the dependency and where it can be found in pkgsrc. This line
3574: should be placed in the third paragraph. If the dependency is only
3575: needed for building the package, but not when using it, use
3576: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3577: Your package may then look like this:</p>
3578: <pre class="programlisting">
3579: [...]
3580:
1.66 ! asau 3581: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3582: DEPENDS+= screen-[0-9]*:../../misc/screen
3583: DEPENDS+= screen>=4.0:../../misc/screen
3584:
3585: [...]
3586:
3587: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3588: .include "../../devel/glib2/buildlink3.mk"
3589: .include "../../mk/bsd.pkg.mk"
3590: </pre>
3591: </li>
1.41 asau 3592: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3593: 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 3594: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3595: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3596: -e</strong></span>, which outputs additional
3597: explanations.</p></li>
1.41 asau 3598: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3599: 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 3600: over there, you can hopefully continue here.</p></li>
1.41 asau 3601: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3602: directory from the extracted files. Besides these files, a lot of cache
3603: files and other system information has been saved in the working
3604: directory, which may become wrong after you edited the
3605: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3606: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3607: 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 3608: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3609: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3610: everything works.</p></li>
1.41 asau 3611: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3612: contains a list of the files that are installed by the package, is
1.10 hubertf 3613: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3614: >PLIST</strong></span> to generate a probably correct list. Check
3615: the file using your preferred text editor to see if the list of
3616: files looks plausible.</p></li>
1.41 asau 3617: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3618: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3619: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3620: has been registered in the database of installed files, but with an
1.10 hubertf 3621: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3622: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3623: registered with the list of files from
3624: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3625: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3626: package from the set of installed files.</p></li>
3627: </ol></div>
1.41 asau 3628: <div class="sect1">
1.1 dsieger 3629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3630: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3631: <div class="sect2">
1.1 dsieger 3632: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3633: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3634: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3635: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3636: </div>
1.41 asau 3637: <div class="sect2">
1.1 dsieger 3638: <div class="titlepage"><div><div><h3 class="title">
1.66 ! asau 3639: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
! 3640: <p>KDE3 applications should always include
1.1 dsieger 3641: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 ! asau 3642: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3643: </div>
1.41 asau 3644: <div class="sect2">
1.17 imil 3645: <div class="titlepage"><div><div><h3 class="title">
3646: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3647: <p>Python modules and programs packages are easily created using a
3648: set of predefined variables.</p>
3649: <p>
1.63 wiz 3650: If some Python versions are not supported by the software, set the
3651: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3652: that are not supported, e.g.
1.17 imil 3653: </p>
3654: <pre class="programlisting">
1.64 wiz 3655: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.17 imil 3656: </pre>
3657: <p>
3658: If the packaged software is a Python module, include
1.23 wiz 3659: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.17 imil 3660: In this case, the package directory should be called
1.23 wiz 3661: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3662: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3663: </p>
3664: <pre class="programlisting">
3665: DISTNAME= foopymodule-1.2.10
3666: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3667: </pre>
1.63 wiz 3668: <p>If it is an application, include
3669: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3670: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3671: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3672: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3673: For example:
1.17 imil 3674: </p>
3675: <pre class="programlisting">
1.35 wiz 3676: REPLACE_PYTHON= *.py
1.17 imil 3677: </pre>
1.63 wiz 3678: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3679: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3680: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3681: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3682: so pkgsrc will use this framework.
3683: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3684: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3685: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3686: to the name of the script.</p>
3687: <p>Otherwise, if the packaged software is egg-aware, you only need
3688: to include
3689: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3690: <p>Some Python modules have separate distributions for Python-2.x
3691: and Python-3.x support. In pkgsrc this is handled by the
3692: <code class="filename">versioned_dependencies.mk</code> file. Set
3693: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3694: packages that should be depended upon and include
3695: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3696: then the pkgsrc infrastructure will depend on the appropriate package
3697: version. For example:
3698: </p>
3699: <pre class="programlisting">
3700: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3701: </pre>
3702: <p>
3703: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3704: of supported packages.</p>
1.17 imil 3705: </div>
1.1 dsieger 3706: </div>
1.41 asau 3707: <div class="sect1">
1.1 dsieger 3708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3709: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3710: <div class="sect2">
1.1 dsieger 3711: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3712: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3713: <div class="sect3">
1.1 dsieger 3714: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3715: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3716: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3717: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3718: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3719: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3720: <pre class="programlisting">
3721: <code class="prompt">$</code> mkdir www/nvu
3722: <code class="prompt">$</code> cd www/nvu
3723: </pre>
3724: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3725: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3726: <pre class="programlisting">
3727: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3728: </pre>
3729: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3730: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3731: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3732: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3733: <code class="varname">COMMENT</code> fields. Then the package
3734: <code class="filename">Makefile</code> looked like that:</p>
3735: <pre class="programlisting">
3736: # $NetBSD$
3737: #
3738:
3739: DISTNAME= nvu-1.0-sources
3740: PKGNAME= nvu-1.0
3741: CATEGORIES= www
3742: MASTER_SITES= http://cvs.nvu.com/download/
3743: EXTRACT_SUFX= .tar.bz2
3744:
3745: MAINTAINER= rillig@NetBSD.org
3746: HOMEPAGE= http://cvs.nvu.com/
3747: COMMENT= Web Authoring System
3748:
3749: # url2pkg-marker (please do not remove this line.)
3750: .include "../../mk/bsd.pkg.mk"
3751: </pre>
3752: <p>Then, I quit the editor and watched pkgsrc downloading a large
3753: source archive:</p>
3754: <pre class="programlisting">
3755: url2pkg> Running "make makesum" ...
3756: => Required installed package digest>=20010302: digest-20060826 found
3757: => Fetching nvu-1.0-sources.tar.bz2
3758: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3759: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3760: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3761: url2pkg> Running "make extract" ...
3762: => Required installed package digest>=20010302: digest-20060826 found
3763: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3764: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3765: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3766: ===> Installing dependencies for nvu-1.0
3767: ===> Overriding tools for nvu-1.0
3768: ===> Extracting for nvu-1.0
3769: url2pkg> Adjusting the Makefile.
3770:
3771: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3772:
3773: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3774: </pre>
3775: </div>
1.41 asau 3776: <div class="sect3">
1.1 dsieger 3777: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3778: <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 3779: <p>Now that the package has been extracted, let's see what's inside
3780: it. The package has a <code class="filename">README.txt</code>, but that only
3781: says something about mozilla, so it's probably useless for seeing what
3782: dependencies this package has. But since there is a GNU configure script
3783: in the package, let's hope that it will complain about everything it
3784: needs.</p>
3785: <pre class="programlisting">
3786: <code class="prompt">$</code> bmake
3787: => Required installed package digest>=20010302: digest-20060826 found
3788: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3789: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3790: ===> Patching for nvu-1.0
3791: ===> Creating toolchain wrappers for nvu-1.0
3792: ===> Configuring for nvu-1.0
3793: [...]
3794: configure: error: Perl 5.004 or higher is required.
3795: [...]
3796: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3797: [...]
3798: </pre>
3799: <p>That worked quite well. So I opened the package Makefile in my
3800: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3801: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3802: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3803: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3804: from scratch.</p>
3805: <pre class="programlisting">
3806: <code class="prompt">$</code> bmake clean
3807: ===> Cleaning for nvu-1.0
3808: <code class="prompt">$</code> bmake
3809: [...]
3810: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3811: GNU Make. You will not be able to build Mozilla without GNU Make.
3812: [...]
3813: </pre>
1.23 wiz 3814: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3815: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3816: <pre class="programlisting">
3817: [...]
3818: checking for GTK - version >= 1.2.0... no
3819: *** Could not run GTK test program, checking why...
3820: [...]
3821: </pre>
3822: <p>Now to the other dependencies. The first question is: Where is the
3823: GTK package hidden in pkgsrc?</p>
3824: <pre class="programlisting">
3825: <code class="prompt">$</code> echo ../../*/gtk*
3826: [many packages ...]
3827: <code class="prompt">$</code> echo ../../*/gtk
3828: ../../x11/gtk
3829: <code class="prompt">$</code> echo ../../*/gtk2
3830: ../../x11/gtk2
3831: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3832: ../../x11/gtk2/buildlink3.mk
3833: </pre>
3834: <p>The first try was definitely too broad. The second one had exactly
3835: one result, which is very good. But there is one pitfall with GNOME
3836: packages. Before GNOME 2 had been released, there were already many
3837: GNOME 1 packages in pkgsrc. To be able to continue to use these
3838: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3839: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3840: whether this was the case here, and indeed it was.</p>
3841: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3842: file, adding the dependency is very easy. I just inserted an
3843: <code class="literal">.include</code> line before the last line of the package
3844: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3845: <pre class="programlisting">
3846: [...]
3847: .include "../../x11/gtk2/buildlink3.mk"
3848: .include "../../mk/bsd.pkg.mk
3849: </pre>
1.10 hubertf 3850: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3851: was:</p>
3852: <pre class="programlisting">
3853: [...]
3854: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3855: checking for GTK - version >= 1.2.0... no
3856: *** Could not run GTK test program, checking why...
3857: *** The test program failed to compile or link. See the file config.log for the
3858: *** exact error that occured. This usually means GTK was incorrectly installed
3859: *** or that you have moved GTK since it was installed. In the latter case, you
3860: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3861: configure: error: Test for GTK failed.
3862: [...]
3863: </pre>
1.23 wiz 3864: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3865: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3866: told me that this package really wanted to have the GNOME 1 version of
3867: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3868: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3869: So I changed the <code class="literal">x11/gtk2</code> to
3870: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3871: and tried again.</p>
3872: <pre class="programlisting">
3873: [...]
1.59 jnemeth 3874: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3875: In file included from xpidl.c:42:
3876: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3877: In file included from xpidl.c:42:
3878: xpidl.h:132: error: parse error before "IDL_ns"
3879: [...]
3880: </pre>
3881: <p>The package still does not find all of its dependencies. Now the
3882: question is: Which package provides the
3883: <code class="filename">libIDL/IDL.h</code> header file?</p>
3884: <pre class="programlisting">
3885: <code class="prompt">$</code> echo ../../*/*idl*
3886: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3887: <code class="prompt">$</code> echo ../../*/*IDL*
3888: ../../net/libIDL
3889: </pre>
3890: <p>Let's take the one from the second try. So I included the
3891: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3892: again. But the error didn't change. After digging through some of the
3893: code, I concluded that the build process of the package was broken and
3894: couldn't have ever worked, but since the Mozilla source tree is quite
3895: large, I didn't want to fix it. So I added the following to the package
3896: <code class="filename">Makefile</code> and tried again:</p>
3897: <pre class="programlisting">
3898: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3899: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3900: </pre>
3901: <p>The latter line is needed because the package expects the library
3902: <code class="filename">libIDL.so</code>, but only
3903: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3904: wrapper to rewrite that on the fly.</p>
3905: <p>The next problem was related to a recent change of the FreeType
3906: 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>
3907: which patch files were relevant for this issue and copied them to the
3908: <code class="filename">patches</code> directory. Then I retried, fixed the
3909: patches so that they applied cleanly and retried again. This time,
3910: everything worked.</p>
3911: </div>
1.41 asau 3912: <div class="sect3">
1.1 dsieger 3913: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3914: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3915: <pre class="programlisting">
3916: <code class="prompt">$</code> bmake CHECK_FILES=no install
3917: [...]
3918: <code class="prompt">$</code> bmake print-PLIST >PLIST
3919: <code class="prompt">$</code> bmake deinstall
3920: <code class="prompt">$</code> bmake install
3921: </pre>
3922: </div>
3923: </div>
3924: </div>
3925: </div>
1.41 asau 3926: <div class="chapter">
1.1 dsieger 3927: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3928: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3929: <div class="toc">
3930: <p><b>Table of Contents</b></p>
3931: <dl>
1.23 wiz 3932: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3933: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3934: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3935: <dd><dl>
3936: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3937: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3938: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3939: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3940: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3941: </dl></dd>
3942: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3943: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3944: <dd><dl>
3945: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3946: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3947: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3948: </dl></dd>
1.23 wiz 3949: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3950: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3951: </dl>
3952: </div>
3953: <p>Whenever you're preparing a package, there are a number of
3954: files involved which are described in the following
3955: sections.</p>
1.41 asau 3956: <div class="sect1">
1.1 dsieger 3957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3958: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3959: </h2></div></div></div>
3960: <p>Building, installation and creation of a binary package are all
3961: controlled by the package's <code class="filename">Makefile</code>.
3962: The <code class="filename">Makefile</code> describes various things about
3963: a package, for example from where to get it, how to configure,
3964: build, and install it.</p>
3965: <p>A package <code class="filename">Makefile</code> contains several
3966: sections that describe the package.</p>
3967: <p>In the first section there are the following variables, which
3968: should appear exactly in the order given here. The order and
3969: grouping of the variables is mostly historical and has no further
3970: meaning.</p>
1.41 asau 3971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3972: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3973: distribution file to be downloaded from the package's
3974: website.</p></li>
1.23 wiz 3975: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 ! asau 3976: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3977: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 ! asau 3978: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
! 3979: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3980: directory name together with the version number. It must match the
3981: regular expression
3982: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3983: starts with a letter or digit, and contains only letters, digits,
3984: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3985: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.1 dsieger 3986: the package file to create if the <code class="varname">PKGNAME</code>
3987: isn't unique on a SVR4 system. The default is
3988: <code class="varname">PKGNAME</code>, which may be shortened when you use
3989: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
3990: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
3991: does not produce an unique package name on a SVR4 system.
3992: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
3993: characters.</p></li>
1.23 wiz 3994: <li class="listitem">
1.1 dsieger 3995: <p><code class="varname">CATEGORIES</code> is a list of categories
3996: which the package fits in. You can choose any of the top-level
3997: directories of pkgsrc for it.</p>
3998: <p>Currently the following values are available for
3999: <code class="varname">CATEGORIES</code>. If more than
4000: one is used, they need to be separated by spaces:</p>
4001: <pre class="programlisting">
4002: archivers cross geography meta-pkgs security
4003: audio databases graphics misc shells
4004: benchmarks devel ham multimedia sysutils
4005: biology editors inputmethod net textproc
4006: cad emulators lang news time
4007: chat finance mail parallel wm
4008: comms fonts math pkgtools www
4009: converters games mbone print x11
4010: </pre>
4011: </li>
1.23 wiz 4012: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 4013: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4014: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4015: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 4016: <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 4017: </ul></div>
4018: <p>The second section contains information about separately
4019: downloaded patches, if any.
4020: </p>
1.41 asau 4021: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4022: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1 dsieger 4023: Name(s) of additional files that contain distribution patches.
4024: There is no default. pkgsrc will look for them at
4025: <code class="varname">PATCH_SITES</code>.
4026: They will automatically be uncompressed before patching if
4027: the names end with <code class="filename">.gz</code> or
4028: <code class="filename">.Z</code>.</p></li>
1.23 wiz 4029: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 4030: Primary location(s) for distribution patch files (see
4031: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4032: </ul></div>
4033: <p>The third section contains the following variables.
4034: </p>
1.41 asau 4035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4036: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 4037: address of the person who feels responsible for this package,
4038: and who is most likely to look at problems or questions regarding
1.29 dholland 4039: 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 4040: Other developers may contact the <code class="varname">MAINTAINER</code>
4041: before making changes to the package, but are not required to
4042: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4043: to yourself. If you really can't maintain the package for future
4044: updates, set it to
1.10 hubertf 4045: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 4046: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 4047: of <code class="varname">MAINTAINER</code> when you do not want other
4048: developers to update or change the package without contacting
4049: you first. A package Makefile should contain one of
4050: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4051: not both. </p></li>
1.23 wiz 4052: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 4053: find more information about the package.</p></li>
1.23 wiz 4054: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 4055: description of the package (should not include the package
4056: name).</p></li>
4057: </ul></div>
4058: <p>Other variables that affect the build:
4059: </p>
1.41 asau 4060: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4061: <p><code class="varname">WRKSRC</code>: The directory where the
4062: interesting distribution files of the package are found. The
4063: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4064: works for most packages.</p>
4065: <p>If a package doesn't create a subdirectory for itself
4066: (most GNU software does, for instance), but extracts itself in
4067: the current directory, you should set
4068: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4069: <p>If a package doesn't create a subdirectory with the
4070: name of <code class="varname">DISTNAME</code> but some different name,
4071: set <code class="varname">WRKSRC</code> to point to the proper name in
4072: <code class="filename">${WRKDIR}</code>, for example
4073: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4074: <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>
4075: <p>The name of the working directory created by pkgsrc is
4076: taken from the <code class="varname">WRKDIR_BASENAME</code>
4077: variable. By default, its value is
4078: <code class="filename">work</code>. If you want to use the same
4079: pkgsrc tree for building different kinds of binary packages,
4080: you can change the variable according to your needs. Two
4081: other variables handle common cases of setting
4082: <code class="varname">WRKDIR_BASENAME</code> individually. If
4083: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 4084: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4085: the host's name is attached to the directory name. If
4086: <code class="varname">OBJMACHINE</code> is defined, the platform name
4087: is attached, which might look like
4088: <code class="filename">work.i386</code> or
4089: <code class="filename">work.sparc</code>.</p>
4090: </li></ul></div>
4091: <p>Please pay attention to the following gotchas:</p>
1.41 asau 4092: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4093: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 4094: installed in compressed form by the package. For packages using
4095: BSD-style makefiles which honor MANZ, there is
4096: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 4097: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4098: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 4099: below).</p></li>
1.23 wiz 4100: <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 4101: </ul></div>
4102: </div>
1.41 asau 4103: <div class="sect1">
1.1 dsieger 4104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4105: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4106: </h2></div></div></div>
4107: <p>The <code class="filename">distinfo</code> file contains the message
4108: digest, or checksum, of each distfile needed for the package. This
4109: ensures that the distfiles retrieved from the Internet have not been
4110: corrupted during transfer or altered by a malign force to introduce
4111: a security hole. Due to recent rumor about weaknesses of digest
4112: algorithms, all distfiles are protected using both SHA1 and RMD160
4113: message digests, as well as the file size.</p>
4114: <p>The <code class="filename">distinfo</code> file also contains the
4115: checksums for all the patches found in the
1.10 hubertf 4116: <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 4117: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10 hubertf 4118: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 4119: command.</p>
4120: <p>Some packages have different sets of distfiles depending on
1.23 wiz 4121: 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 4122: <code class="filename">distinfo</code> file and care should be taken when
4123: upgrading such a package to ensure distfile information is not
4124: lost.</p>
4125: </div>
1.41 asau 4126: <div class="sect1">
1.1 dsieger 4127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4128: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4129: <p>Many packages still don't work out-of-the box on the various
4130: platforms that are supported by pkgsrc. Therefore, a number of custom
4131: patch files are needed to make the package work. These patch files are
4132: found in the <code class="filename">patches/</code> directory.</p>
4133: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4134: applied to the files in <code class="varname">WRKSRC</code> directory after
1.10 hubertf 4135: 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 4136: order</a>.</p>
1.41 asau 4137: <div class="sect2">
1.1 dsieger 4138: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4139: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4140: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 4141: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 4142: problems. (To force patches to apply with fuzz you can set
4143: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4144: should contain only changes for a single file, and no file should be
4145: patched by more than one patch file. This helps to keep future
4146: modifications simple.</p>
4147: <p>Each patch file is structured as follows: In the first line,
4148: there is the RCS Id of the patch itself. The second line should be
4149: empty for aesthetic reasons. After that, there should be a comment for
4150: each change that the patch does. There are a number of standard
4151: cases:</p>
1.41 asau 4152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4153: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 4154: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 4155: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 4156: platform and other environment (for example, the compiler) that the
4157: patch is needed for.</p></li>
4158: </ul></div>
1.24 wiz 4159: <p>In all, the patch should be commented so that any
1.1 dsieger 4160: developer who knows the code of the application can make some use of
4161: the patch. Special care should be taken for the upstream developers,
4162: since we generally want that they accept our patches, so we have less
4163: work in the future.</p>
4164: </div>
1.41 asau 4165: <div class="sect2">
1.1 dsieger 4166: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4167: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4168: <p>One important thing to mention is to pay attention that no RCS
4169: IDs get stored in the patch files, as these will cause problems when
4170: later checked into the NetBSD CVS tree. Use the
1.10 hubertf 4171: <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 4172: problems.</p>
4173: <p>For even more automation, we recommend using
1.10 hubertf 4174: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4175: whole set of patches. You just have to backup files before you
4176: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4177: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4178: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4179: you upgrade a package this way, you can easily compare the new
4180: set of patches with the previously existing one with
1.24 wiz 4181: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4182: are replaced by new files, so carefully check if you want to take all
4183: the changes.</p>
1.1 dsieger 4184: <p>When you have finished a package, remember to generate
1.10 hubertf 4185: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 4186: 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 4187: <p>When adding a patch that corrects a problem in the
4188: distfile (rather than e.g. enforcing pkgsrc's view of where
4189: man pages should go), send the patch as a bug report to the
4190: maintainer. This benefits non-pkgsrc users of the package,
4191: and usually makes it possible to remove the patch in future
4192: version.</p>
1.2 rillig 4193: <p>The file names of the patch files are usually of the form
1.24 wiz 4194: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4195: Many packages still use the previous convention
4196: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4197: but new patches should be of the form containing the filename.
4198: <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
4199: automatically.</p>
1.1 dsieger 4200: </div>
1.41 asau 4201: <div class="sect2">
1.1 dsieger 4202: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4203: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4204: <p>If you want to share patches between multiple packages
4205: in pkgsrc, e.g. because they use the same distfiles, set
4206: <code class="varname">PATCHDIR</code> to the path where the patch files
4207: can be found, e.g.:</p>
4208: <pre class="programlisting">
4209: PATCHDIR= ${.CURDIR}/../xemacs/patches
4210: </pre>
4211: <p>Patch files that are distributed by the author or other
4212: maintainers can be listed in
4213: <code class="varname">PATCHFILES</code>.</p>
4214: <p>If it is desired to store any patches that should not be
4215: committed into pkgsrc, they can be kept outside the pkgsrc
4216: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4217: directory tree there is expected to have the same
1.23 wiz 4218: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 4219: patches are expected to be stored inside these dirs (also
4220: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4221: example, if you want to keep a private patch for
4222: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4223: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4224: files in the named directory are expected to be patch files,
4225: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4226: applied</em></span>.</p>
4227: </div>
1.41 asau 4228: <div class="sect2">
1.1 dsieger 4229: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4230: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4231: <p>When fixing a portability issue in the code do not use
4232: preprocessor magic to check for the current operating system nor
4233: platform. Doing so hurts portability to other platforms because
4234: the OS-specific details are not abstracted appropriately.</p>
4235: <p>The general rule to follow is: instead of checking for the
4236: operating system the application is being built on, check for the
4237: specific <span class="emphasis"><em>features</em></span> you need. For example,
4238: instead of assuming that kqueue is available under NetBSD and
4239: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 4240: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4241: yes, this generally involves patching the
1.10 hubertf 4242: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4243: that prevents some OSes from adopting interfaces from other OSes
4244: (e.g. Linux implementing kqueue), something that the above checks
4245: cannot take into account.</p>
4246: <p>Of course, checking for features generally involves more
4247: work on the developer's side, but the resulting changes are
4248: cleaner and there are chances they will work on many other
4249: platforms. Not to mention that there are higher chances of being
4250: later integrated into the mainstream sources. Remember:
4251: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4252: <p>Some typical examples:</p>
4253: <div class="table">
1.6 rillig 4254: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4255: <div class="table-contents"><table summary="Patching examples" border="1">
4256: <colgroup>
4257: <col>
4258: <col>
4259: <col>
4260: </colgroup>
4261: <thead><tr>
4262: <th>Where</th>
4263: <th>Incorrect</th>
4264: <th>Correct</th>
4265: </tr></thead>
4266: <tbody>
4267: <tr>
4268: <td>configure script</td>
4269: <td>
4270: <pre class="programlisting">
4271: case ${target_os} in
4272: netbsd*) have_kvm=yes ;;
4273: *) have_kvm=no ;;
4274: esac
4275: </pre>
4276: </td>
4277: <td>
4278: <pre class="programlisting">
4279: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4280: </pre>
4281: </td>
4282: </tr>
4283: <tr>
4284: <td>C source file</td>
4285: <td>
4286: <pre class="programlisting">
4287: #if defined(__NetBSD__)
4288: # include <sys/event.h>
4289: #endif
4290: </pre>
4291: </td>
4292: <td>
4293: <pre class="programlisting">
4294: #if defined(HAVE_SYS_EVENT_H)
4295: # include <sys/event.h>
4296: #endif
4297: </pre>
4298: </td>
4299: </tr>
4300: <tr>
4301: <td>C source file</td>
4302: <td>
4303: <pre class="programlisting">
4304: int
4305: monitor_file(...)
4306: {
4307: #if defined(__NetBSD__)
4308: int fd = kqueue();
4309: ...
4310: #else
4311: ...
4312: #endif
4313: }
4314: </pre>
4315: </td>
4316: <td>
4317: <pre class="programlisting">
4318: int
4319: monitor_file(...)
4320: {
4321: #if defined(HAVE_KQUEUE)
4322: int fd = kqueue();
4323: ...
4324: #else
4325: ...
4326: #endif
4327: }
4328: </pre>
4329: </td>
4330: </tr>
4331: </tbody>
4332: </table></div>
4333: </div>
4334: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 4335: 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
4336: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 4337: 2</a>). It summarizes multiple details on how to make
4338: software easier to package; all the suggestions in it were
4339: collected from our experience in pkgsrc work, so they are possibly
4340: helpful when creating patches too.</p>
4341: </div>
1.41 asau 4342: <div class="sect2">
1.1 dsieger 4343: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4344: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4345: <p>Always, always, <span class="strong"><strong>always</strong></span>
4346: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4347: improvements you do to a package to the mainstream developers.
4348: This is the only way to get their attention on portability issues
4349: and to ensure that future versions can be built out-of-the box on
4350: NetBSD. Furthermore, any user that gets newer distfiles will get
4351: the fixes straight from the packaged code.</p>
4352: <p>This generally involves cleaning up the patches
4353: (because sometimes the patches that are
1.40 wiz 4354: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 4355: appropriate trackers for the projects and working with the
4356: mainstream authors to accept your changes. It is
4357: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4358: the packages in pkgsrc are kept simple and thus further changes
4359: can be done without much hassle.</p>
1.24 wiz 4360: <p>When you have done this, please add a URL to the upstream
4361: bug report to the patch comment.</p>
1.1 dsieger 4362: <p>Support the idea of free software!</p>
4363: </div>
4364: </div>
1.41 asau 4365: <div class="sect1">
1.1 dsieger 4366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4367: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 4368: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4369: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4370: <dd><p>A multi-line description of the piece of software. This should include
4371: any credits where they are due. Please bear in mind that others do not
4372: share your sense of humour (or spelling idiosyncrasies), and that others
4373: will read everything that you write here.</p></dd>
4374: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4375: <dd><p>This file governs the files that are installed on your
4376: system: all the binaries, manual pages, etc. There are other
4377: directives which may be entered in this file, to control the
4378: creation and deletion of directories, and the location of
1.10 hubertf 4379: 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 4380: information.</p></dd>
4381: </dl></div>
4382: </div>
1.41 asau 4383: <div class="sect1">
1.1 dsieger 4384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4385: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 4386: <div class="sect2">
1.1 dsieger 4387: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4388: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4389: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4390: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4391: <dd>
1.29 dholland 4392: <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 4393: First time after package extraction and before files are
4394: moved in place, the second time after the files to install
4395: are moved in place. This can be used to do any custom
4396: procedures not possible with @exec commands in
1.29 dholland 4397: <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
4398: <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 4399: Please note that you can modify variables in it easily by using
4400: <code class="varname">FILES_SUBST</code> in the package's
4401: <code class="filename">Makefile</code>:</p>
4402: <pre class="programlisting">
4403: FILES_SUBST+= SOMEVAR="somevalue"
4404: </pre>
4405: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4406: <code class="filename">INSTALL</code>. By default, substitution is
4407: performed for <code class="varname">PREFIX</code>,
4408: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4409: <code class="varname">VARBASE</code>, and a few others, type
4410: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4411: complete list.</p>
4412: </dd>
1.1 dsieger 4413: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4414: <dd><p>This script is executed before and after any files are removed. It is
4415: this script's responsibility to clean up any additional messy details
4416: around the package's installation, since all pkg_delete knows is how to
4417: delete the files created in the original distribution.
1.29 dholland 4418: 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>
4419: 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 4420: The same methods to replace variables can be used as for
4421: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4422: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4423: <dd>
4424: <p>This file is displayed after installation of the package.
4425: Useful for things like legal notices on almost-free
4426: software and hints for updating config files after
4427: installing modules for apache, PHP etc.
4428: Please note that you can modify variables in it easily by using
4429: <code class="varname">MESSAGE_SUBST</code> in the package's
4430: <code class="filename">Makefile</code>:</p>
4431: <pre class="programlisting">
4432: MESSAGE_SUBST+= SOMEVAR="somevalue"
4433: </pre>
1.23 wiz 4434: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4435: <code class="filename">MESSAGE</code>. By default, substitution is
4436: performed for <code class="varname">PKGNAME</code>,
4437: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4438: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4439: <code class="varname">X11BASE</code>,
4440: <code class="varname">PKG_SYSCONFDIR</code>,
4441: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4442: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4443: <p>You can display a different or additional files by
4444: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4445: default is <code class="filename">MESSAGE</code>, if the file
4446: exists.</p>
4447: </dd>
4448: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 ! asau 4449: <dd>
! 4450: <p>This file is used by the alternatives framework.
! 4451: It creates, configures, and destroys generic wrappers used to
! 4452: run programs with similar interfaces.
! 4453: See pkg_alternatives(8) from pkgtools/pkg_alternatives
! 4454: for more information.</p>
! 4455: <p>Each line of the file contains two filenames, first
! 4456: the wrapper and then the alternative provided by the package.
! 4457: Both paths are relative to <code class="varname">PREFIX</code>.</p>
! 4458: </dd>
1.1 dsieger 4459: </dl></div>
4460: </div>
1.41 asau 4461: <div class="sect2">
1.1 dsieger 4462: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4463: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4464: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4465: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4466: <dd><p>This file contains arbitrary things that could
4467: also go into a <code class="filename">Makefile</code>, but its purpose is
4468: to be used by more than one package. This file should only be
4469: used when the packages that will use the file are known in
4470: advance. For other purposes it is often better to write a
4471: <code class="filename">*.mk</code> file and give it a good name that
4472: describes what it does.</p></dd>
4473: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4474: <dd><p>This file contains the dependency information
1.10 hubertf 4475: 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 4476: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4477: <dd><p>This file contains workarounds for compiler bugs
4478: and similar things. It is included automatically by the pkgsrc
4479: infrastructure, so you don't need an extra
4480: <code class="literal">.include</code> line for
4481: it.</p></dd>
4482: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4483: <dd><p>This file contains the code for the
1.10 hubertf 4484: 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 4485: selected by the user. If a package has only one or two options,
4486: it is equally acceptable to put the code directly into the
4487: <code class="filename">Makefile</code>.</p></dd>
4488: </dl></div>
4489: </div>
1.41 asau 4490: <div class="sect2">
1.1 dsieger 4491: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4492: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4493: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4494: <dt><span class="term"><code class="filename">README*</code></span></dt>
4495: <dd><p>These files do not take place in the creation of
4496: a package and thus are purely informative to the package
4497: developer.</p></dd>
4498: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4499: <dd><p>This file contains things that need to be done
4500: to make the package even
4501: better.</p></dd>
4502: </dl></div>
4503: </div>
4504: </div>
1.41 asau 4505: <div class="sect1">
1.1 dsieger 4506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4507: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4508: </h2></div></div></div>
1.10 hubertf 4509: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4510: unpacked into the directory denoted by
4511: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4512: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4513: directory is also used to keep various timestamp files.
4514: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4515: The default is <code class="filename">${.CURDIR}/work</code>
4516: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4517: if <code class="varname">OBJMACHINE</code> is set.</p>
4518: </div>
1.41 asau 4519: <div class="sect1">
1.1 dsieger 4520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4521: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4522: </h2></div></div></div>
4523: <p>If you have any files that you wish to be placed in the package prior
4524: to configuration or building, you could place these files here and use
1.10 hubertf 4525: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4526: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4527: this. Alternatively, you could simply diff the file against
4528: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4529: the creation of this file.</p>
4530: <p>If you want to share files in this way with other
4531: packages, set the <code class="varname">FILESDIR</code> variable to point
4532: to the other package's <code class="filename">files</code> directory,
4533: e.g.:</p>
4534: <pre class="programlisting">
4535: FILESDIR=${.CURDIR}/../xemacs/files
4536: </pre>
4537: </div>
4538: </div>
1.41 asau 4539: <div class="chapter">
1.1 dsieger 4540: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4541: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4542: <div class="toc">
4543: <p><b>Table of Contents</b></p>
4544: <dl>
1.6 rillig 4545: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4546: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4547: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4548: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4549: <dd><dl>
4550: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4551: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4552: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4553: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4554: <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 4555: </dl></dd>
4556: </dl>
4557: </div>
4558: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4559: each of which forms a well-defined part of the pkgsrc system. Using
1.29 dholland 4560: 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 4561: like pkgsrc requires some discipline to keep the code correct and
4562: understandable.</p>
4563: <p>The basic ingredients for <code class="filename">Makefile</code>
4564: programming are variables (which are actually macros) and shell
4565: commands. Among these shell commands may even be more complex ones
1.29 dholland 4566: 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 4567: as intended it is necessary to quote all variables correctly when they
4568: are used.</p>
4569: <p>This chapter describes some patterns, that appear quite often in
4570: <code class="filename">Makefile</code>s, including the pitfalls that come along
4571: with them.</p>
1.41 asau 4572: <div class="sect1">
1.1 dsieger 4573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4574: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4575: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4576: <p>When you are creating a file as a
4577: target of a rule, always write the data to a temporary file first
4578: and finally rename that file. Otherwise there might occur an error
4579: in the middle of generating the file, and when the user runs
1.29 dholland 4580: <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 4581: regenerated properly. Example:</p>
4582: <pre class="programlisting">
4583: wrong:
4584: @echo "line 1" > ${.TARGET}
4585: @echo "line 2" >> ${.TARGET}
4586: @false
4587:
4588: correct:
4589: @echo "line 1" > ${.TARGET}.tmp
4590: @echo "line 2" >> ${.TARGET}.tmp
4591: @false
4592: @mv ${.TARGET}.tmp ${.TARGET}
4593: </pre>
1.10 hubertf 4594: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4595: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4596: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4597: correct</strong></span> gives an error message twice, as expected.</p>
1.29 dholland 4598: <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 4599: <code class="literal">${.TARGET}</code> in case of error, but this only
4600: happens when it is interrupted, for example by pressing
4601: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.29 dholland 4602: 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 4603: </li></ul></div>
4604: </div>
1.41 asau 4605: <div class="sect1">
1.1 dsieger 4606: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4607: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4608: <p><code class="filename">Makefile</code> variables contain strings that
4609: can be processed using the five operators ``='', ``+='', ``?='',
1.29 dholland 4610: ``:='', 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 4611: page.</p>
4612: <p>When a variable's value is parsed from a
4613: <code class="filename">Makefile</code>, the hash character ``#'' and the
4614: backslash character ``\'' are handled specially. If a backslash is
4615: followed by a newline, any whitespace immediately in front of the
4616: backslash, the backslash, the newline, and any whitespace
4617: immediately behind the newline are replaced with a single space. A
4618: backslash character and an immediately following hash character are
4619: replaced with a single hash character. Otherwise, the backslash is
4620: passed as is. In a variable assignment, any hash character that is
4621: not preceded by a backslash starts a comment that continues upto the
4622: end of the logical line.</p>
4623: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4624: the only way to create a variable consisting of a single backslash
4625: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4626: <p>So far for defining variables. The other thing you can do with
4627: variables is evaluating them. A variable is evaluated when it is
4628: part of the right side of the ``:='' or the ``!='' operator, or
4629: directly before executing a shell command which the variable is part
1.29 dholland 4630: 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 4631: is, variables are not evaluated until there's no other way. The
4632: ``modifiers'' mentioned in the man page also evaluate the
4633: variable.</p>
4634: <p>Some of the modifiers split the string into words and then
4635: operate on the words, others operate on the string as a whole. When
4636: a string is split into words, it is split as you would expect
1.29 dholland 4637: 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 4638: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.1 dsieger 4639: loop does not follow the shell quoting rules but splits at sequences
4640: of whitespace.</p>
4641: <p>There are several types of variables that should be handled
4642: differently. Strings and two types of lists.</p>
1.41 asau 4643: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4644: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4645: characters. Nevertheless, you should restrict yourself to only
4646: using printable characters. Examples are
4647: <code class="varname">PREFIX</code> and
4648: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4649: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4650: are never exported to any shell command. Their elements are
4651: separated by whitespace. Therefore, the elements themselves cannot
4652: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4653: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4654: Examples are <code class="varname">DEPENDS</code> and
4655: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4656: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4657: may be exported to a shell command. Their elements can contain any
4658: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4659: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4660: <code class="varname">DISTFILES</code> and
4661: <code class="varname">MASTER_SITES</code>.</p></li>
4662: </ul></div>
1.41 asau 4663: <div class="sect2">
1.1 dsieger 4664: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4665: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4666: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4667: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4668: are reserved for use by the pkgsrc infrastructure. They shall
4669: not be used by package
4670: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4671: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4672: lowercase variable names for the iteration
4673: variables.</p></li>
1.23 wiz 4674: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4675: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4676: <code class="varname">DISTFILES</code>.</p></li>
4677: </ul></div>
4678: </div>
4679: </div>
1.41 asau 4680: <div class="sect1">
1.1 dsieger 4681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4682: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 4683: <p>This section presents you with some code snippets you should
4684: use in your own code. If you don't find anything appropriate here,
4685: you should test your code and add it here.</p>
1.41 asau 4686: <div class="sect2">
1.1 dsieger 4687: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4688: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 4689: <pre class="programlisting">
4690: STRING= foo * bar `date`
4691: INT_LIST= # empty
4692: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4693: EXT_LIST= # empty
4694: ANOTHER_EXT_LIST= a=b c=d
4695:
4696: INT_LIST+= ${STRING} # 1
4697: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4698: EXT_LIST+= ${STRING:Q} # 3
4699: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
4700: </pre>
4701: <p>When you add a string to an external list (example 3), it
4702: must be quoted. In all other cases, you must not add a quoting
4703: level. You must not merge internal and external lists, unless you
4704: are sure that all entries are correctly interpreted in both
4705: lists.</p>
4706: </div>
1.41 asau 4707: <div class="sect2">
1.1 dsieger 4708: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4709: <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 4710: <pre class="programlisting">
4711: EXT_LIST= # empty
4712: .for i in ${INT_LIST}
4713: EXT_LIST+= ${i:Q}""
4714: .endfor
4715: </pre>
4716: <p>This code converts the internal list
4717: <code class="varname">INT_LIST</code> into the external list
4718: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4719: are unquoted they must be quoted here. The reason for appending
4720: <code class="varname">""</code> is explained below.</p>
4721: </div>
1.41 asau 4722: <div class="sect2">
1.1 dsieger 4723: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4724: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 4725: <p>Sometimes you may want to print an arbitrary string. There
4726: are many ways to get it wrong and only few that can handle every
4727: nastiness.</p>
4728: <pre class="programlisting">
4729: STRING= foo bar < > * `date` $$HOME ' "
4730: EXT_LIST= string=${STRING:Q} x=second\ item
4731:
4732: all:
4733: echo ${STRING} # 1
4734: echo "${STRING}" # 2
4735: echo "${STRING:Q}" # 3
4736: echo ${STRING:Q} # 4
4737: echo x${STRING:Q} | sed 1s,.,, # 5
4738: printf "%s\\n" ${STRING:Q}"" # 6
4739: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
4740: </pre>
4741: <p>Example 1 leads to a syntax error in the shell, as the
4742: characters are just copied.</p>
4743: <p>Example 2 leads to a syntax error too, and if you leave out
4744: the last " character from <code class="varname">${STRING}</code>,
1.29 dholland 4745: <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 4746: variable would be evaluated, too.</p>
4747: <p>Example 3 outputs each space character preceded by a
4748: backslash (or not), depending on the implementation of the
1.29 dholland 4749: <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 4750: <p>Example 4 handles correctly every string that does not start
4751: with a dash. In that case, the result depends on the
1.29 dholland 4752: 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 4753: guarantee that your input does not start with a dash, this form is
4754: appropriate.</p>
4755: <p>Example 5 handles even the case of a leading dash
4756: correctly.</p>
4757: <p>Example 6 also works with every string and is the
4758: light-weight solution, since it does not involve a pipe, which has
4759: its own problems.</p>
4760: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4761: because the quoting has already been done when adding elements to
4762: the list.</p>
4763: <p>As internal lists shall not be passed to the shell, there is
4764: no example for it.</p>
4765: </div>
1.41 asau 4766: <div class="sect2">
1.1 dsieger 4767: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4768: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 4769: <p>There are many possible sources of wrongly quoted variables.
4770: This section lists some of the commonly known ones.</p>
1.41 asau 4771: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4772: <li class="listitem">
1.1 dsieger 4773: <p>Whenever you use the value of a list, think
4774: about what happens to leading or trailing whitespace. If the
4775: list is a well-formed shell expression, you can apply the
4776: <code class="varname">:M*</code> modifier to strip leading and trailing
4777: whitespace from each word. The <code class="varname">:M</code> operator
4778: first splits its argument according to the rules of the shell,
4779: and then creates a new list consisting of all words that match
4780: the shell glob expression <code class="varname">*</code>, that is: all.
4781: One class of situations where this is needed is when adding a
4782: variable like <code class="varname">CPPFLAGS</code> to
4783: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4784: invokes other configure scripts, it strips the leading and
4785: trailing whitespace from the variable and then passes it to the
4786: other configure scripts. But these configure scripts expect the
4787: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4788: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4789: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4790: here is how we do it:</p>
4791: <pre class="programlisting">
4792: CPPFLAGS= # empty
4793: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4794: CPPFLAGS+= ${MY_CPPFLAGS}
4795:
4796: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4797:
4798: all:
4799: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4800: echo x${CONFIGURE_ARGS}x # properly trimmed
4801: </pre>
4802: </li>
1.23 wiz 4803: <li class="listitem"><p>The example above contains one bug: The
1.1 dsieger 4804: <code class="varname">${PREFIX}</code> is a properly quoted shell
4805: expression, but there is the C compiler after it, which also
4806: expects a properly quoted string (this time in C syntax). The
4807: version above is therefore only correct if
4808: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4809: or double quotes. If you want to allow these, you have to add
4810: another layer of quoting to each variable that is used as a C
4811: string literal. You cannot use the <code class="varname">:Q</code>
4812: operator for it, as this operator only works for the
4813: shell.</p></li>
1.23 wiz 4814: <li class="listitem">
1.1 dsieger 4815: <p>Whenever a variable can be empty, the
4816: <code class="varname">:Q</code> operator can have surprising results. Here
4817: are two completely different cases which can be solved with the
4818: same trick.</p>
4819: <pre class="programlisting">
4820: EMPTY= # empty
4821: empty_test:
4822: for i in a ${EMPTY:Q} c; do \
4823: echo "$$i"; \
4824: done
4825:
4826: for_test:
4827: .for i in a:\ a:\test.txt
4828: echo ${i:Q}
4829: echo "foo"
4830: .endfor
4831: </pre>
4832: <p>The first example will only print two of the three lines
4833: we might have expected. This is because
4834: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4835: the shell cannot see. The workaround is to write
4836: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4837: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4838: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4839: <p>The second example will only print three lines instead of
4840: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4841: This is because the backslash of the value
4842: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.29 dholland 4843: <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
4844: <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 4845: <code class="varname">${i:Q}""</code>.</p>
4846: </li>
4847: </ul></div>
4848: </div>
1.41 asau 4849: <div class="sect2">
1.1 dsieger 4850: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4851: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 4852: <p>The pkgsrc bmake program does not handle the following
4853: assignment correctly. In case <code class="varname">_othervar_</code>
4854: contains a ``-'' character, one of the closing braces is included
4855: in <code class="varname">${VAR}</code> after this code executes.</p>
4856: <pre class="programlisting">
4857: VAR:= ${VAR:N${_othervar_:C/-//}}
4858: </pre>
4859: <p>For a more complex code snippet and a workaround, see the
4860: 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
4861: <code class="varname">bug1</code>.</p>
4862: </div>
4863: </div>
4864: </div>
1.41 asau 4865: <div class="chapter">
1.1 dsieger 4866: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4867: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4868: <div class="toc">
4869: <p><b>Table of Contents</b></p>
4870: <dl>
1.6 rillig 4871: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4872: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4873: <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 4874: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4875: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4876: <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 4877: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
4878: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1 dsieger 4879: </dl>
4880: </div>
4881: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4882: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4883: the package (relative to the <code class="filename">${PREFIX}</code>
4884: directory it's been installed in) plus some additional statements
1.29 dholland 4885: - 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 4886: This chapter addresses some issues that need attention when
4887: dealing with the <code class="filename">PLIST</code> file (or files, see
4888: below!).</p>
1.41 asau 4889: <div class="sect1">
1.1 dsieger 4890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4891: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4892: <p>Be sure to add a RCS ID line as the first thing in any
4893: <code class="filename">PLIST</code> file you write:</p>
4894: <pre class="programlisting">
4895: @comment $NetBSD$
4896: </pre>
4897: </div>
1.41 asau 4898: <div class="sect1">
1.1 dsieger 4899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4900: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4901: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4902: to output a PLIST that matches any new files since the package
1.10 hubertf 4903: 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 4904: more information on this target.</p>
4905: </div>
1.41 asau 4906: <div class="sect1">
1.1 dsieger 4907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4908: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4909: </h2></div></div></div>
4910: <p>If you have used any of the *-dirs packages, as explained in
1.10 hubertf 4911: <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, “Sharing directories between packages”</a>, you may have noticed that
4912: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1 dsieger 4913: <code class="varname">@comment</code>s instead of real
4914: <code class="varname">@dirrm</code> lines. You can also do this for
4915: specific directories and files, so that the results of that
4916: command are very close to reality. This helps <span class="emphasis"><em>a
4917: lot</em></span> during the update of packages.</p>
4918: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4919: of AWK patterns and actions that are used to filter the output of
4920: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4921: scripting you like to it, but be careful with quoting.</p>
4922: <p>For example, to get all files inside the
4923: <code class="filename">libdata/foo</code> directory removed from the
4924: resulting PLIST:</p>
4925: <pre class="programlisting">
4926: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
4927: </pre>
4928: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4929: to a specific (shared) directory converted to
4930: <code class="varname">@comment</code>s:</p>
4931: <pre class="programlisting">
4932: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
4933: </pre>
4934: </div>
1.41 asau 4935: <div class="sect1">
1.1 dsieger 4936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4937: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4938: <p>A number of variables are substituted automatically in
4939: PLISTs when a package is installed on a system. This includes the
4940: following variables:</p>
1.41 asau 4941: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4942: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4943: <dd>
4944: <p>Some packages like emacs and perl embed information
4945: about which architecture they were built on into the
4946: pathnames where they install their files. To handle this
4947: case, PLIST will be preprocessed before actually used, and
4948: the symbol
1.23 wiz 4949: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4950: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4951: same is done if the string
4952: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4953: PLIST somewhere - use this on packages that have GNU
4954: autoconf-created configure scripts.</p>
1.41 asau 4955: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4956: <h3 class="title">Legacy note</h3>
4957: <p>There used to be a symbol
1.23 wiz 4958: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4959: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4960: -m</strong></span>, but that's no longer supported and has
4961: been removed.</p>
4962: </div>
4963: </dd>
4964: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4965: <dd>
4966: <p>Some packages want to embed the OS name and version
4967: into some paths. To do this, use these variables in the
4968: <code class="filename">PLIST</code>:
4969: </p>
1.41 asau 4970: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4971: <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>
4972: <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>
4973: <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 4974: </ul></div>
4975: </dd>
4976: </dl></div>
4977: <p>For a complete list of values which are replaced by
4978: default, please look in <code class="filename">bsd.pkg.mk</code> (and
4979: search for <code class="varname">PLIST_SUBST</code>).</p>
4980: <p>If you want to change other variables not listed above, you
4981: can add variables and their expansions to this variable in the
1.10 hubertf 4982: 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 4983: <pre class="programlisting">
4984: PLIST_SUBST+= SOMEVAR="somevalue"
4985: </pre>
1.23 wiz 4986: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4987: in the <code class="filename">PLIST</code> with
1.23 wiz 4988: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4989: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4990: the common case of conditionally including some
4991: <code class="filename">PLIST</code> entries. It can be done by adding
4992: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4993: setting the corresponding <code class="varname">PLIST.foo</code> variable
4994: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4995: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4996: in the <code class="filename">PLIST</code> with either
1.23 wiz 4997: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4998: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4999: For example, in <code class="filename">Makefile</code>:</p>
5000: <pre class="programlisting">
5001: PLIST_VARS+= foo
5002: .if <em class="replaceable"><code>condition</code></em>
5003: PLIST.foo= yes
5004: .else
5005: </pre>
5006: <p>And then in <code class="filename">PLIST</code>:</p>
5007: <pre class="programlisting">
5008: @comment $NetBSD$
5009: bin/bar
5010: man/man1/bar.1
5011: ${PLIST.foo}bin/foo
5012: ${PLIST.foo}man/man1/foo.1
5013: ${PLIST.foo}share/bar/foo.data
5014: ${PLIST.foo}@dirrm share/bar
5015: </pre>
1.1 dsieger 5016: </div>
1.41 asau 5017: <div class="sect1">
1.1 dsieger 5018: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5019: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5020: <p>Man pages should be installed in compressed form if
5021: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5022: and uncompressed otherwise. To handle this in the
1.23 wiz 5023: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 5024: appended/removed automatically for man pages according to
5025: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5026: or not, see above for details. This modification of the
5027: <code class="filename">PLIST</code> file is done on a copy of it, not
5028: <code class="filename">PLIST</code> itself.</p>
5029: </div>
1.41 asau 5030: <div class="sect1">
1.1 dsieger 5031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5032: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5033: </h2></div></div></div>
5034: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5035: in generating the binary package, set the variable
5036: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.29 dholland 5037: 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 5038: important. The default for <code class="varname">PLIST_SRC</code> is
5039: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5040: </div>
1.41 asau 5041: <div class="sect1">
1.1 dsieger 5042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5043: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5044: <p>Some packages decide to install a different set of files based on
5045: the operating system being used. These differences can be
5046: automatically handled by using the following files:</p>
1.41 asau 5047: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5048: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5049: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5050: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5051: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5052: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 5053: </ul></div>
5054: </div>
1.41 asau 5055: <div class="sect1">
1.1 dsieger 5056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5057: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.23 wiz 5058: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 5059: multiple (and unrelated) packages install files. These
1.22 jakllsch 5060: directories were problematic because you had to add special
5061: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 5062: centralized package handle them.</p>
1.22 jakllsch 5063: <p>In pkgsrc, it is now easy: Each package should create
5064: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5065: will remove any directories left empty after uninstalling a
5066: package.</p>
5067: <p>If a package needs an empty directory to work, create
5068: the directory during installation as usual, and also add an
5069: entry to the PLIST:
5070: </p>
1.1 dsieger 5071: <pre class="programlisting">
1.22 jakllsch 5072: @pkgdir path/to/empty/directory
1.1 dsieger 5073: </pre>
1.22 jakllsch 5074: <p>
5075: </p>
1.1 dsieger 5076: </div>
5077: </div>
1.41 asau 5078: <div class="chapter">
1.1 dsieger 5079: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5080: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5081: <div class="toc">
5082: <p><b>Table of Contents</b></p>
5083: <dl>
1.6 rillig 5084: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 5085: <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 5086: <dd><dl>
1.6 rillig 5087: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 5088: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5089: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5090: and
5091: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5092: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5093: </dl></dd>
1.23 wiz 5094: <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 5095: <dd><dl>
1.23 wiz 5096: <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 5097: <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 5098: </dl></dd>
5099: </dl>
5100: </div>
5101: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5102: are seen by a package's configure and build processes. This is implemented
5103: in a two step process:</p>
1.23 wiz 5104: <div class="orderedlist"><ol class="orderedlist" type="1">
5105: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 5106: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5107: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 5108: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 5109: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5110: <code class="option">-L${LOCALBASE}/lib</code> into references to
5111: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5112: native compiler on some operating systems look like GCC, so that
5113: packages that expect GCC won't require modifications to build with
5114: those native compilers.</p></li>
5115: </ol></div>
5116: <p>This normalizes the environment in which a package is built so that the
5117: package may be built consistently despite what other software may be
5118: installed. Please note that the normal system header and library paths,
5119: e.g. <code class="filename">/usr/include</code>,
5120: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5121: designed to insulate the package build from non-system-supplied
5122: software.</p>
1.41 asau 5123: <div class="sect1">
1.1 dsieger 5124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5125: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5126: <p>The process of converting packages to use the buildlink3
1.23 wiz 5127: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 5128: The things to keep in mind are:</p>
1.23 wiz 5129: <div class="orderedlist"><ol class="orderedlist" type="1">
5130: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 5131: instead of the actual toolchain. Some packages are tricky,
5132: and the only way to know for sure is the check
5133: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5134: wrappers are being invoked.</p></li>
1.23 wiz 5135: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 5136: the package Makefile, e.g. Java VMs, standalone shells,
5137: etc., because the code to symlink files into
5138: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 5139: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 5140: </p></li>
1.23 wiz 5141: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 5142: <code class="filename">buildlink3.mk</code> files that you list in a
5143: package's Makefile are added as dependencies for that package.
5144: </p></li>
5145: </ol></div>
5146: <p>If a dependency on a particular package is required for its libraries and
5147: headers, then we replace:</p>
5148: <pre class="programlisting">
5149: DEPENDS+= foo>=1.1.0:../../category/foo
5150: </pre>
5151: <p>with</p>
5152: <pre class="programlisting">
5153: .include "../../category/foo/buildlink3.mk"
5154: </pre>
5155: <p>The buildlink3.mk files usually define the required dependencies.
5156: If you need a newer version of the dependency when using buildlink3.mk
5157: files, then you can define it in your Makefile; for example:</p>
5158: <pre class="programlisting">
5159: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5160: .include "../../category/foo/buildlink3.mk"
5161: </pre>
5162: <p>There are several <code class="filename">buildlink3.mk</code>
5163: files in <code class="filename">pkgsrc/mk</code>
5164: that handle special package issues:</p>
1.41 asau 5165: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5166: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 5167: the native or a pkgsrc Berkeley DB implementation based on
5168: the values of <code class="varname">BDB_ACCEPTED</code> and
5169: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 5170: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 5171: comes with neither Curses nor NCurses, this will take care
5172: 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 5173: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 5174: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5175: adding a dependency on Heimdal or MIT-krb5 for packages that
5176: require a Kerberos 5 implementation.</p></li>
1.23 wiz 5177: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 5178: system-provided Motif installation or adds a dependency on
1.45 obache 5179: <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 5180: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 5181: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5182: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 5183: which Motif version will be used.</p></li>
1.55 ryoon 5184: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 5185: system-provided GNU readline or editline (libedit) installation,
1.55 ryoon 5186: 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>,
5187: <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
5188: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5189: If your package really needs GNU readline library, its Makefile
5190: should include <code class="filename">devel/readline/buildlink3.mk</code>
5191: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 5192: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 5193: variables that may be used by packages that use the
5194: Open Sound System (OSS) API.</p></li>
1.23 wiz 5195: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 5196: any of the Postgres versions in the variable
5197: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5198: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 5199: the file for more information.</p></li>
1.23 wiz 5200: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 5201: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5202: 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 5203: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 5204: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5205: library.</p></li>
5206: </ul></div>
5207: <p>The comments in those <code class="filename">buildlink3.mk</code>
5208: files provide a more complete
5209: description of how to use them properly.</p>
5210: </div>
1.41 asau 5211: <div class="sect1">
1.1 dsieger 5212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5213: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5214: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5215: included by Makefiles to indicate the need to compile and link
5216: against header files and libraries provided by the package. A
5217: <code class="filename">buildlink3.mk</code> file should always provide
5218: enough information to add the correct type of dependency
5219: relationship and include any other
5220: <code class="filename">buildlink3.mk</code> files that it needs to find
5221: headers and libraries that it needs in turn.</p>
5222: <p>To generate an initial <code class="filename">buildlink3.mk</code>
5223: 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>
5224: package is highly recommended. For most packages, the following
5225: command will generate a good starting point for
5226: <code class="filename">buildlink3.mk</code> files:</p>
5227: <pre class="screen">
5228: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5229: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5230: </pre>
1.41 asau 5231: <div class="sect2">
1.1 dsieger 5232: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5233: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5234: <p>The following real-life example
5235: <code class="filename">buildlink3.mk</code> is taken
5236: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5237: <pre class="programlisting">
1.18 snj 5238: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5239:
1.18 snj 5240: BUILDLINK_TREE+= tiff
1.1 dsieger 5241:
1.18 snj 5242: .if !defined(TIFF_BUILDLINK3_MK)
5243: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5244:
1.18 snj 5245: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5246: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5247: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5248:
5249: .include "../../devel/zlib/buildlink3.mk"
5250: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 5251: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5252:
1.18 snj 5253: BUILDLINK_TREE+= -tiff
1.1 dsieger 5254: </pre>
5255: <p>The header and footer manipulate
1.18 snj 5256: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 5257: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 5258: the dependency tree.</p>
5259: <p>The main section is protected from multiple inclusion
1.1 dsieger 5260: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5261: added. Several important variables are set in the section:</p>
1.41 asau 5262: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5263: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5264: is the actual dependency recorded in the installed
5265: package; this should always be set using
1.10 hubertf 5266: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5267: we're appending to any pre-existing list of values. This
5268: variable should be set to the first version of the
1.26 wiz 5269: package that had an backwards-incompatible API change.
1.1 dsieger 5270: </p></li>
1.23 wiz 5271: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5272: is the location of the <em class="replaceable"><code>pkg</code></em>
5273: pkgsrc directory.</p></li>
1.23 wiz 5274: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5275: (not shown above) controls whether we use
5276: <code class="varname">BUILD_DEPENDS</code> or
5277: <code class="varname">DEPENDS</code> to add the dependency on
5278: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5279: selected by setting
5280: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5281: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 5282: used.</p></li>
1.23 wiz 5283: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5284: and
5285: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5286: (not shown above) are lists of subdirectories of
5287: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5288: to add to the header and library search paths. These
1.23 wiz 5289: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 5290: respectively.</p></li>
1.23 wiz 5291: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5292: (not shown above) is the list of preprocessor flags to add
5293: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 5294: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 5295: should be avoided and instead be handled using
5296: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5297: above.</p></li>
5298: </ul></div>
5299: <p>The following variables are all optionally defined within
5300: this second section (protected against multiple inclusion) and
5301: control which package files are symlinked into
5302: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5303: transformed during the symlinking:</p>
1.41 asau 5304: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5305: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5306: (not shown above) is a shell glob pattern relative to
5307: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5308: to be symlinked into
5309: <code class="filename">${BUILDLINK_DIR}</code>,
5310: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 5311: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5312: (not shown above) is a shell pipeline that
5313: outputs to stdout a list of files relative to
5314: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5315: The resulting files are to be symlinked
5316: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5317: this takes the <code class="filename">+CONTENTS</code> of a
5318: <em class="replaceable"><code>pkg</code></em> and filters it through
5319: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 5320: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5321: (not shown above) is a filter command that filters
5322: <code class="filename">+CONTENTS</code> input into a list of files
5323: relative to
5324: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5325: on stdout. By default for overwrite packages,
5326: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5327: outputs the contents of the <code class="filename">include</code>
5328: and <code class="filename">lib</code> directories in the package
5329: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5330: it outputs any libtool archives in
5331: <code class="filename">lib</code> directories.</p></li>
1.23 wiz 5332: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5333: (not shown above) is a list of sed arguments used to
5334: transform the name of the source filename into a
1.10 hubertf 5335: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5336: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5337: </ul></div>
1.18 snj 5338: <p>This section can additionally include any
1.1 dsieger 5339: <code class="filename">buildlink3.mk</code> needed for
5340: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5341: Including these <code class="filename">buildlink3.mk</code> files
5342: means that the headers and libraries for these
5343: dependencies are also symlinked into
5344: <code class="filename">${BUILDLINK_DIR}</code>
5345: whenever the <em class="replaceable"><code>pkg</code></em>
5346: <code class="filename">buildlink3.mk</code>
1.18 snj 5347: file is included. Dependencies are only added for directly
5348: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 5349: <p>When providing a <code class="filename">buildlink3.mk</code> and
5350: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 5351: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 5352: header files are automatically exposed when the package is
5353: use.</p>
5354: <p>In particular, if only an executable
5355: (<code class="filename">bin/foo</code>) is linked against a library, that
5356: library does not need to be propagated in the
5357: <code class="filename">buildlink3.mk</code> file.</p>
5358: <p>The following steps should help you decide if a
5359: <code class="filename">buildlink3.mk</code> file needs to be included:
5360: </p>
5361: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5362: <li class="listitem"><p>Look at the installed header files: What
5363: headers do they include? The packages providing these files
5364: must be buildlinked.</p></li>
1.49 wiz 5365: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5366: libraries and look against what other libraries they link.
5367: Some of the packages providing these probably need to be
5368: buildlinked; however, it's not automatic, since e.g. GTK on
5369: some systems pulls in the X libraries, so they will show up in
5370: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 5371: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 5372: used as a hint.</p></li>
1.47 wiz 5373: </ul></div>
5374: <p>
5375: </p>
1.1 dsieger 5376: </div>
1.41 asau 5377: <div class="sect2">
1.1 dsieger 5378: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 5379: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 5380: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5381: and
5382: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5383: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5384: <p>These two variables differ in that one describes source
5385: compatibility (API) and the other binary compatibility (ABI).
5386: The difference is that a change in the API breaks compilation of
5387: programs while changes in the ABI stop compiled programs from
5388: running.</p>
5389: <p>Changes to the
1.27 wiz 5390: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5391: variable in a <code class="filename">buildlink3.mk</code> file happen
5392: very rarely. One possible reason is that all packages depending
5393: on this already need a newer version. In case it is bumped see
5394: the description below.</p>
5395: <p>The most common example of an ABI change is that the major
5396: version of a shared library is increased. In this case,
5397: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5398: should be adjusted to require at least the new package version.
5399: Then the packages that depend on this package need their
5400: <code class="varname">PKGREVISION</code>s increased and, if they have
5401: <code class="filename">buildlink3.mk</code> files, their
5402: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5403: adjusted, too. This is needed so pkgsrc will require the correct
5404: package dependency and not settle for an older one when building
5405: the source.</p>
1.10 hubertf 5406: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.26 wiz 5407: more information about dependencies on other packages,
5408: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 5409: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5410: <p>Please take careful consideration before adjusting
5411: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5412: or
5413: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5414: as we don't want to cause unneeded package deletions and
5415: rebuilds. In many cases, new versions of packages work just
5416: fine with older dependencies.</p>
5417: <p>Also it is not needed to set
1.26 wiz 5418: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5419: when it is identical to
1.1 dsieger 5420: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5421: </div>
5422: </div>
1.41 asau 5423: <div class="sect1">
1.1 dsieger 5424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5425: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5426: <p>Some packages in pkgsrc install headers and libraries that
5427: coincide with headers and libraries present in the base system.
5428: Aside from a <code class="filename">buildlink3.mk</code> file, these
5429: packages should also include a <code class="filename">builtin.mk</code>
5430: file that includes the necessary checks to decide whether using
5431: the built-in software or the pkgsrc software is
5432: appropriate.</p>
5433: <p>The only requirements of a builtin.mk file for
5434: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 5435: <div class="orderedlist"><ol class="orderedlist" type="1">
5436: <li class="listitem"><p>It should set
1.1 dsieger 5437: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5438: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 5439: after it is included.</p></li>
1.23 wiz 5440: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 5441: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5442: which is already set before the
5443: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 5444: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 5445: is <span class="emphasis"><em>very</em></span> important and takes careful
5446: attention to <code class="filename">Makefile</code> coding.</p></li>
5447: </ol></div>
1.41 asau 5448: <div class="sect2">
1.1 dsieger 5449: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5450: <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 5451: <p>The following is the recommended template for builtin.mk
5452: files:</p>
5453: <pre class="programlisting">
5454: .if !defined(IS_BUILTIN.foo)
5455: #
5456: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5457: # genuinely exists in the system or not.
5458: #
5459: IS_BUILTIN.foo?= no
5460:
5461: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5462: # version can be determined.
5463: #
5464: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5465: BUILTIN_PKG.foo?= foo-1.0
5466: . endif
5467: .endif # IS_BUILTIN.foo
5468:
5469: .if !defined(USE_BUILTIN.foo)
5470: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5471: . if defined(BUILTIN_PKG.foo)
5472: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5473: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5474: USE_BUILTIN.foo!= \
5475: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5476: && ${ECHO} "yes" || ${ECHO} "no"
5477: . endif
5478: . endfor
5479: . endif
5480: .endif # USE_BUILTIN.foo
5481:
5482: CHECK_BUILTIN.foo?= no
5483: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5484: #
5485: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5486: # "yes" or "no".
5487: #
5488: .endif # CHECK_BUILTIN.foo
5489: </pre>
5490: <p>The first section sets
5491: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5492: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5493: in the base system. This should not be a base system software
5494: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5495: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5496: included as part of the base system. This variable is only
5497: used internally within the <code class="filename">builtin.mk</code>
5498: file.</p>
5499: <p>The second section sets
5500: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5501: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5502: system if it exists (if
5503: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5504: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5505: within the <code class="filename">builtin.mk</code> file.</p>
5506: <p>The third section sets
5507: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5508: and is <span class="emphasis"><em>required</em></span> in all
5509: <code class="filename">builtin.mk</code> files. The code in this
5510: section must make the determination whether the built-in
5511: software is adequate to satisfy the dependencies listed in
5512: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5513: This is typically done by comparing
5514: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5515: against each of the dependencies in
5516: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5517: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5518: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5519: end of the <code class="filename">builtin.mk</code> file. Note that
5520: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5521: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5522: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5523: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5524: that the built-in version of the software is similar enough to
5525: be used as a replacement.</p>
5526: <p>The last section is guarded by
5527: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5528: and includes code that uses the value of
5529: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5530: set in the previous section. This typically includes, e.g.,
5531: adding additional dependency restrictions and listing additional
5532: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5533: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5534: </div>
1.41 asau 5535: <div class="sect2">
1.1 dsieger 5536: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5537: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5538: <p>When building packages, it's possible to choose whether to set
5539: a global preference for using either the built-in (native)
5540: version or the pkgsrc version of software to satisfy a
5541: dependency. This is controlled by setting
5542: <code class="varname">PREFER_PKGSRC</code> and
5543: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5544: 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 5545: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5546: use the pkgsrc versions of software, while
5547: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5548: built-in versions. Preferences are determined by the most
5549: specific instance of the package in either
5550: <code class="varname">PREFER_PKGSRC</code> or
5551: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5552: in neither or in both variables, then
5553: <code class="varname">PREFER_PKGSRC</code> has precedence over
5554: <code class="varname">PREFER_NATIVE</code>. For example, to require
5555: using pkgsrc versions of software for all but the most basic
5556: bits on a NetBSD system, you can set:</p>
5557: <pre class="programlisting">
5558: PREFER_PKGSRC= yes
5559: PREFER_NATIVE= getopt skey tcp_wrappers
5560: </pre>
5561: <p>A package <span class="emphasis"><em>must</em></span> have a
5562: <code class="filename">builtin.mk</code>
5563: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5564: otherwise it is simply ignored in that list.</p>
5565: </div>
5566: </div>
5567: </div>
1.41 asau 5568: <div class="chapter">
1.1 dsieger 5569: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5570: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5571: <div class="toc">
5572: <p><b>Table of Contents</b></p>
5573: <dl>
1.6 rillig 5574: <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 5575: <dd><dl>
1.6 rillig 5576: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5577: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5578: </dl></dd>
1.6 rillig 5579: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5580: <dd><dl>
1.23 wiz 5581: <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 5582: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5583: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5584: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5585: </dl></dd>
5586: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5587: <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>
5588: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5589: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5590: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5591: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5592: <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 5593: </dl>
5594: </div>
5595: <p>This chapter describes the framework known as
5596: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5597: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5598: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5599: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5600: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5601: provided that packages are correctly designed.</p></li>
1.23 wiz 5602: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5603: <li class="listitem"><p>Registration of system users and groups.</p></li>
5604: <li class="listitem"><p>Registration of system shells.</p></li>
5605: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5606: </ul></div>
5607: <p>The following sections inspect each of the above points in detail.</p>
5608: <p>You may be thinking that many of the things described here could be
5609: easily done with simple code in the package's post-installation target
5610: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5611: as the code in them is only executed when building from source. Machines
5612: using binary packages could not benefit from it at all (as the code itself
5613: could be unavailable). Therefore, the only way to achieve any of the items
5614: described above is by means of the installation scripts, which are
5615: automatically generated by pkginstall.</p>
1.41 asau 5616: <div class="sect1">
1.1 dsieger 5617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5618: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5619: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5620: of files and directories that belong to a package. The names used in it
5621: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5622: which means that it cannot register files outside this directory (absolute
5623: path names are not allowed). Despite this restriction, some packages need
5624: to install files outside this location; e.g., under
5625: <code class="filename">${VARBASE}</code> or
5626: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5627: is to create such files during installation time by using
5628: installation scripts.</p>
5629: <p>The generic installation scripts are shell scripts that can
5630: contain arbitrary code. The list of scripts to execute is taken from
5631: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5632: <code class="filename">INSTALL</code>. A similar variable exists for package
5633: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5634: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5635: commands, so they have the potential to create and manage files
5636: anywhere in the file system.</p>
5637: <p>Using these general installation files is not recommended, but
5638: may be needed in some special cases. One reason for avoiding them is
5639: that the user has to trust the packager that there is no unwanted or
5640: simply erroneous code included in the installation script. Also,
5641: previously there were many similar scripts for the same functionality,
5642: and fixing a common error involved finding and changing all of
5643: them.</p>
5644: <p>The pkginstall framework offers another, standardized way. It
5645: provides generic scripts to abstract the manipulation of such files
5646: and directories based on variables set in the package's
5647: <code class="filename">Makefile</code>. The rest of this section describes
5648: these variables.</p>
1.41 asau 5649: <div class="sect2">
1.1 dsieger 5650: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5651: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5652: <p>The following variables can be set to request the creation of
5653: directories anywhere in the file system:</p>
1.41 asau 5654: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5655: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5656: contain a list of directories that should be created and should attempt
5657: to be destroyed by the installation scripts. The difference between
5658: the two is that the latter prompts the administrator to remove any
5659: directories that may be left after deinstallation (because they were
5660: not empty), while the former does not.</p></li>
1.23 wiz 5661: <li class="listitem">
1.1 dsieger 5662: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5663: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5664: which directories should be created and should attempt to be destroyed
5665: by the installation scripts. Each tuple holds the following values,
5666: separated by spaces: the directory name, its owner, its group and its
5667: numerical mode. For example:</p>
5668: <pre class="programlisting">
5669: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5670: </pre>
5671: <p>The difference between the two is exactly the same as their
5672: non-<code class="varname">PERMS</code> counterparts.</p>
5673: </li>
5674: </ul></div>
5675: </div>
1.41 asau 5676: <div class="sect2">
1.1 dsieger 5677: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5678: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5679: <p>Creating non-empty files outside the installation prefix is tricky
5680: because the <code class="filename">PLIST</code> forces all files to be inside it.
5681: To overcome this problem, the only solution is to extract the file in the
5682: known place (i.e., inside the installation prefix) and copy it to the
5683: appropriate location during installation (done by the installation scripts
5684: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5685: file</em></span> in the following paragraphs, which describe the variables
5686: that can be used to automatically and consistently handle files outside the
5687: installation prefix:</p>
1.41 asau 5688: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5689: <li class="listitem">
1.1 dsieger 5690: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5691: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5692: During installation time, the master file is copied to the target one
5693: if and only if the latter does not exist. Upon deinstallation, the
5694: target file is removed provided that it was not modified by the
5695: installation.</p>
5696: <p>The difference between the two is that the latter prompts the
5697: administrator to remove any files that may be left after
5698: deinstallation (because they were not empty), while the former does
5699: not.</p>
5700: </li>
1.23 wiz 5701: <li class="listitem">
1.1 dsieger 5702: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5703: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5704: files as well as their target locations. For each of them, it also
5705: specifies their owner, their group and their numeric permissions, in
5706: this order. For example:</p>
5707: <pre class="programlisting">
1.30 wiz 5708: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 dsieger 5709: </pre>
5710: <p>The difference between the two is exactly the same as their
5711: non-<code class="varname">PERMS</code> counterparts.</p>
5712: </li>
5713: </ul></div>
5714: </div>
5715: </div>
1.41 asau 5716: <div class="sect1">
1.1 dsieger 5717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5718: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5719: <p>Configuration files are special in the sense that they are installed
5720: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5721: need special treatment during installation (most of which is automated by
5722: pkginstall). The main concept you must bear in mind is that files marked
5723: as configuration files are automatically copied to the right place (somewhere
5724: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5725: and only if</em></span> they didn't exist before. Similarly, they will not
5726: be removed if they have local modifications. This ensures that
5727: administrators never lose any custom changes they may have made.</p>
1.41 asau 5728: <div class="sect2">
1.1 dsieger 5729: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5730: <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 5731: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5732: specifies where configuration files shall be installed. Its contents are
5733: set based upon the following variables:</p>
1.41 asau 5734: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5735: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5736: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5737: be overridden by the user to point to his preferred location (e.g.,
5738: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5739: Packages must not use it directly.</p></li>
1.23 wiz 5740: <li class="listitem">
1.1 dsieger 5741: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5742: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5743: for the package being built shall be installed. The definition of this
5744: variable only makes sense in the package's
5745: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5746: <p>As an example, consider the Apache package,
5747: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
5748: configuration files under the
5749: <code class="filename">httpd/</code> subdirectory of
5750: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5751: Makefile.</p>
5752: </li>
1.23 wiz 5753: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5754: variable that holds this package's configuration directory (if
5755: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5756: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5757: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5758: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5759: directory where the configuration files for the package identified by
5760: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5761: </ul></div>
5762: <p>Based on the above variables, pkginstall determines the value of
5763: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5764: variable that can be used within a package to refer to its configuration
5765: directory. The algorithm used to set its value is basically the
5766: following:</p>
1.23 wiz 5767: <div class="orderedlist"><ol class="orderedlist" type="1">
5768: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5769: its value is used.</p></li>
1.23 wiz 5770: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5771: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5772: <code class="filename">Makefile</code>, the resulting value is
5773: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5774: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5775: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5776: </ol></div>
5777: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5778: 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
5779: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5780: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5781: </div>
1.41 asau 5782: <div class="sect2">
1.1 dsieger 5783: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5784: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5785: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5786: known place, you need to teach each package where it shall install its
5787: files. In some cases you will have to patch the package Makefiles to
5788: achieve it. If you are lucky, though, it may be as easy as passing an
5789: extra flag to the configuration script; this is the case of GNU Autoconf-
5790: generated files:</p>
5791: <pre class="programlisting">
5792: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5793: </pre>
5794: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5795: for</em></span> its configuration files, not where they will be originally
5796: installed (although the difference is never explicit,
5797: unfortunately).</p>
5798: </div>
1.41 asau 5799: <div class="sect2">
1.1 dsieger 5800: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5801: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5802: <p>As said before, pkginstall automatically handles configuration files.
5803: This means that <span class="strong"><strong>the packages themselves must not
5804: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5805: directly</strong></span>. Bad news is that many software installation scripts
5806: will, out of the box, mess with the contents of that directory. So what is
5807: the correct procedure to fix this issue?</p>
5808: <p>You must teach the package (usually by manually patching it) to
5809: install any configuration files under the examples hierarchy,
5810: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5811: <code class="filename">PLIST</code> registers them and the administrator always
5812: has the original copies available.</p>
5813: <p>Once the required configuration files are in place (i.e., under the
5814: examples hierarchy), the pkginstall framework can use them as master copies
5815: during the package installation to update what is in
5816: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5817: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5818: 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 5819: about their syntax and their purpose. Here is an example, taken from the
5820: <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>
5821: <pre class="programlisting">
5822: EGDIR= ${PREFIX}/share/doc/mutt/samples
5823: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5824: </pre>
5825: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5826: package and has no meaning outside it.</p>
5827: </div>
1.41 asau 5828: <div class="sect2">
1.1 dsieger 5829: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5830: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5831: <p>The automatic copying of config files can be toggled by setting the
5832: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5833: installation.</p>
5834: </div>
5835: </div>
1.41 asau 5836: <div class="sect1">
1.1 dsieger 5837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5838: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5839: <p>System startup scripts are special files because they must be
5840: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5841: 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 5842: can be used. However, pkginstall provides a special mechanism to handle
5843: these files.</p>
5844: <p>In order to provide system startup scripts, the package has
5845: to:</p>
1.23 wiz 5846: <div class="orderedlist"><ol class="orderedlist" type="1">
5847: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5848: the <code class="literal">.sh</code> suffix appended. Considering the
5849: <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
5850: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5851: <li class="listitem">
1.1 dsieger 5852: <p>Tell pkginstall to handle it, appending the name of the script,
5853: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5854: Continuing the previous example:</p>
5855: <pre class="programlisting">
5856: RCD_SCRIPTS+= cupsd
5857: </pre>
5858: </li>
5859: </ol></div>
5860: <p>Once this is done, pkginstall will do the following steps for each
5861: script in an automated fashion:</p>
1.23 wiz 5862: <div class="orderedlist"><ol class="orderedlist" type="1">
5863: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5864: substitutions described in the <code class="filename">FILES_SUBST</code>
5865: variable.</p></li>
1.23 wiz 5866: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5867: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5868: that this master file must be explicitly registered in the
5869: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5870: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5871: from the examples hierarchy into the system-wide startup scripts
5872: directory.</p></li>
5873: </ol></div>
1.41 asau 5874: <div class="sect2">
1.1 dsieger 5875: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5876: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5877: <p>The automatic copying of config files can be toggled by setting the
5878: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5879: installation. Note that the scripts will be always copied inside the
5880: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5881: matter what the value of this variable is.</p>
5882: </div>
5883: </div>
1.41 asau 5884: <div class="sect1">
1.1 dsieger 5885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5886: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5887: <p>If a package needs to create special users and/or groups during
5888: installation, it can do so by using the pkginstall framework.</p>
5889: <p>Users can be created by adding entries to the
5890: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5891: syntax:</p>
5892: <pre class="programlisting">
5893: user:group
5894: </pre>
5895: <p>Further specification of user details may be done by setting
5896: per-user variables.
5897: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5898: numeric UID for the user.
5899: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5900: user's description or comment.
5901: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5902: user's home directory, and defaults to
5903: <code class="filename">/nonexistent</code> if not specified.
5904: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5905: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5906: not specified.</p>
5907: <p>Similarly, groups can be created by adding entries to the
5908: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5909: <pre class="programlisting">
5910: group
5911: </pre>
5912: <p>The numeric GID of the group may be set by defining
5913: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5914: <p>If a package needs to create the users and groups at an earlier
5915: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5916: either <code class="literal">configure</code> or <code class="literal">build</code> to
5917: indicate the phase before which the users and groups are created. In
5918: this case, the numeric UIDs and GIDs of the created users and groups
5919: are automatically hardcoded into the final installation scripts.</p>
5920: </div>
1.41 asau 5921: <div class="sect1">
1.1 dsieger 5922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5923: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5924: <p>Packages that install system shells should register them in the shell
5925: database, <code class="filename">/etc/shells</code>, to make things easier to the
5926: administrator. This must be done from the installation scripts to keep
5927: binary packages working on any system. pkginstall provides an easy way to
5928: accomplish this task.</p>
5929: <p>When a package provides a shell interpreter, it has to set the
5930: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5931: add some hooks to the installation scripts to handle it. Consider the
5932: 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>
5933: <pre class="programlisting">
5934: PKG_SHELL= ${PREFIX}/bin/zsh
5935: </pre>
1.41 asau 5936: <div class="sect2">
1.1 dsieger 5937: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5938: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5939: <p>The automatic registration of shell interpreters can be disabled by
5940: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5941: environment variable to <code class="literal">NO</code>.</p>
5942: </div>
5943: </div>
1.41 asau 5944: <div class="sect1">
1.1 dsieger 5945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5946: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5947: <p>Packages that install X11 fonts should update the database files
5948: that index the fonts within each fonts directory. This can easily be
5949: accomplished within the pkginstall framework.</p>
5950: <p>When a package installs X11 fonts, it must list the directories in
5951: which fonts are installed in the
5952: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5953: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5954: <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 5955: installation scripts to run the appropriate commands to update the fonts
5956: database files within each of those directories. For convenience, if the
5957: directory path is relative, it is taken to be relative to the package's
5958: 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>
5959: <pre class="programlisting">
5960: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
5961: </pre>
1.41 asau 5962: <div class="sect2">
1.1 dsieger 5963: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5964: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5965: <p>The automatic update of fonts databases can be disabled by
5966: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5967: environment variable to <code class="literal">NO</code>.</p>
5968: </div>
5969: </div>
5970: </div>
1.41 asau 5971: <div class="chapter">
1.1 dsieger 5972: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5973: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5974: <div class="toc">
5975: <p><b>Table of Contents</b></p>
5976: <dl>
1.6 rillig 5977: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5978: <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 5979: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5980: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5981: </dl>
5982: </div>
5983: <p>Many packages have the ability to be built to support different
5984: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5985: in pkgsrc that provides generic handling of those options that
5986: determine different ways in which the packages can be built. It's
5987: possible for the user to specify exactly which sets of options will be
5988: built into a package or to allow a set of global default options
5989: apply.</p>
1.7 rillig 5990: <p>There are two broad classes of behaviors that one might want to
5991: control via options. One is whether some particular feature is
5992: enabled in a program that will be built anyway, often by including or
5993: not including a dependency on some other package. The other is
5994: whether or not an additional program will be built as part of the
5995: package. Generally, it is better to make a split package for such
5996: additional programs instead of using options, because it enables
5997: binary packages to be built which can then be added separately. For
5998: example, the foo package might have minimal dependencies (those
5999: packages without which foo doesn't make sense), and then the foo-gfoo
6000: package might include the GTK frontend program gfoo. This is better
6001: than including a gtk option to foo that adds gfoo, because either that
6002: option is default, in which case binary users can't get foo without
6003: gfoo, or not default, in which case they can't get gfoo. With split
6004: packages, they can install foo without having GTK, and later decide to
6005: install gfoo (pulling in GTK at that time). This is an advantage to
6006: source users too, avoiding the need for rebuilds.</p>
6007: <p>Plugins with widely varying dependencies should usually be split
6008: instead of options.</p>
6009: <p>It is often more work to maintain split packages, especially if
6010: the upstream package does not support this. The decision of split
6011: vs. option should be made based on the likelihood that users will want
6012: or object to the various pieces, the size of the dependencies that are
6013: included, and the amount of work.</p>
6014: <p>A further consideration is licensing. Non-free parts, or parts
6015: that depend on non-free dependencies (especially plugins) should
6016: almost always be split if feasible.</p>
1.41 asau 6017: <div class="sect1">
1.1 dsieger 6018: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6019: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6020: <p>Global default options are listed in
6021: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6022: that should be built into every package if that option is supported.
1.10 hubertf 6023: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6024: </div>
1.41 asau 6025: <div class="sect1">
1.1 dsieger 6026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6027: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6028: </h2></div></div></div>
6029: <p>The following example shows how
6030: <code class="filename">bsd.options.mk</code> should be used
6031: by the hypothetical ``wibble'' package, either in the package
6032: <code class="filename">Makefile</code>, or in a file,
6033: e.g. <code class="filename">options.mk</code>, that is included by the
6034: main package <code class="filename">Makefile</code>.</p>
6035: <pre class="programlisting">
6036: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6037: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6038: PKG_OPTIONS_OPTIONAL_GROUPS= database
6039: PKG_OPTIONS_GROUP.database= mysql pgsql
6040: PKG_SUGGESTED_OPTIONS= wibble-foo
6041: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6042: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6043:
6044: .include "../../mk/bsd.prefs.mk"
6045:
6046: # this package was previously named wibble2
6047: .if defined(PKG_OPTIONS.wibble2)
6048: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6049: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6050: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6051: .endif
6052:
6053: .include "../../mk/bsd.options.mk"
6054:
6055: # Package-specific option-handling
6056:
6057: ###
6058: ### FOO support
6059: ###
6060: .if !empty(PKG_OPTIONS:Mwibble-foo)
6061: CONFIGURE_ARGS+= --enable-foo
6062: .endif
6063:
6064: ###
6065: ### LDAP support
6066: ###
6067: .if !empty(PKG_OPTIONS:Mldap)
6068: . include "../../databases/openldap-client/buildlink3.mk"
6069: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6070: .endif
6071:
6072: ###
6073: ### database support
6074: ###
6075: .if !empty(PKG_OPTIONS:Mmysql)
6076: . include "../../mk/mysql.buildlink3.mk"
6077: .endif
6078: .if !empty(PKG_OPTIONS:Mpgsql)
6079: . include "../../mk/pgsql.buildlink3.mk"
6080: .endif
6081: </pre>
6082: <p>The first section contains the information about which build
6083: options are supported by the package, and any default options settings
6084: if needed.</p>
1.23 wiz 6085: <div class="orderedlist"><ol class="orderedlist" type="1">
6086: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.29 dholland 6087: <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 6088: options. It should be set to
6089: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6090: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6091: at the point where the options are processed.</p></li>
1.23 wiz 6092: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 6093: build options supported by the package.</p></li>
1.23 wiz 6094: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 6095: list of names of groups of mutually exclusive options. The options in
6096: each group are listed in
6097: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6098: The most specific setting of any option from the group takes
6099: precedence over all other options in the group. Options from the
6100: groups will be automatically added to
6101: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 6102: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 6103: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6104: packages will fail if no option from the group is
6105: selected.</p></li>
1.23 wiz 6106: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 6107: of names of sets of options. At least one option from each set must
6108: be selected. The options in each set are listed in
6109: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6110: Options from the sets will be automatically added to
6111: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6112: fail if no option from the set is selected.</p></li>
1.23 wiz 6113: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 6114: build options which are enabled by default.</p></li>
1.23 wiz 6115: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 6116: of
1.23 wiz 6117: <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 6118: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6119: their option counterparts. Pairs should be added with
1.23 wiz 6120: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 6121: warning will be issued if the user uses a legacy
6122: variable.</p></li>
1.23 wiz 6123: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 6124: of
1.23 wiz 6125: <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 6126: pairs that map options that have been renamed to their new
1.23 wiz 6127: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 6128: the listing of global legacy options. A warning will be issued if
6129: the user uses a legacy option.</p></li>
1.23 wiz 6130: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 6131: options implied by deprecated variables used. This can be used for
6132: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6133: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6134: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 6135: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 6136: a list of warnings about deprecated variables or options used, and
6137: what to use instead.</p></li>
6138: </ol></div>
6139: <p>A package should never modify
6140: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6141: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6142: To suggest a default set of options, use
6143: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6144: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6145: including <code class="filename">bsd.options.mk</code>. If none of
6146: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6147: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6148: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6149: happen with platform-specific options if none of them is supported on
6150: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6151: empty list and the package is otherwise treated as not using the
6152: options framework.</p>
6153: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6154: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6155: build options, properly filtered to remove unsupported and duplicate
6156: options.</p>
6157: <p>The remaining sections contain the logic that is specific to
6158: each option. The correct way to check for an option is to check
6159: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6160: <pre class="programlisting">
6161: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6162: </pre>
6163: </div>
1.41 asau 6164: <div class="sect1">
1.1 dsieger 6165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6166: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6167: <p>Options that enable similar features in different packages (like
6168: optional support for a library) should use a common name in all
6169: packages that support it (like the name of the library). If another
6170: package already has an option with the same meaning, use the same
6171: name.</p>
6172: <p>Options that enable features specific to one package, where it's
6173: unlikely that another (unrelated) package has the same (or a similar)
6174: optional feature, should use a name prefixed with
6175: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6176: <p>If a group of related packages share an optional feature
6177: specific to that group, prefix it with the name of the
1.23 wiz 6178: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 6179: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6180: <p>For new options, add a line to
6181: <code class="filename">mk/defaults/options.description</code>. Lines have two
6182: fields, separated by tab. The first field is the option name, the
6183: second its description. The description should be a whole sentence
6184: (starting with an uppercase letter and ending with a period) that
1.23 wiz 6185: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6186: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 6187: </div>
1.41 asau 6188: <div class="sect1">
1.7 rillig 6189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6190: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 6191: <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 6192: different dependencies based on the options with which the package was
6193: built. For querying these options, the file
6194: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6195: typical example looks like this:</p>
6196: <pre class="programlisting">
6197: pkgbase := libpurple
6198: .include "../../mk/pkg-build-options.mk"
6199:
6200: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6201: ...
6202: .endif
6203: </pre>
6204: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6205: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6206: options of the libpurple package, which can then be queried like
6207: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6208: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6209: details.</p>
6210: </div>
1.1 dsieger 6211: </div>
1.41 asau 6212: <div class="chapter">
1.1 dsieger 6213: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6214: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6215: <div class="toc">
6216: <p><b>Table of Contents</b></p>
6217: <dl>
1.6 rillig 6218: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6219: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6220: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6221: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 6222: <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 6223: <dd><dl>
6224: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6225: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6226: </dl></dd>
1.23 wiz 6227: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6228: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6229: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6230: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6231: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6232: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6233: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6234: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6235: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6236: <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 6237: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6238: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6239: </dl>
6240: </div>
1.41 asau 6241: <div class="sect1">
1.1 dsieger 6242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6243: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6244: <p>This chapter gives a detailed description on how a package is
6245: built. Building a package is separated into different
6246: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6247: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 6248: described in the following sections. Each phase is split into
1.1 dsieger 6249: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6250: containing phase, prefixed by one of <code class="varname">pre-</code>,
6251: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6252: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6253: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6254: <p>Never override the regular targets (like
6255: <code class="varname">fetch</code>), if you have to, override the
6256: <code class="varname">do-*</code> ones instead.</p>
6257: <p>The basic steps for building a program are always the same. First
6258: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6259: the local system and then extracted. After any pkgsrc-specific patches
6260: to compile properly are applied, the software can be configured, then
6261: built (usually by compiling), and finally the generated binaries, etc.
6262: can be put into place on the system.</p>
6263: <p>To get more details about what is happening at each step,
6264: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6265: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6266: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6267: </div>
1.41 asau 6268: <div class="sect1">
1.1 dsieger 6269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6270: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6271: <p>Before outlining the process performed by the NetBSD package system in
6272: the next section, here's a brief discussion on where programs are
6273: installed, and which variables influence this.</p>
6274: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6275: where all files of the final program shall be installed. It is
6276: usually set to <code class="varname">LOCALBASE</code>
6277: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6278: for pkgs in the <code class="filename">cross</code> category. The value of
6279: <code class="varname">PREFIX</code> needs to be put
6280: into the various places in the program's source where paths to
1.10 hubertf 6281: 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 6282: <p>When choosing which of these variables to use,
6283: follow the following rules:</p>
1.41 asau 6284: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6285: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 6286: where the current pkg will be installed. When referring to a
6287: pkg's own installation path, use
1.23 wiz 6288: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6289: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 6290: are installed. If you need to construct a -I or -L argument
6291: to the compiler to find includes and libraries installed by
1.23 wiz 6292: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 6293: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6294: installed all packages in <code class="filename">/usr/local</code>. As
6295: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6296: administrator, this variable is a misnomer.</p></li>
1.23 wiz 6297: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 6298: distribution (from xsrc, etc.) is installed. When looking for
6299: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 6300: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6301: <li class="listitem">
1.1 dsieger 6302: <p>X11-based packages are special in that they may be
6303: installed in either <code class="varname">X11BASE</code> or
6304: <code class="varname">LOCALBASE</code>.</p>
6305: <p>Usually, X11 packages should be installed under
6306: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6307: will need to include
6308: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6309: request the presence of X11 and to get the right compilation
6310: flags.</p>
6311: <p>Even though, there are some packages that cannot be installed
6312: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6313: files. These packages are special and they must be placed under
6314: <code class="varname">X11BASE</code>. To accomplish this, set either
6315: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6316: your package.</p>
6317: <p>Some notes: If you need
6318: to find includes or libraries installed by a pkg that has
6319: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6320: its pkg <code class="filename">Makefile</code>, you need to look in
6321: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6322: <code class="filename">${LOCALBASE}</code>. To force installation of
6323: all X11 packages in <code class="varname">LOCALBASE</code>, the
6324: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6325: is enabled by default.</p>
6326: </li>
1.23 wiz 6327: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1 dsieger 6328: the installed location of an X11
6329: package. <code class="varname">X11PREFIX</code> will be set to
6330: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6331: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6332: installed.</p></li>
1.23 wiz 6333: <li class="listitem">
1.1 dsieger 6334: <p>If xpkgwedge is installed, it is possible to have some
6335: packages installed in <code class="varname">X11BASE</code> and some in
6336: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6337: installed package, the <code class="varname">EVAL_PREFIX</code>
6338: definition can be used. It takes pairs in the format
1.29 dholland 6339: <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 6340: variable <code class="varname">DIRNAME</code> will be set to the prefix
6341: of the installed package <package>, or
1.23 wiz 6342: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.1 dsieger 6343: installed.</p>
6344: <p>This is best illustrated by example.</p>
6345: <p>The following lines are taken from
6346: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6347: <pre class="programlisting">
6348: EVAL_PREFIX+= GTKDIR=gtk+
6349: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6350: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6351: CONFIGURE_ARGS+= --enable-multibyte
6352: </pre>
6353: <p>Specific defaults can be defined for the packages
6354: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6355: definition of the form:</p>
6356: <pre class="programlisting">
6357: GTKDIR_DEFAULT= ${LOCALBASE}
6358: </pre>
6359: <p>where <code class="varname">GTKDIR</code> corresponds
6360: to the first definition in
6361: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6362: </li>
1.23 wiz 6363: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.29 dholland 6364: 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 6365: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6366: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6367: </ul></div>
6368: </div>
1.41 asau 6369: <div class="sect1">
1.1 dsieger 6370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6371: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 6372: <p>When building a package, various directories are used to store
1.1 dsieger 6373: source files, temporary files, pkgsrc-internal files, and so on. These
6374: directories are explained here.</p>
6375: <p>Some of the directory variables contain relative pathnames. There
6376: are two common base directories for these relative directories:
6377: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6378: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6379: inside the package itself.</p>
1.41 asau 6380: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6381: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6382: <dd><p>This is an absolute pathname that points to the pkgsrc
6383: root directory. Generally, you don't need
6384: it.</p></dd>
6385: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6386: <dd><p>This is an absolute pathname that points to the
6387: current package.</p></dd>
6388: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6389: <dd><p>This is a pathname relative to
6390: <code class="varname">PKGSRCDIR</code> that points to the current
6391: package.</p></dd>
6392: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6393: <dd><p>This is an absolute pathname pointing to the directory
6394: where all work takes place. The distfiles are extracted to this
6395: directory. It also contains temporary directories and log files used by
6396: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6397: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6398: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6399: <dd><p>This is an absolute pathname pointing to the directory
6400: where the distfiles are extracted. It is usually a direct subdirectory
6401: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6402: that isn't hidden. This variable may be changed by a package
6403: <code class="filename">Makefile</code>.</p></dd>
6404: </dl></div>
1.14 jmcneill 6405: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6406: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 6407: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 6408: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6409: If users would like to have their pkgsrc trees behave in a
6410: read-only manner, then the value of
6411: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6412: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 6413: </div>
1.41 asau 6414: <div class="sect1">
1.1 dsieger 6415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6416: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 6417: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6418: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6419: phase. This will automatically run all phases that are required for this
6420: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6421: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6422: the package will be built, but not installed.</p>
6423: </div>
1.41 asau 6424: <div class="sect1">
1.1 dsieger 6425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6426: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6427: <p>The first step in building a package is to fetch the
6428: distribution files (distfiles) from the sites that are providing
6429: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6430: phase.</p>
1.41 asau 6431: <div class="sect2">
1.1 dsieger 6432: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6433: <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 6434: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6435: defines all URLs from where the distfile, whose name is
6436: derived from the <code class="varname">DISTNAME</code> variable, is
6437: fetched. The more complicated cases are described
6438: below.</p>
6439: <p>The variable <code class="varname">DISTFILES</code> specifies
6440: the list of distfiles that have to be fetched. Its value
1.66 ! asau 6441: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
! 6442: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 6443: so that most packages don't need to define it at all.
6444: <code class="varname">EXTRACT_SUFX</code> is
6445: <code class="literal">.tar.gz</code> by default, but can be changed
6446: freely. Note that if your package requires additional
6447: distfiles to the default one, you cannot just append the
6448: additional filenames using the <code class="literal">+=</code>
6449: operator, but you have write for example:</p>
6450: <pre class="programlisting">
1.66 ! asau 6451: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 6452: </pre>
6453: <p>Each distfile is fetched from a list of sites, usually
6454: <code class="varname">MASTER_SITES</code>. If the package has multiple
6455: <code class="varname">DISTFILES</code> or multiple
6456: <code class="varname">PATCHFILES</code> from different sites, you can
6457: set
6458: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6459: to the list of URLs where the file
6460: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6461: (including the suffix) can be found.</p>
6462: <pre class="programlisting">
6463: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6464: DISTFILES+= foo-file.tar.gz
6465: SITES.foo-file.tar.gz= \
6466: http://www.somewhere.com/somehow/ \
6467: http://www.somewhereelse.com/mirror/somehow/
6468: </pre>
6469: <p>When actually fetching the distfiles, each item from
6470: <code class="varname">MASTER_SITES</code> or
6471: <code class="varname">SITES.*</code> gets the name of each distfile
6472: appended to it, without an intermediate slash. Therefore,
6473: all site values have to end with a slash or other separator
6474: character. This allows for example to set
6475: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6476: that gets the name of the distfile as a parameter. In this
6477: case, the definition would look like:</p>
6478: <pre class="programlisting">
6479: MASTER_SITES= http://www.example.com/download.cgi?file=
6480: </pre>
1.22 jakllsch 6481: <p> The exception to this rule are URLs starting with a dash.
1.66 ! asau 6482: In that case the URL is taken as is, fetched and the result
! 6483: stored under the name of the distfile. You can use this style
! 6484: for the case when the download URL style does not match the
! 6485: above common case. For example, if permanent download URL is a
! 6486: redirector to the real download URL, or the download file name
! 6487: is offered by an HTTP Content-Disposition header. In the
! 6488: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
! 6489: created instead of the default
! 6490: <code class="filename">v1.0.0.tar.gz</code>.</p>
! 6491: <pre class="programlisting">
! 6492: DISTNAME= foo-1.0.0
! 6493: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
! 6494: </pre>
1.1 dsieger 6495: <p>There are some predefined values for
6496: <code class="varname">MASTER_SITES</code>, which can be used in
6497: packages. The names of the variables should speak for
6498: themselves.</p>
6499: <pre class="programlisting">
6500: ${MASTER_SITE_APACHE}
6501: ${MASTER_SITE_BACKUP}
6502: ${MASTER_SITE_CYGWIN}
6503: ${MASTER_SITE_DEBIAN}
6504: ${MASTER_SITE_FREEBSD}
6505: ${MASTER_SITE_FREEBSD_LOCAL}
6506: ${MASTER_SITE_GENTOO}
6507: ${MASTER_SITE_GNOME}
6508: ${MASTER_SITE_GNU}
6509: ${MASTER_SITE_GNUSTEP}
1.66 ! asau 6510: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 6511: ${MASTER_SITE_IFARCHIVE}
6512: ${MASTER_SITE_KDE}
6513: ${MASTER_SITE_MOZILLA}
1.66 ! asau 6514: ${MASTER_SITE_MOZILLA_ALL}
! 6515: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 6516: ${MASTER_SITE_MYSQL}
1.66 ! asau 6517: ${MASTER_SITE_NETLIB}
1.1 dsieger 6518: ${MASTER_SITE_OPENOFFICE}
6519: ${MASTER_SITE_PERL_CPAN}
6520: ${MASTER_SITE_PGSQL}
1.66 ! asau 6521: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 6522: ${MASTER_SITE_R_CRAN}
6523: ${MASTER_SITE_SOURCEFORGE}
6524: ${MASTER_SITE_SOURCEFORGE_JP}
6525: ${MASTER_SITE_SUNSITE}
6526: ${MASTER_SITE_SUSE}
6527: ${MASTER_SITE_TEX_CTAN}
6528: ${MASTER_SITE_XCONTRIB}
6529: ${MASTER_SITE_XEMACS}
1.66 ! asau 6530: ${MASTER_SITE_XORG}
1.1 dsieger 6531: </pre>
6532: <p>Some explanations for the less self-explaining ones:
6533: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6534: 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 6535: 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 6536: <p>If you choose one of these predefined sites, you may
6537: want to specify a subdirectory of that site. Since these
6538: macros may expand to more than one actual site, you
6539: <span class="emphasis"><em>must</em></span> use the following construct to
6540: specify a subdirectory:</p>
6541: <pre class="programlisting">
6542: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6543: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6544: </pre>
6545: <p>Note the trailing slash after the subdirectory
6546: name.</p>
6547: </div>
1.41 asau 6548: <div class="sect2">
1.1 dsieger 6549: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6550: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6551: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6552: all the distfiles exist in a local directory
6553: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6554: user). If the files do not exist, they are fetched using
6555: commands of the form</p>
6556: <pre class="programlisting">
6557: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6558: </pre>
6559: <p>where <code class="literal">${site}</code> varies through
6560: several possibilities in turn: first,
6561: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6562: sites specified in either <code class="varname">SITES.file</code> if
6563: defined, else <code class="varname">MASTER_SITES</code> or
6564: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6565: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6566: all except the first and the last can be optionally sorted
6567: by the user, via setting either
6568: <code class="varname">MASTER_SORT_RANDOM</code>, and
6569: <code class="varname">MASTER_SORT_AWK</code> or
6570: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6571: <p> The specific command and arguments used depend on the
6572: <code class="varname">FETCH_USING</code> parameter. The example above is
6573: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6574: <p>The distfiles mirror run by the NetBSD Foundation uses the
6575: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6576: distfiles, if they are freely distributable. Packages setting
6577: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6578: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6579: mirrored.</p>
6580: </div>
6581: </div>
1.41 asau 6582: <div class="sect1">
1.1 dsieger 6583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6584: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6585: <p>After the distfile(s) are fetched, their checksum is
6586: generated and compared with the checksums stored in the
6587: distinfo file. If the checksums don't match, the build is
6588: aborted. This is to ensure the same distfile is used for
6589: building, and that the distfile wasn't changed, e.g. by some
6590: malign force, deliberately changed distfiles on the master
6591: distribution site or network lossage.</p>
6592: </div>
1.41 asau 6593: <div class="sect1">
1.1 dsieger 6594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6595: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6596: <p>When the distfiles are present on the local system, they
6597: need to be extracted, as they usually come in the form of some
6598: compressed archive format.</p>
6599: <p>By default, all <code class="varname">DISTFILES</code> are
6600: extracted. If you only need some of them, you can set the
6601: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6602: files.</p>
6603: <p>Extracting the files is usually done by a little
6604: program, <code class="filename">mk/extract/extract</code>, which
6605: already knows how to extract various archive formats, so most
6606: likely you will not need to change anything here. But if you
6607: need, the following variables may help you:</p>
1.41 asau 6608: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6609: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6610: <dd><p>Use these variables to override the default
6611: options for an extract command, which are defined in
6612: <code class="filename">mk/extract/extract</code>.</p></dd>
6613: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6614: <dd><p>This variable can be set to
1.14 jmcneill 6615: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6616: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6617: absolute pathname pointing to the command with which tar
1.14 jmcneill 6618: archives should be extracted. It is preferred to choose bsdtar over gtar
6619: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6620: </dl></div>
6621: <p>If the <code class="filename">extract</code> program doesn't
6622: serve your needs, you can also override the
6623: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6624: command used for extracting the files. This command is
6625: executed in the <code class="filename">${WRKSRC}</code>
6626: directory. During execution of this command, the shell
6627: variable <code class="varname">extract_file</code> holds the absolute
6628: pathname of the file that is going to be extracted.</p>
6629: <p>And if that still does not suffice, you can override the
6630: <code class="varname">do-extract</code> target in the package
6631: Makefile.</p>
6632: </div>
1.41 asau 6633: <div class="sect1">
1.1 dsieger 6634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6635: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6636: <p>After extraction, all the patches named by the
6637: <code class="varname">PATCHFILES</code>, those present in the patches
6638: subdirectory of the package as well as in
6639: $LOCALPATCHES/$PKGPATH (e.g.
6640: <code class="filename">/usr/local/patches/graphics/png</code>) are
6641: applied. Patchfiles ending in <code class="filename">.Z</code> or
6642: <code class="filename">.gz</code> are uncompressed before they are
6643: applied, files ending in <code class="filename">.orig</code> or
6644: <code class="filename">.rej</code> are ignored. Any special options to
1.29 dholland 6645: <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 6646: <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.29 dholland 6647: <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 6648: it fail if the patches apply with some lines of fuzz. Please
6649: fix (regen) the patches so that they apply cleanly. The
6650: rationale behind this is that patches that don't apply cleanly
6651: may end up being applied in the wrong place, and cause severe
6652: harm there.</p>
6653: </div>
1.41 asau 6654: <div class="sect1">
1.1 dsieger 6655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6656: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6657: <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 6658: </p>
6659: </div>
1.41 asau 6660: <div class="sect1">
1.1 dsieger 6661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6662: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6663: <p>This phase creates wrapper programs for the compilers and
6664: linkers. The following variables can be used to tweak the
6665: wrappers.</p>
1.41 asau 6666: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6667: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6668: <dd><p>The command used to print progress
6669: messages. Does nothing by default. Set to
6670: <code class="literal">${ECHO}</code> to see the progress
6671: messages.</p></dd>
6672: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6673: <dd><p>This variable can be set to
6674: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6675: depending on whether you want additional information in the
6676: wrapper log file.</p></dd>
6677: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6678: <dd><p>This variable can be set to
6679: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6680: on whether the wrapper should use its cache, which will
6681: improve the speed. The default value is
6682: <code class="literal">yes</code>, but is forced to
6683: <code class="literal">no</code> if the platform does not support
6684: it.</p></dd>
6685: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6686: <dd><p>A list of reordering commands. A reordering
6687: command has the form
6688: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6689: It ensures that that
6690: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6691: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6692: </p></dd>
6693: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6694: <dd><p>A list of transformation commands. [TODO:
6695: investigate further]</p></dd>
6696: </dl></div>
6697: </div>
1.41 asau 6698: <div class="sect1">
1.1 dsieger 6699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6700: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6701: <p>Most pieces of software need information on the header
6702: files, system calls, and library routines which are available
6703: on the platform they run on. The process of determining this
6704: information is known as configuration, and is usually
6705: automated. In most cases, a script is supplied with the
6706: distfiles, and its invocation results in generation of header
6707: files, Makefiles, etc.</p>
6708: <p>If the package contains a configure script, this can be
6709: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6710: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6711: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6712: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6713: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6714: <pre class="programlisting">
6715: .for d in ${CONFIGURE_DIRS}
6716: cd ${WRKSRC} \
6717: && cd ${d} \
6718: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6719: .endfor
6720: </pre>
6721: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6722: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6723: <code class="varname">WRKSRC</code>. In each of these directories, the
6724: configure script is run with the environment
6725: <code class="varname">CONFIGURE_ENV</code> and arguments
6726: <code class="varname">CONFIGURE_ARGS</code>. The variables
6727: <code class="varname">CONFIGURE_ENV</code>,
6728: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6729: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6730: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6731: package.</p>
1.37 wiz 6732: <p>If the program uses the Perl way of configuration (mainly Perl
6733: modules, but not only), i.e. a file called
6734: <code class="filename">Makefile.PL</code>, it should include
6735: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6736: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6737: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6738: <p>If the program uses an <code class="filename">Imakefile</code>
6739: for configuration, the appropriate steps can be invoked by
6740: setting <code class="varname">USE_IMAKE</code> to
1.23 wiz 6741: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.1 dsieger 6742: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6743: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6744: xmkmf's environment by adding them to the
6745: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6746: <p>If the program uses <code class="filename">cmake</code>
6747: for configuration, the appropriate steps can be invoked by
1.23 wiz 6748: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6749: You can add variables to cmake's environment by adding them to the
6750: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6751: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6752: The top directory argument is given by the
6753: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6754: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6755: <p>If there is no configure step at all, set
1.23 wiz 6756: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6757: </div>
1.41 asau 6758: <div class="sect1">
1.1 dsieger 6759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6760: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6761: <p>For building a package, a rough equivalent of the
6762: following code is executed.</p>
6763: <pre class="programlisting">
6764: .for d in ${BUILD_DIRS}
6765: cd ${WRKSRC} \
6766: && cd ${d} \
6767: && env ${MAKE_ENV} \
6768: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6769: -f ${MAKE_FILE} \
6770: ${BUILD_TARGET}
6771: .endfor
6772: </pre>
6773: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6774: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6775: <code class="varname">WRKSRC</code>. In each of these directories,
6776: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6777: <code class="varname">MAKE_ENV</code> and arguments
6778: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6779: <code class="varname">MAKE_ENV</code>,
6780: <code class="varname">BUILD_MAKE_FLAGS</code>,
6781: <code class="varname">MAKE_FILE</code> and
6782: <code class="varname">BUILD_TARGET</code> may all be changed by the
6783: package.</p>
6784: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6785: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6786: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6787: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6788: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6789: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6790: <p>If there is no build step at all, set
1.23 wiz 6791: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6792: </div>
1.41 asau 6793: <div class="sect1">
1.1 dsieger 6794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6795: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6796: <p>[TODO]</p>
6797: </div>
1.41 asau 6798: <div class="sect1">
1.1 dsieger 6799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6800: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6801: <p>Once the build stage has completed, the final step is to
6802: install the software in public directories, so users can
6803: access the programs and files.</p>
6804: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6805: equivalent of the following code is executed. Additionally,
6806: before and after this code, much magic is performed to do
6807: consistency checks, registering the package, and so on.</p>
6808: <pre class="programlisting">
6809: .for d in ${INSTALL_DIRS}
6810: cd ${WRKSRC} \
6811: && cd ${d} \
6812: && env ${MAKE_ENV} \
6813: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6814: -f ${MAKE_FILE} \
6815: ${INSTALL_TARGET}
6816: .endfor
6817: </pre>
6818: <p>The variable's meanings are analogous to the ones in the
6819: <span class="emphasis"><em>build</em></span> phase.
6820: <code class="varname">INSTALL_DIRS</code> defaults to
6821: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6822: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6823: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6824: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6825: defined.</p>
6826: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6827: variables are useful. They are all variations of the
1.29 dholland 6828: <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 6829: permissions preset. <code class="varname">INSTALL</code> is the plain
6830: install command. The specialized variants, together with their
6831: intended use, are:</p>
1.41 asau 6832: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6833: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6834: <dd><p>directories that contain
6835: binaries</p></dd>
6836: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6837: <dd><p>directories that contain
6838: scripts</p></dd>
6839: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6840: <dd><p>directories that contain shared and static
6841: libraries</p></dd>
6842: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6843: <dd><p>directories that contain data
6844: files</p></dd>
6845: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6846: <dd><p>directories that contain man
6847: pages</p></dd>
6848: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6849: <dd><p>binaries that can be stripped from debugging
6850: symbols</p></dd>
6851: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6852: <dd><p>binaries that cannot be
6853: stripped</p></dd>
6854: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6855: <dd><p>game
6856: binaries</p></dd>
6857: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6858: <dd><p>shared and static
6859: libraries</p></dd>
6860: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6861: <dd><p>data files</p></dd>
6862: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6863: <dd><p>data files for
6864: games</p></dd>
6865: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6866: <dd><p>man pages</p></dd>
6867: </dl></div>
6868: <p>Some other variables are:</p>
1.41 asau 6869: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6870: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6871: <dd><p>A list of directories relative to
6872: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6873: beginning of the <span class="emphasis"><em>install</em></span> phase.
6874: The package is supposed to create all needed directories itself
6875: before installing files to it and list all other directories here.
6876: </p></dd>
6877: </dl></div>
6878: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6879: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6880: mostly relevant for packages in the <code class="filename">regress</code>
6881: category.</p>
6882: </div>
1.41 asau 6883: <div class="sect1">
1.1 dsieger 6884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6885: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6886: <p>Once the install stage has completed, a binary package of
6887: the installed files can be built. These binary packages can be
6888: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6889: the <span class="command"><strong>make bin-install</strong></span> or by using
6890: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6891: <p>By default, the binary packages are created in
6892: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6893: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6894: one for each category in the <code class="varname">CATEGORIES</code>
6895: variable. <code class="varname">PACKAGES</code> defaults to
6896: <code class="filename">pkgsrc/packages</code>.</p>
6897: </div>
1.41 asau 6898: <div class="sect1">
1.1 dsieger 6899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6900: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6901: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6902: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6903: to clean the work directories of all dependencies too, use
1.10 hubertf 6904: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6905: </div>
1.41 asau 6906: <div class="sect1">
1.1 dsieger 6907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6908: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6909: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6910: <dt><span class="term">pre/post-*</span></dt>
6911: <dd><p>For any of the main targets described in the
6912: previous section, two auxiliary targets exist with
1.23 wiz 6913: <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 6914: prefix for the main target's name. These targets are
6915: invoked before and after the main target is called,
6916: allowing extra configuration or installation steps be
6917: performed from a package's Makefile, for example, which
6918: a program's configure script or install target
6919: omitted.</p></dd>
6920: <dt><span class="term">do-*</span></dt>
6921: <dd><p>Should one of the main targets do the wrong thing,
6922: and should there be no variable to fix this, you can
6923: redefine it with the do-* target. (Note that redefining
6924: the target itself instead of the do-* target is a bad
6925: idea, as the pre-* and post-* targets won't be called
6926: anymore, etc.) You will not usually need to do
6927: this.</p></dd>
6928: <dt><span class="term">reinstall</span></dt>
6929: <dd>
1.10 hubertf 6930: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6931: you noticed some file was not installed properly, you
6932: can repeat the installation with this target, which will
1.23 wiz 6933: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6934: <p>This is the default value of
6935: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6936: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6937: package</strong></span>, where the defaults are
1.23 wiz 6938: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6939: respectively.</p>
6940: </dd>
6941: <dt><span class="term">deinstall</span></dt>
6942: <dd>
1.29 dholland 6943: <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 6944: current directory, effectively de-installing the
6945: package. The following variables can be used to tune the
6946: behaviour:</p>
1.41 asau 6947: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6948: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.29 dholland 6949: <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 6950: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6951: <dd><p>Remove all packages that require (depend on)
6952: the given package. This can be used to remove any
6953: packages that may have been pulled in by a given
1.10 hubertf 6954: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6955: DEINSTALLDEPENDS=1</strong></span> is done in
6956: <code class="filename">pkgsrc/x11/kde</code>, this is
6957: likely to remove whole KDE. Works by adding
1.29 dholland 6958: <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 6959: command line.</p></dd>
6960: </dl></div>
6961: </dd>
6962: <dt><span class="term">bin-install</span></dt>
6963: <dd><p>Install a binary package from local disk and via FTP
6964: from a list of sites (see the
6965: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6966: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6967: available anywhere. The arguments given to
1.10 hubertf 6968: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6969: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6970: operation, etc.</p></dd>
6971: <dt><span class="term">update</span></dt>
6972: <dd>
6973: <p>This target causes the current package to be
6974: updated to the latest version. The package and all
6975: depending packages first get de-installed, then current
6976: versions of the corresponding packages get compiled and
6977: installed. This is similar to manually noting which
6978: packages are currently installed, then performing a
1.10 hubertf 6979: series of <span class="command"><strong>make deinstall</strong></span> and
6980: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6981: <code class="varname">UPDATE_TARGET</code> is set to) for these
6982: packages.</p>
1.23 wiz 6983: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6984: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6985: update</strong></span> was interrupted for some reason.
6986: However, in this case, make sure you don't call
1.10 hubertf 6987: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6988: list of dependent packages in <code class="varname">WRKDIR</code>.
6989: Otherwise, you lose the ability to automatically update
6990: the current package along with the dependent packages
6991: you have installed.</p>
1.10 hubertf 6992: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6993: update</strong></span> will only work as long as the package
6994: tree remains unchanged. If the source code for one of
6995: the packages to be updated has been changed, resuming
1.10 hubertf 6996: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6997: fail!</p>
6998: <p>The following variables can be used either on the
1.10 hubertf 6999: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7000: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 7001: update</strong></span>:</p>
1.41 asau 7002: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7003: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7004: <dd><p>Install target to recursively use for the
7005: updated package and the dependent packages.
7006: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 7007: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 7008: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 7009: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7010: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7011: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 7012: endless loop!</p></dd>
7013: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7014: <dd><p>Don't clean up after updating. Useful if
7015: you want to leave the work sources of the updated
7016: packages around for inspection or other purposes.
7017: Be sure you eventually clean up the source tree
1.23 wiz 7018: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 7019: or you may run into troubles with old source code
7020: still lying around on your next
1.10 hubertf 7021: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 7022: update</strong></span>.</p></dd>
7023: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7024: <dd><p>Deinstall each package before installing
7025: (making <code class="varname">DEPENDS_TARGET</code>). This
7026: may be necessary if the
1.23 wiz 7027: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 7028: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 7029: update</strong></span>.</p></dd>
7030: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7031: <dd><p>Allows you to disable recursion and hardcode
7032: the target for packages. The default is
1.23 wiz 7033: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 7034: facilitating a recursive update of prerequisite
7035: packages. Only set
7036: <code class="varname">DEPENDS_TARGET</code> if you want to
7037: disable recursive updates. Use
7038: <code class="varname">UPDATE_TARGET</code> instead to just
7039: set a specific target for each package to be
1.10 hubertf 7040: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 7041: (see above).</p></dd>
7042: </dl></div>
7043: </dd>
7044: <dt><span class="term">clean-update</span></dt>
7045: <dd>
7046: <p>Clean the source tree for all packages that would
1.10 hubertf 7047: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 7048: from the current directory. This target should not be
7049: used if the current package (or any of its depending
7050: packages) have already been de-installed (e.g., after
1.10 hubertf 7051: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 7052: some packages you intended to update. As a rule of
7053: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 7054: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 7055: and only if you have a dirty package tree (e.g., if you
7056: used <code class="varname">NOCLEAN</code>).</p>
7057: <p>If you are unsure about whether your tree is
1.10 hubertf 7058: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 7059: clean</strong></span> at the top of the tree, or use the
7060: following sequence of commands from the directory of the
7061: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 7062: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 7063: time, otherwise you lose all the packages you wanted to
7064: update!):</p>
7065: <pre class="screen">
7066: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7067: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7068: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7069: </pre>
7070: <p>The following variables can be used either on the
1.10 hubertf 7071: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7072: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 7073: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7074: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 7075: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 7076: reconstruct the list of directories to update for
1.10 hubertf 7077: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 7078: update</strong></span> successfully installed all
7079: packages you wanted to update. Normally, this is
1.10 hubertf 7080: done automatically on <span class="command"><strong>make
1.1 dsieger 7081: update</strong></span>, but may have been suppressed by
7082: the <code class="varname">NOCLEAN</code> variable (see
7083: above).</p></dd>
7084: </dl></div>
7085: </dd>
7086: <dt><span class="term">replace</span></dt>
7087: <dd>
7088: <p>Update the installation of the current package. This
7089: differs from update in that it does not replace dependent
7090: 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
7091: target to work.</p>
7092: <p><span class="emphasis"><em>Be careful when using this
7093: target!</em></span> There are no guarantees that dependent
7094: packages will still work, in particular they will most
1.10 hubertf 7095: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 7096: library package whose shared library major version changed
7097: between your installed version and the new one. For this
7098: reason, this target is not officially supported and only
7099: recommended for advanced users.</p>
7100: </dd>
7101: <dt><span class="term">info</span></dt>
1.29 dholland 7102: <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 7103: package. You can use this to check which version of a
7104: package is installed.</p></dd>
7105: <dt><span class="term">index</span></dt>
7106: <dd>
7107: <p>This is a top-level command, i.e. it should be used in
7108: the <code class="filename">pkgsrc</code> directory. It creates a
7109: database of all packages in the local pkgsrc tree, including
7110: dependencies, comment, maintainer, and some other useful
7111: information. Individual entries are created by running
1.10 hubertf 7112: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 7113: directories. This index file is saved as
7114: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 7115: verbose format by running <span class="command"><strong>make
1.1 dsieger 7116: print-index</strong></span>. You can search in it with
1.10 hubertf 7117: <span class="command"><strong>make search
1.1 dsieger 7118: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7119: extract a list of all packages that depend on a particular
1.10 hubertf 7120: one by running <span class="command"><strong>make show-deps
1.1 dsieger 7121: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7122: <p>Running this command takes a very long time, some
7123: hours even on fast machines!</p>
7124: </dd>
7125: <dt><span class="term">readme</span></dt>
7126: <dd>
7127: <p>This target generates a
7128: <code class="filename">README.html</code> file, which can be
7129: 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
7130: contain references to any packages which are in the
7131: <code class="varname">PACKAGES</code> directory on the local
7132: host. The generated files can be made to refer to URLs
7133: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7134: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7135: wanted to generate <code class="filename">README.html</code>
7136: files which pointed to binary packages on the local
7137: machine, in the directory
7138: <code class="filename">/usr/packages</code>, set
7139: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7140: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7141: <code class="varname">${PACKAGES}</code> directory and its
7142: subdirectories will be searched for all the binary
7143: packages.</p>
7144: <p>The target can be run at the toplevel or in category
7145: directories, in which case it descends recursively.</p>
7146: </dd>
7147: <dt><span class="term">readme-all</span></dt>
7148: <dd><p>This is a top-level command, run it in
7149: <code class="filename">pkgsrc</code>. Use this target to create a
7150: file <code class="filename">README-all.html</code> which contains a
7151: list of all packages currently available in the NetBSD
7152: Packages Collection, together with the category they belong
7153: to and a short description. This file is compiled from the
7154: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 7155: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 7156: readme</strong></span>.</p></dd>
7157: <dt><span class="term">cdrom-readme</span></dt>
7158: <dd><p>This is very much the same as the
1.23 wiz 7159: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 7160: used when generating a pkgsrc tree to be written to a
7161: CD-ROM. This target also produces
7162: <code class="filename">README.html</code> files, and can be made
7163: to refer to URLs based on
7164: <code class="varname">CDROM_PKG_URL_HOST</code> and
7165: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7166: <dt><span class="term">show-distfiles</span></dt>
7167: <dd><p>This target shows which distfiles and patchfiles
7168: are needed to build the package
7169: (<code class="varname">ALLFILES</code>, which contains all
7170: <code class="varname">DISTFILES</code> and
7171: <code class="varname">PATCHFILES</code>, but not
7172: <code class="filename">patches/*</code>).</p></dd>
7173: <dt><span class="term">show-downlevel</span></dt>
7174: <dd><p>This target shows nothing if the package is not
7175: installed. If a version of this package is installed,
7176: but is not the version provided in this version of
7177: pkgsrc, then a warning message is displayed. This target
7178: can be used to show which of your installed packages are
7179: downlevel, and so the old versions can be deleted, and
7180: the current ones added.</p></dd>
7181: <dt><span class="term">show-pkgsrc-dir</span></dt>
7182: <dd><p>This target shows the directory in the pkgsrc
7183: hierarchy from which the package can be built and
7184: installed. This may not be the same directory as the one
7185: from which the package was installed. This target is
7186: intended to be used by people who may wish to upgrade
7187: many packages on a single host, and can be invoked from
7188: the top-level pkgsrc Makefile by using the
1.23 wiz 7189: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 7190: <dt><span class="term">show-installed-depends</span></dt>
7191: <dd><p>This target shows which installed packages match
7192: the current package's <code class="varname">DEPENDS</code>. Useful
7193: if out of date dependencies are causing build
7194: problems.</p></dd>
7195: <dt><span class="term">check-shlibs</span></dt>
7196: <dd><p>After a package is installed, check all its
7197: binaries and (on ELF platforms) shared libraries to see
7198: if they find the shared libs they need. Run by default
1.10 hubertf 7199: 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 7200: <dt><span class="term">print-PLIST</span></dt>
7201: <dd>
1.23 wiz 7202: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 7203: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 7204: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 7205: -newer work/.extract_done</strong></span>. An attempt is made
7206: to care for shared libs etc., but it is
7207: <span class="emphasis"><em>strongly</em></span> recommended to review the
7208: result before putting it into
7209: <code class="filename">PLIST</code>. On upgrades, it's useful to
7210: diff the output of this command against an already
7211: existing <code class="filename">PLIST</code> file.</p>
1.29 dholland 7212: <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 7213: other methods that don't update file access times, be
7214: sure to add these files manually to your
1.23 wiz 7215: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7216: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 7217: them!</p>
1.23 wiz 7218: <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 7219: information on this target.</p>
7220: </dd>
7221: <dt><span class="term">bulk-package</span></dt>
7222: <dd>
7223: <p>Used to do bulk builds. If an appropriate binary
7224: package already exists, no action is taken. If not, this
7225: target will compile, install and package it (and its
7226: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 ! asau 7227: 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
! 7228: builds)</i></a>).
1.1 dsieger 7229: After creating the binary package, the sources, the
7230: just-installed package and its required packages are
7231: removed, preserving free disk space.</p>
7232: <p><span class="emphasis"><em>Beware that this target may deinstall
7233: all packages installed on a system!</em></span></p>
7234: </dd>
7235: <dt><span class="term">bulk-install</span></dt>
7236: <dd>
7237: <p>Used during bulk-installs to install required
7238: packages. If an up-to-date binary package is available,
1.29 dholland 7239: 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 7240: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 7241: but the installed binary won't be removed.</p>
7242: <p>A binary package is considered
1.23 wiz 7243: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.29 dholland 7244: <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 7245: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7246: <li class="listitem"><p>None of the package's files
1.1 dsieger 7247: (<code class="filename">Makefile</code>, ...) were modified
7248: since it was built.</p></li>
1.23 wiz 7249: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 7250: packages were modified since it was built.</p></li>
7251: </ul></div>
7252: <p><span class="emphasis"><em>Beware that this target may deinstall
7253: all packages installed on a system!</em></span></p>
7254: </dd>
7255: </dl></div>
7256: </div>
7257: </div>
1.41 asau 7258: <div class="chapter">
1.1 dsieger 7259: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7260: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7261: <div class="toc">
7262: <p><b>Table of Contents</b></p>
7263: <dl>
1.6 rillig 7264: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7265: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7266: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7267: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7268: </dl>
7269: </div>
7270: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7271: by pkgsrc and also for individual packages to define what commands
7272: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7273: or for later run-time of an installed packaged (such as
7274: <code class="varname">DEPENDS</code>).
7275: If the native system provides an adequate tool, then in many cases, a pkgsrc
7276: package will not be used.</p>
7277: <p>When building a package, the replacement tools are
7278: made available in a directory (as symlinks or wrapper scripts)
7279: that is early in the executable search path. Just like the buildlink
7280: system, this helps with consistent builds.</p>
7281: <p>A tool may be needed to help build a specific package. For example,
7282: perl, GNU make (gmake) or yacc may be needed.</p>
7283: <p>Also a tool may be needed, for example, because the native system's supplied
7284: tool may be inefficient for building a package with pkgsrc.
7285: For example, a package may need GNU awk, bison (instead of
7286: yacc) or a better sed.</p>
7287: <p>The tools used by a package can be listed by running
1.10 hubertf 7288: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 7289: <div class="sect1">
1.1 dsieger 7290: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7291: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7292: <p>The default set of tools used by pkgsrc is defined in
7293: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7294: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7295: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7296: These can be seen by running:
1.10 hubertf 7297: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7298: <p>If a package needs a specific program to build
7299: then the <code class="varname">USE_TOOLS</code> variable can be used
7300: to define the tools needed.</p>
7301: </div>
1.41 asau 7302: <div class="sect1">
1.1 dsieger 7303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7304: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 7305: <p>In the following examples, the :run means that it is needed at
7306: run-time (and becomes a DEPENDS).
1.1 dsieger 7307: The default is a build dependency which can be set with
7308: :build. (So in this example, it is the same as gmake:build
7309: and pkg-config:build.)</p>
7310: <pre class="programlisting">
7311: USE_TOOLS+= gmake perl:run pkg-config
7312: </pre>
7313: <p>When using the tools framework, a
7314: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7315: which contains the full path to the appropriate tool. For example,
1.23 wiz 7316: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 7317: on Linux systems.</p>
7318: <p>If you always need a pkgsrc version of the
7319: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7320: </p>
7321: </div>
1.41 asau 7322: <div class="sect1">
1.1 dsieger 7323: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7324: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7325: <p>When improving or porting pkgsrc to a new platform, have a look
7326: at (or create) the corresponding platform specific make file fragment under
7327: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7328: the name of the common tools. For example:</p>
7329: <pre class="programlisting">
7330: .if exists(/usr/bin/bzcat)
7331: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7332: .elif exists(/usr/bin/bzip2)
7333: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7334: .endif
7335:
7336: TOOLS_PLATFORM.true?= true # shell builtin
7337: </pre>
7338: </div>
1.41 asau 7339: <div class="sect1">
1.1 dsieger 7340: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7341: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.41 asau 7342: <div class="qandaset">
1.66 ! asau 7343: <a name="idm25028420"></a><dl>
1.6 rillig 7344: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7345: </dt>
1.6 rillig 7346: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7347: tools?</a>
7348: </dt>
1.6 rillig 7349: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7350: package is using while being built? I want to know whether it
7351: uses sed or not.</a>
7352: </dt>
7353: </dl>
1.41 asau 7354: <table border="0" style="width: 100%;">
7355: <colgroup>
1.1 dsieger 7356: <col align="left" width="1%">
1.23 wiz 7357: <col>
1.41 asau 7358: </colgroup>
1.1 dsieger 7359: <tbody>
1.41 asau 7360: <tr class="question">
1.1 dsieger 7361: <td align="left" valign="top">
1.66 ! asau 7362: <a name="tools.new"></a><a name="idm25028228"></a><p><b>18.4.1.</b></p>
1.1 dsieger 7363: </td>
7364: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7365: </tr>
7366: <tr class="answer">
7367: <td align="left" valign="top"></td>
7368: <td align="left" valign="top"><p>TODO</p></td>
7369: </tr>
1.41 asau 7370: <tr class="question">
1.1 dsieger 7371: <td align="left" valign="top">
1.66 ! asau 7372: <a name="tools.listall"></a><a name="idm25027716"></a><p><b>18.4.2.</b></p>
1.1 dsieger 7373: </td>
7374: <td align="left" valign="top"><p>How do I get a list of all available
7375: tools?</p></td>
7376: </tr>
7377: <tr class="answer">
7378: <td align="left" valign="top"></td>
7379: <td align="left" valign="top"><p>TODO</p></td>
7380: </tr>
1.41 asau 7381: <tr class="question">
1.1 dsieger 7382: <td align="left" valign="top">
1.66 ! asau 7383: <a name="tools.used"></a><a name="idm25027204"></a><p><b>18.4.3.</b></p>
1.1 dsieger 7384: </td>
7385: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7386: package is using while being built? I want to know whether it
7387: uses sed or not.</p></td>
7388: </tr>
7389: <tr class="answer">
7390: <td align="left" valign="top"></td>
7391: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7392: to do it.)</p></td>
7393: </tr>
7394: </tbody>
7395: </table>
7396: </div>
7397: </div>
7398: </div>
1.41 asau 7399: <div class="chapter">
1.1 dsieger 7400: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7401: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7402: <div class="toc">
7403: <p><b>Table of Contents</b></p>
7404: <dl>
1.6 rillig 7405: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7406: <dd><dl>
1.6 rillig 7407: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 7408: <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 7409: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7410: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7411: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7412: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7413: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7414: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7415: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7416: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7417: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7418: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7419: </dl></dd>
1.23 wiz 7420: <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 7421: <dd><dl>
7422: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7423: <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>
7424: </dl></dd>
1.23 wiz 7425: <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 7426: <dd><dl>
7427: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7428: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7429: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7430: </dl></dd>
7431: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7432: <dd><dl>
7433: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7434: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7435: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 7436: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7437: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 7438: </dl></dd>
1.23 wiz 7439: <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 7440: <dd><dl>
7441: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7442: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 7443: <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 7444: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7445: </dl></dd>
1.23 wiz 7446: <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 7447: <dd><dl>
7448: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7449: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7450: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7451: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7452: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7453: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7454: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7455: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7456: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 7457: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 7458: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7459: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7460: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7461: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7462: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7463: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7464: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7465: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7466: emulation</a></span></dt>
1.6 rillig 7467: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7468: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7469: </dl></dd>
1.6 rillig 7470: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7471: </dl>
7472: </div>
1.41 asau 7473: <div class="sect1">
1.1 dsieger 7474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7475: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.41 asau 7476: <div class="sect2">
1.1 dsieger 7477: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7478: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7479: <p>One appealing feature of pkgsrc is that it runs on many
7480: different platforms. As a result, it is important to ensure,
7481: where possible, that packages in pkgsrc are portable. This
7482: chapter mentions some particular details you should pay
7483: attention to while working on pkgsrc.</p>
7484: </div>
1.41 asau 7485: <div class="sect2">
1.1 dsieger 7486: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 7487: <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 7488: </h3></div></div></div>
7489: <p>The pkgsrc user can configure pkgsrc by overriding several
7490: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7491: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7492: want to use those variables in the preprocessor directives of
1.29 dholland 7493: <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 7494: <code class="literal">.for</code>), you need to include the file
7495: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7496: loads the user preferences.</p>
7497: <p>But note that some variables may not be completely defined
7498: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7499: included, as they may contain references to variables that are
7500: not yet defined. In shell commands this is no problem, since
7501: variables are actually macros, which are only expanded when they
7502: are used. But in the preprocessor directives mentioned above and
7503: in dependency lines (of the form <code class="literal">target:
7504: dependencies</code>) the variables are expanded at load
7505: time.</p>
1.41 asau 7506: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7507: <h3 class="title">Note</h3>
7508: <p>Currently there is no exhaustive list of all
7509: variables that tells you whether they can be used at load time
7510: or only at run time, but it is in preparation.</p>
7511: </div>
7512: </div>
1.41 asau 7513: <div class="sect2">
1.1 dsieger 7514: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7515: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7516: <p>Occasionally, packages require interaction from the user,
7517: and this can be in a number of ways:</p>
1.41 asau 7518: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7519: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7520: interaction such as entering username/password or accepting a
7521: license on a web page.</p></li>
1.23 wiz 7522: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7523: passwords.</p></li>
1.23 wiz 7524: <li class="listitem"><p>help to configure the package before it is built</p></li>
7525: <li class="listitem"><p>help during the build process</p></li>
7526: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7527: </ul></div>
7528: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7529: provided to notify the pkgsrc mechanism of an interactive stage
7530: which will be needed, and this should be set in the package's
7531: <code class="filename">Makefile</code>, e.g.:</p>
7532: <pre class="programlisting">
7533: INTERACTIVE_STAGE= build
7534: </pre>
7535: <p>Multiple interactive stages can be specified:</p>
7536: <pre class="programlisting">
7537: INTERACTIVE_STAGE= configure install
7538: </pre>
7539: <p>The user can then decide to skip this package by setting the
7540: <code class="varname">BATCH</code> variable.</p>
7541: </div>
1.41 asau 7542: <div class="sect2">
1.1 dsieger 7543: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7544: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7545: <p>Authors of software can choose the licence under which
7546: software can be copied. This is due to copyright law, and reasons
7547: for license choices are outside the scope of pkgsrc. The pkgsrc
7548: system recognizes that there are a number of licenses which some
7549: users may find objectionable or difficult or impossible to comply
7550: with. The Free Software Foundation has declared some licenses
7551: "Free", and the Open Source Initiative has a definition of "Open
7552: Source". The pkgsrc system, as a policy choice, does not label
7553: packages which have licenses that are Free or Open Source.
7554: However, packages without a license meeting either of those tests
7555: are labeled with a license tag denoting the license. Note that a
7556: package with no license to copy trivially does not meet either the
7557: Free or Open Source test.</p>
7558: <p>For packages which are not Free or Open Source, pkgsrc will
7559: not build the package unless the user has indicated to pkgsrc that
7560: packages with that particular license may be built. Note that
7561: this documentation avoids the term "accepted the license". The
7562: pkgsrc system is merely providing a mechanism to avoid
7563: accidentally building a package with a non-free license;
7564: judgement and responsibility remain with the user. (Installation
7565: of binary packages are not currently subject to this mechanism;
7566: this is a bug.)</p>
7567: <p>One might want to only install packages with a BSD license,
1.19 jnemeth 7568: or the GPL, and not the other. The free licenses are added to the
7569: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7570: user can override the default by setting the
7571: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7572: of "+=". The licenses accepted by default are:
7573: </p>
7574: <pre class="programlisting">
1.48 rodent 7575: apache-1.1 apache-2.0
7576: arphic-public
7577: artistic artistic-2.0
7578: boost-license
7579: cc-by-sa-v3.0
1.55 ryoon 7580: cc0-1.0-universal
1.48 rodent 7581: cddl-1.0
7582: cpl-1.0
7583: epl-v1.0
7584: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7585: gnu-gpl-v1
7586: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7587: gnu-gpl-v3 gnu-lgpl-v3
7588: ibm-public-license-1.0
7589: ipafont
7590: isc
7591: lppl-1.3c
7592: lucent
7593: miros
7594: mit
7595: mpl-1.0 mpl-1.1 mpl-2.0
7596: mplusfont
7597: ofl-v1.0 ofl-v1.1
7598: original-bsd modified-bsd 2-clause-bsd
7599: php
7600: png-license
7601: postgresql-license
7602: public-domain
7603: python-software-foundation
7604: qpl-v1.0
1.52 rodent 7605: sgi-free-software-b-v2.0
1.48 rodent 7606: sleepycat-public
7607: unlicense
7608: x11
7609: zlib
7610: zpl
1.19 jnemeth 7611: </pre>
7612: <p>
7613: </p>
1.1 dsieger 7614: <p>The license tag mechanism is intended to address
7615: copyright-related issues surrounding building, installing and
7616: using a package, and not to address redistribution issues (see
7617: <code class="varname">RESTRICTED</code> and
1.19 jnemeth 7618: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7619: Packages with redistribution restrictions should set these
7620: tags.</p>
1.1 dsieger 7621: <p>Denoting that a package may be copied according to a
7622: particular license is done by placing the license in
7623: <code class="filename">pkgsrc/licenses</code> and setting the
7624: <code class="varname">LICENSE</code> variable to a string identifying the
7625: 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>
7626: <pre class="programlisting">
7627: LICENSE= xv-license
7628: </pre>
7629: <p>When trying to build, the user will get a notice that the
7630: package is covered by a license which has not been placed in the
7631: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7632: <pre class="programlisting">
7633: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7634: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7635: ===> To view the license, enter "/usr/bin/make show-license".
7636: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7637: ===> ACCEPTABLE_LICENSES+=xv-license
7638: *** Error code 1
7639: </pre>
1.10 hubertf 7640: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7641: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7642: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7643: convey to pkgsrc that it should not in the future fail because of
7644: that license:</p>
7645: <pre class="programlisting">
7646: ACCEPTABLE_LICENSES+=xv-license
7647: </pre>
1.48 rodent 7648: <p>When adding a package with a new license, the following steps
7649: are required:</p>
7650: <div class="orderedlist"><ol class="orderedlist" type="1">
7651: <li class="listitem">
7652: <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>
7653: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7654: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7655: <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 7656: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.48 rodent 7657: </ul></div>
7658: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7659: </li>
7660: <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>
7661: </ol></div>
1.1 dsieger 7662: <p>When the license changes (in a way other than formatting),
7663: please make sure that the new license has a different name (e.g.,
7664: append the version number if it exists, or the date). Just
7665: because a user told pkgsrc to build programs under a previous
7666: version of a license does not mean that pkgsrc should build
7667: programs under the new licenses. The higher-level point is that
7668: pkgsrc does not evaluate licenses for reasonableness; the only
7669: test is a mechanistic test of whether a particular text has been
7670: approved by either of two bodies.</p>
7671: <p>The use of <code class="varname">LICENSE=shareware</code>,
7672: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7673: is deprecated because it does not crisply refer to a particular
7674: license text. Another problem with such usage is that it does not
7675: enable a user to tell pkgsrc to proceed for a single package
7676: without also telling pkgsrc to proceed for all packages with that
7677: tag.</p>
7678: </div>
1.41 asau 7679: <div class="sect2">
1.1 dsieger 7680: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7681: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7682: <p>Some licenses restrict how software may be re-distributed.
7683: Because a license tag is required unless the package is Free or
7684: Open Source, all packages with restrictions should have license
7685: tags. By declaring the restrictions, package tools can
7686: automatically refrain from e.g. placing binary packages on FTP
7687: sites.</p>
7688: <p>There are four restrictions that may be encoded, which are
7689: the cross product of sources (distfiles) and binaries not being
7690: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7691: language in any license, and because non-Free licenses tend to be
7692: different from each other, pkgsrc adopts a definition of FTP and
7693: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7694: should not be made available over the Internet at no charge.
7695: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7696: made available on some kind of media, together with other source
7697: and binary packages, and which is sold for a distribution charge.
7698: </p>
7699: <p>In order to encode these restrictions, the package system
7700: defines five make variables that can be set to note these
7701: restrictions:</p>
1.41 asau 7702: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7703: <li class="listitem">
1.1 dsieger 7704: <p><code class="varname">RESTRICTED</code></p>
7705: <p>This variable should be set whenever a restriction
7706: exists (regardless of its kind). Set this variable to a
7707: string containing the reason for the restriction. It should
7708: be understood that those wanting to understand the restriction
7709: will have to read the license, and perhaps seek advice of
7710: counsel.</p>
7711: </li>
1.23 wiz 7712: <li class="listitem">
1.1 dsieger 7713: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7714: <p>Binaries may not be placed on CD-ROM containing other
7715: binary packages, for which a distribution charge may be made.
7716: In this case, set this variable to
7717: <code class="varname">${RESTRICTED}</code>.</p>
7718: </li>
1.23 wiz 7719: <li class="listitem">
1.1 dsieger 7720: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7721: <p>Binaries may not made available on the Internet without
7722: charge. In this case, set this variable to
7723: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7724: binary packages will not be included on ftp.NetBSD.org.</p>
7725: </li>
1.23 wiz 7726: <li class="listitem">
1.1 dsieger 7727: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7728: <p>Distfiles may not be placed on CD-ROM, together with
7729: other distfiles, for which a fee may be charged. In this
7730: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7731: </p>
7732: </li>
1.23 wiz 7733: <li class="listitem">
1.1 dsieger 7734: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7735: <p>Distfiles may not made available via FTP at no charge.
7736: In this case, set this variable to
7737: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7738: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7739: </li>
7740: </ul></div>
1.32 wiz 7741: <p>Please note that packages will to be removed from pkgsrc
7742: when the distfiles are not distributable and cannot be obtained
7743: for a period of one full quarter branch. Packages with manual /
7744: interactive fetch must have a maintainer and it is his/her
7745: responsibility to ensure this.</p>
1.1 dsieger 7746: </div>
1.41 asau 7747: <div class="sect2">
1.1 dsieger 7748: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7749: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7750: <p>Your package may depend on some other package being present
7751: - and there are various ways of expressing this dependency.
7752: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7753: <code class="varname">DEPENDS</code> definitions, the
7754: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7755: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7756: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7757: 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 7758: <p>The basic difference between the two variables is as
7759: follows: The <code class="varname">DEPENDS</code> definition registers
7760: that pre-requisite in the binary package so it will be pulled in
7761: when the binary package is later installed, whilst the
7762: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7763: dependency that is only needed for building the package.</p>
7764: <p>This means that if you only need a package present whilst
7765: you are building, it should be noted as a
7766: <code class="varname">BUILD_DEPENDS</code>.</p>
7767: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7768: <code class="varname">DEPENDS</code> definition is:</p>
7769: <pre class="programlisting">
7770: <pre-req-package-name>:../../<category>/<pre-req-package>
7771: </pre>
1.23 wiz 7772: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7773: may include any of the wildcard version numbers recognized by
1.29 dholland 7774: <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 7775: <div class="orderedlist"><ol class="orderedlist" type="1">
7776: <li class="listitem">
1.1 dsieger 7777: <p>If your package needs another package's binaries or
1.54 wiz 7778: libraries to build and run, and if that package has a
1.1 dsieger 7779: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7780: <pre class="programlisting">
7781: .include "../../graphics/jpeg/buildlink3.mk"
7782: </pre>
7783: </li>
1.23 wiz 7784: <li class="listitem">
1.54 wiz 7785: <p>If your package needs another package's binaries or
7786: libraries only for building, and if that package has a
7787: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7788: <pre class="programlisting">
7789: .include "../../graphics/jpeg/buildlink3.mk"
7790: </pre>
7791: <p>but set
7792: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7793: to make it a build dependency only. This case is rather
7794: rare.</p>
7795: </li>
7796: <li class="listitem">
1.25 spz 7797: <p>If your package needs binaries from another package to build,
7798: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7799: <pre class="programlisting">
1.25 spz 7800: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1 dsieger 7801: </pre>
7802: </li>
1.25 spz 7803: <li class="listitem"><p>If your package needs a library with which to link and
7804: there is no <code class="filename">buildlink3.mk</code> file
7805: available, create one. Using
7806: <code class="varname">DEPENDS</code> won't be sufficient because the
7807: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7808: <li class="listitem">
1.25 spz 7809: <p>If your package needs some executable to be able to run
7810: correctly and if there's no
7811: <code class="filename">buildlink3.mk</code> file, this is specified
7812: using the <code class="varname">DEPENDS</code> variable. The
7813: <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
7814: be able to execute the latex binary from the teTeX package
7815: when it runs, and that is specified:</p>
1.1 dsieger 7816: <pre class="programlisting">
1.25 spz 7817: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.1 dsieger 7818: </pre>
1.25 spz 7819: </li>
7820: <li class="listitem">
7821: <p>You can use wildcards in package dependencies. Note that
7822: such wildcard dependencies are retained when creating binary
7823: packages. The dependency is checked when installing the binary
7824: package and any package which matches the pattern will be
7825: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7826: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7827: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7828: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7829: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7830: <p>Wildcards can also be used to specify that a package
7831: will only build against a certain minimum version of a
7832: pre-requisite:</p>
7833: <pre class="programlisting">
1.25 spz 7834: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 7835: </pre>
1.25 spz 7836: <p>This means that the package will build using version 6.0
7837: of ImageMagick or newer. Such a dependency may be warranted
7838: if, for example, the command line options of an executable
7839: have changed.</p>
7840: <p>If you need to depend on minimum versions of libraries,
7841: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7842: <p>For security fixes, please update the package
1.10 hubertf 7843: 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 7844: information.</p>
7845: </li>
1.59 jnemeth 7846: <li class="listitem">
7847: <p>If the package depends on either one of two (or more)
7848: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7849: comma-separated list between curly braces.</p>
7850: <p>As an example, take a package that depends on the Perl
7851: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7852: itself since version 5.10.0. This either/or dependency is
7853: expressed as:</p>
7854: <pre class="programlisting">
7855: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7856: </pre>
7857: </li>
1.1 dsieger 7858: </ol></div>
7859: <p>If your package needs files from another package to build,
7860: add the relevant distribution files to
7861: <code class="varname">DISTFILES</code>, so they will be extracted
7862: 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.
7863: (It relies on the jpeg sources being present in source form
7864: during the build.)</p>
7865: </div>
1.41 asau 7866: <div class="sect2">
1.1 dsieger 7867: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7868: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7869: <p>Your package may conflict with other packages a user might
7870: already have installed on his system, e.g. if your package
7871: installs the same set of files as another package in the pkgsrc
7872: tree.</p>
7873: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
7874: space-separated list of packages (including version string) your
7875: package conflicts with.</p>
7876: <p>For example, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw3d/README.html" target="_top"><code class="filename">x11/Xaw3d</code></a>
7877: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
7878: install the same shared library, thus you set in
7879: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7880: <pre class="programlisting">
7881: CONFLICTS= Xaw-Xpm-[0-9]*
7882: </pre>
7883: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7884: <pre class="programlisting">
7885: CONFLICTS= Xaw3d-[0-9]*
7886: </pre>
7887: <p>Packages will automatically conflict with other packages
7888: with the name prefix and a different version
1.23 wiz 7889: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
7890: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.1 dsieger 7891: </div>
1.41 asau 7892: <div class="sect2">
1.1 dsieger 7893: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7894: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7895: <p>There are several reasons why a package might be
7896: instructed to not build under certain circumstances. If the
7897: package builds and runs on most platforms, the exceptions
7898: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7899: the package builds and runs on a small handful of platforms,
7900: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7901: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7902: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7903: (OS-version-platform) that can use glob-style
7904: wildcards.</p>
7905: <p>Some packages are tightly bound to a specific version of an
7906: 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
7907: backwards compatible with other versions of the OS, and should be
7908: uploaded to a version specific directory on the FTP server. Mark
7909: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7910: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7911: the package system internals, but may be used in the
7912: future.</p>
7913: <p>If the package should be skipped (for example, because it
7914: provides functionality already provided by the system), set
7915: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7916: the package should fail because some preconditions are not met,
7917: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7918: message.</p>
7919: </div>
1.41 asau 7920: <div class="sect2">
1.1 dsieger 7921: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7922: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7923: <p>To ensure that a package may not be deleted, once it has been
7924: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7925: be set in the package Makefile. This will be carried into any
7926: binary package that is made from this pkgsrc entry. A
1.23 wiz 7927: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.29 dholland 7928: 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 7929: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7930: </div>
1.41 asau 7931: <div class="sect2">
1.1 dsieger 7932: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7933: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7934: <p>When a vulnerability is found, this should be noted in
7935: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7936: and after committing that file, ask pkgsrc-security@NetBSD.org to
7937: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7938: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7939: <code class="varname">PKGREVISION</code> should be increased (this is of
7940: course not necessary if the problem is fixed by using a newer
7941: release of the software), and the pattern in the
7942: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7943: <p>Also, if the fix should be applied to the stable pkgsrc
7944: branch, be sure to submit a pullup request!</p>
7945: <p>Binary packages already on ftp.NetBSD.org will be handled
7946: semi-automatically by a weekly cron job.</p>
7947: </div>
1.41 asau 7948: <div class="sect2">
1.1 dsieger 7949: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7950: <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 7951: <p>When making fixes to an existing package it can be useful
7952: to change the version number in <code class="varname">PKGNAME</code>. To
7953: avoid conflicting with future versions by the original author, a
1.23 wiz 7954: <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 7955: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7956: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7957: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7958: <pre class="programlisting">
7959: DISTNAME= foo-17.42
7960: PKGREVISION= 9
7961: </pre>
7962: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7963: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7964: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7965: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7966: <code class="varname">PKGNAME_NOREV</code>.</p>
7967: <p>When a new release of the package is released, the
7968: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7969: minor release of the above package, things should be like:</p>
7970: <pre class="programlisting">
7971: DISTNAME= foo-17.43
7972: </pre>
7973: <p><code class="varname">PKGREVISION</code> should be incremented for any
7974: non-trivial change in the resulting binary package. Without a
7975: <code class="varname">PKGREVISION</code> bump, someone with the previous
7976: version installed has no way of knowing that their package is out
7977: of date. Thus, changes without increasing
7978: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7979: trivial that no reasonable person would want to upgrade", and this
7980: is the rough test for when increasing
7981: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7982: changes that do not merit increasing
7983: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7985: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7986: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7987: or comments in Makefile.</p></li>
1.23 wiz 7988: <li class="listitem"><p>
1.1 dsieger 7989: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7990: <li class="listitem"><p>
1.1 dsieger 7991: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7992: <li class="listitem"><p>
1.1 dsieger 7993: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7994: </ul></div>
7995: <p>Examples of changes that do merit an increase to
7996: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7997: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7998: <li class="listitem"><p>
1.1 dsieger 7999: Security fixes</p></li>
1.23 wiz 8000: <li class="listitem"><p>
1.1 dsieger 8001: Changes or additions to a patch file</p></li>
1.23 wiz 8002: <li class="listitem"><p>
1.1 dsieger 8003: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 8004: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 8005: </ul></div>
8006: <p>PKGREVISION must also be incremented when dependencies have ABI
8007: changes.</p>
8008: </div>
1.41 asau 8009: <div class="sect2">
1.1 dsieger 8010: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8011: <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 8012: <p>When you want to replace the same text in multiple files
8013: or when the replacement text varies, patches alone cannot help.
8014: This is where the SUBST framework comes in. It provides an
8015: easy-to-use interface for replacing text in files.
8016: Example:</p>
8017: <pre class="programlisting">
8018: SUBST_CLASSES+= fix-paths
8019: SUBST_STAGE.fix-paths= pre-configure
8020: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8021: SUBST_FILES.fix-paths= src/*.c
8022: SUBST_FILES.fix-paths+= scripts/*.sh
8023: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8024: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8025: </pre>
8026: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8027: that are used to identify the different SUBST blocks that are
8028: defined. The SUBST framework is heavily used by pkgsrc, so it is
8029: important to always use the <code class="literal">+=</code> operator with
8030: this variable. Otherwise some substitutions may be
8031: skipped.</p>
8032: <p>The remaining variables of each SUBST block are
8033: parameterized with the identifier from the first line
8034: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8035: parameters to a function call.</p>
8036: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8037: which the replacement will take place. All combinations of
8038: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8039: <code class="literal">post-</code> together with a phase name are
8040: possible, though only few are actually used. Most commonly used
8041: are <code class="literal">post-patch</code> and
8042: <code class="literal">pre-configure</code>. Of these two,
8043: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 8044: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 8045: have the state after applying the patches but before making any
8046: other changes. This is especially useful when you are debugging
8047: a package in order to create new patches for it. Similarly,
8048: <code class="literal">post-build</code> is preferred over
8049: <code class="literal">pre-install</code>, because the install phase should
8050: generally be kept as simple as possible. When you use
8051: <code class="literal">post-build</code>, you have the same files in the
8052: working directory that will be installed later, so you can check
8053: if the substitution has succeeded.</p>
8054: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8055: that is printed just before the substitution is done.</p>
8056: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8057: globbing patterns that specifies the files in which the
8058: substitution will take place. The patterns are interpreted
8059: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8060: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.29 dholland 8061: <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 8062: command should be prefixed with <code class="literal">-e</code>, so that
8063: all SUBST blocks look uniform.</p>
8064: <p>There are some more variables, but they are so seldomly
8065: used that they are only documented in the
8066: <code class="filename">mk/subst.mk</code> file.</p>
8067: </div>
8068: </div>
1.41 asau 8069: <div class="sect1">
1.1 dsieger 8070: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8071: <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 8072: <div class="sect2">
1.1 dsieger 8073: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8074: <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 8075: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8076: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8077: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8078: with the name of each file to download as an argument, expecting
8079: it to output the URL of the directory from which to download
8080: 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
8081: example of this usage.</p>
8082: <p>If the download can't be automated, because the user must
8083: submit personal information to apply for a password, or must pay
8084: for the source, or whatever, you can set
8085: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8086: displayed to the user before aborting the build. Example:</p>
8087: <pre class="programlisting">
8088: FETCH_MESSAGE= "Please download the files"
8089: FETCH_MESSAGE+= " "${DISTFILES:Q}
8090: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8091: </pre>
8092: </div>
1.41 asau 8093: <div class="sect2">
1.1 dsieger 8094: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8095: <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 8096: <p>Sometimes authors of a software package make some
8097: modifications after the software was released, and they put up a
8098: new distfile without changing the package's version number. If a
8099: package is already in pkgsrc at that time, the checksum will
8100: no longer match. The contents of the new distfile should be
8101: compared against the old one before changing anything, to make
8102: sure the distfile was really updated on purpose, and that
8103: no trojan horse or so crept in.
8104: Please mention that the distfiles were compared and what was found
1.53 rodent 8105: in your commit message.</p>
8106: <p>Then, the correct way to work around this is to
1.1 dsieger 8107: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8108: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8109: <code class="varname">DISTFILES</code> and
8110: <code class="varname">PATCHFILES</code> for this package will be put in that
8111: subdirectory of the local distfiles directory.
1.10 hubertf 8112: (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 8113: In case this
8114: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8115: including the <code class="filename">nbX</code> suffix) or a date stamp
1.53 rodent 8116: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8117: <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>
8118: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8119: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8120: path in the filenames.
1.53 rodent 8121: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8122: Furthermore, a mail to the package's authors seems appropriate
8123: telling them that changing distfiles after releases without
8124: changing the file names is not good practice.</p>
8125: </div>
8126: </div>
1.41 asau 8127: <div class="sect1">
1.1 dsieger 8128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8129: <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 8130: <div class="sect2">
1.1 dsieger 8131: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8132: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8133: <p>pkgsrc supports many different machines, with different
8134: object formats like a.out and ELF, and varying abilities to do
8135: shared library and dynamic loading at all. To accompany this,
8136: varying commands and options have to be passed to the
8137: compiler, linker, etc. to get the Right Thing, which can be
8138: pretty annoying especially if you don't have all the machines
8139: at your hand to test things. The
8140: <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 8141: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8142: both static and dynamic libraries from a set of source files,
8143: thus being platform-independent.</p>
8144: <p>Here's how to use libtool in a package in seven simple
8145: steps:</p>
1.23 wiz 8146: <div class="orderedlist"><ol class="orderedlist" type="1">
8147: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8148: Makefile.</p></li>
1.23 wiz 8149: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8150: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8151: add it to the definition of <code class="varname">CC</code>, if only
8152: libraries are being built in a given Makefile. This one command
8153: will build both PIC and non-PIC library objects, so you need not
8154: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8155: <li class="listitem">
1.1 dsieger 8156: <p>For the linking of the library, remove any
1.23 wiz 8157: <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
8158: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8159: <pre class="programlisting">
8160: ${LIBTOOL} --mode=link \
8161: ${CC} -o ${.TARGET:.a=.la} \
8162: ${OBJS:.o=.lo} \
8163: -rpath ${PREFIX}/lib \
8164: -version-info major:minor
8165: </pre>
8166: <p>Note that the library is changed to have a
8167: <code class="filename">.la</code> extension, and the objects are
8168: changed to have a <code class="filename">.lo</code>
8169: extension. Change <code class="varname">OBJS</code> as
8170: necessary. This automatically creates all of the
8171: <code class="filename">.a</code>,
8172: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8173: necessary) in the build directory. Be sure to include
1.23 wiz 8174: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8175: minor are zero, as libtool will otherwise strip off the
8176: shared library version.</p>
8177: <p>From the libtool manual:</p>
8178: <pre class="programlisting">
8179: So, libtool library versions are described by three integers:
8180:
8181: CURRENT
8182: The most recent interface number that this library implements.
8183:
8184: REVISION
8185: The implementation number of the CURRENT interface.
8186:
8187: AGE
8188: The difference between the newest and oldest interfaces that
8189: this library implements. In other words, the library implements
8190: all the interface numbers in the range from number `CURRENT -
8191: AGE' to `CURRENT'.
8192:
8193: If two libraries have identical CURRENT and AGE numbers, then the
8194: dynamic linker chooses the library with the greater REVISION number.
8195: </pre>
1.23 wiz 8196: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8197: different results for a.out and ELF (excluding symlinks)
8198: in only one case. An ELF library of the form
1.23 wiz 8199: <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 8200: will have a symlink of
1.23 wiz 8201: <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 8202: on an a.out platform. This is handled
8203: automatically.</p>
1.23 wiz 8204: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8205: directory of the library being built.</p>
8206: <p>In the <code class="filename">PLIST</code>, include only the
8207: <code class="filename">.la</code> file, the other files will be
8208: added automatically.</p>
8209: </li>
1.23 wiz 8210: <li class="listitem">
1.1 dsieger 8211: <p>When linking shared object (<code class="filename">.so</code>)
1.29 dholland 8212: 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 8213: shared libraries, use <span class="quote">“<span class="quote">-module
8214: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8215: tacked on.</p>
8216: <p>The <code class="filename">PLIST</code> file gets the
8217: <code class="filename">foo.so</code> entry.</p>
8218: </li>
1.23 wiz 8219: <li class="listitem">
1.1 dsieger 8220: <p>When linking programs that depend on these libraries
8221: <span class="emphasis"><em>before</em></span> they are installed, preface
1.29 dholland 8222: 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 8223: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8224: libraries (static or shared), but please be aware that
8225: libtool will not allow you to specify a relative path in
1.23 wiz 8226: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8227: expects you to change that argument to be the
8228: <code class="filename">.la</code> file. e.g.</p>
8229: <pre class="programlisting">
8230: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8231: </pre>
8232: <p>should be changed to:</p>
8233: <pre class="programlisting">
8234: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8235: </pre>
8236: <p>and it will do the right thing with the libraries.</p>
8237: </li>
1.23 wiz 8238: <li class="listitem">
1.29 dholland 8239: <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>
8240: 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 8241: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8242: <code class="filename">.la</code>. e.g.</p>
8243: <pre class="programlisting">
1.22 jakllsch 8244: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 8245: </pre>
8246: <p>This will install the static <code class="filename">.a</code>,
8247: shared library, any needed symlinks, and run
1.29 dholland 8248: <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 8249: </li>
1.23 wiz 8250: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8251: the <code class="filename">.la</code>
8252: file (this is a change from previous behaviour).</p></li>
8253: </ol></div>
8254: </div>
1.41 asau 8255: <div class="sect2">
1.1 dsieger 8256: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8257: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8258: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8259: package Makefile. This will override the package's own libtool
8260: in most cases. For older libtool using packages, libtool is
8261: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8262: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8263: configure; find work*/ -name libtool</strong></span>.</p>
8264: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8265: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8266: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8267: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8268: package's libtool script(s), set it as appropriate.</p>
8269: <p>If you do not need <code class="filename">*.a</code> static
8270: libraries built and installed, then use
8271: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8272: <p>If your package makes use of the platform-independent library
8273: for loading dynamic shared objects, that comes with libtool
8274: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8275: <p>Some packages use libtool incorrectly so that the package
8276: may not work or build in some circumstances. Some of the more
8277: common errors are:</p>
1.41 asau 8278: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8279: <li class="listitem">
1.1 dsieger 8280: <p>The inclusion of a shared object (-module) as a dependent library in an
8281: executable or library. This in itself isn't a problem if one of two things
8282: has been done:</p>
1.23 wiz 8283: <div class="orderedlist"><ol class="orderedlist" type="1">
8284: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8285: <code class="filename">libfoo.la</code>, not
8286: <code class="filename">foo.la</code></p></li>
1.23 wiz 8287: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8288: </ol></div>
8289: </li>
1.23 wiz 8290: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8291: The function lt_dlinit() should be called and the macro
8292: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8293: executables.</p></li>
8294: </ul></div>
8295: </div>
1.41 asau 8296: <div class="sect2">
1.1 dsieger 8297: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8298: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8299: <p>If a package needs GNU autoconf or automake to be executed
8300: to regenerate the configure script and Makefile.in makefile
8301: templates, then they should be executed in a pre-configure
8302: target.</p>
8303: <p>For packages that need only autoconf:</p>
8304: <pre class="programlisting">
8305: AUTOCONF_REQD= 2.50 # if default version is not good enough
8306: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8307: ...
8308:
8309: pre-configure:
8310: cd ${WRKSRC} && autoconf
8311:
8312: ...
8313: </pre>
8314: <p>and for packages that need automake and autoconf:</p>
8315: <pre class="programlisting">
8316: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8317: USE_TOOLS+= automake # use "automake14" for automake-1.4
8318: ...
8319:
8320: pre-configure:
8321: set -e; cd ${WRKSRC}; \
8322: aclocal; autoheader; automake -a --foreign -i; autoconf
8323:
8324: ...
8325: </pre>
8326: <p>Packages which use GNU Automake will almost certainly
8327: require GNU Make.</p>
8328: <p>There are times when the configure process makes
8329: additional changes to the generated files, which then causes
8330: the build process to try to re-execute the automake sequence.
8331: This is prevented by touching various files in the configure
8332: stage. If this causes problems with your package you can set
8333: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8334: Makefile.</p>
8335: </div>
8336: </div>
1.41 asau 8337: <div class="sect1">
1.1 dsieger 8338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8339: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 8340: <div class="sect2">
1.1 dsieger 8341: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8342: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8343: <p>Compilers for the C, C++, and Fortran languages comes with
8344: the NetBSD base system. By default, pkgsrc assumes that a package
8345: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 8346: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8347: <p>To declare which language's compiler a package needs, set
8348: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8349: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8350: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8351: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8352: written in C++, usually need a C compiler for the configure
8353: phase.</p>
8354: </div>
1.41 asau 8355: <div class="sect2">
1.1 dsieger 8356: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8357: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8358: <p>If a program is written in Java, use the Java framework in
8359: pkgsrc. The package must include
8360: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8361: provides the following variables:</p>
1.41 asau 8362: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8363: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8364: dependency on the JDK is added. If
1.23 wiz 8365: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8366: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8367: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8368: JDK.</p></li>
1.23 wiz 8369: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8370: a package needs a Java2 implementation. The supported values
1.23 wiz 8371: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8372: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8373: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8374: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8375: above. This variable is not set by default.</p></li>
1.24 wiz 8376: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8377: automatically set to the runtime location of the used Java
8378: implementation dependency. It may be used to set
8379: <code class="varname">JAVA_HOME</code> to a good value if the program
8380: needs this variable to be defined.
8381: </p></li>
1.1 dsieger 8382: </ul></div>
8383: </div>
1.41 asau 8384: <div class="sect2">
1.1 dsieger 8385: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8386: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8387: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8388: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8389: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8390: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8391: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8392: that you want adjusted. Every occurrence of
8393: <code class="filename">*/bin/perl</code> will be replaced with the full
8394: path to the perl executable.</p>
8395: <p>If a particular version of perl is needed, set the
8396: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8397: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 8398: <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 8399: about handling perl modules.</p>
8400: </div>
1.41 asau 8401: <div class="sect2">
1.1 dsieger 8402: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 8403: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8404: <p><code class="varname">REPLACE_SH</code>,
8405: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8406: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8407: hash bangs in files. Please use the appropriate one, prefering
8408: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
8409: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8410: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8411: </div>
1.41 asau 8412: <div class="sect2">
1.40 wiz 8413: <div class="titlepage"><div><div><h3 class="title">
8414: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8415: <p>Currently, there is no special handling for other languages
8416: in pkgsrc. If a compiler package provides a
8417: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8418: just add a (build) dependency on the appropriate compiler
8419: package.</p>
8420: </div>
8421: </div>
1.41 asau 8422: <div class="sect1">
1.1 dsieger 8423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8424: <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 8425: <p>The most common failures when building a package are that
8426: some platforms do not provide certain header files, functions or
8427: libraries, or they provide the functions in a library that the
8428: original package author didn't know. To work around this, you
8429: can rewrite the source code in most cases so that it does not
8430: use the missing functions or provides a replacement function.</p>
1.41 asau 8431: <div class="sect2">
1.1 dsieger 8432: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8433: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8434: <p>If a package already comes with a GNU configure script, the
8435: preferred way to fix the build failure is to change the
8436: configure script, not the code. In the other cases, you can
8437: utilize the C preprocessor, which defines certain macros
8438: depending on the operating system and hardware architecture it
8439: compiles for. These macros can be queried using for example
8440: <code class="varname">#if defined(__i386)</code>. Almost every operating
8441: system, hardware architecture and compiler has its own macro.
8442: For example, if the macros <code class="varname">__GNUC__</code>,
8443: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8444: are all defined, you know that you are using NetBSD on an i386
8445: compatible CPU, and your compiler is GCC.</p>
8446: <p>The list of the following macros for hardware and
8447: operating system depends on the compiler that is used. For
8448: example, if you want to conditionally compile code on Solaris,
8449: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8450: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8451: <div class="sect3">
1.1 dsieger 8452: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8453: <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 8454: <p>To distinguish between 4.4 BSD-derived systems and the
8455: rest of the world, you should use the following code.</p>
8456: <pre class="programlisting">
8457: #include <sys/param.h>
8458: #if (defined(BSD) && BSD >= 199306)
8459: /* BSD-specific code goes here */
8460: #else
8461: /* non-BSD-specific code goes here */
8462: #endif
8463: </pre>
8464: <p>If this distinction is not fine enough, you can also test
8465: for the following macros.</p>
8466: <pre class="programlisting">
1.45 obache 8467: Cygwin __CYGWIN__
8468: DragonFly __DragonFly__
1.1 dsieger 8469: FreeBSD __FreeBSD__
1.45 obache 8470: Haiku __HAIKU__
1.1 dsieger 8471: Interix __INTERIX
8472: IRIX __sgi (TODO: get a definite source for this)
8473: Linux linux, __linux, __linux__
1.45 obache 8474: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8475: Minix3 __minix
1.1 dsieger 8476: NetBSD __NetBSD__
8477: OpenBSD __OpenBSD__
8478: Solaris sun, __sun
8479: </pre>
8480: </div>
1.41 asau 8481: <div class="sect3">
1.1 dsieger 8482: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8483: <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 8484: <pre class="programlisting">
8485: i386 i386, __i386, __i386__
8486: MIPS __mips
8487: SPARC sparc, __sparc
8488: </pre>
8489: </div>
1.41 asau 8490: <div class="sect3">
1.1 dsieger 8491: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8492: <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 8493: <pre class="programlisting">
8494: GCC __GNUC__ (major version), __GNUC_MINOR__
8495: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8496: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8497: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8498: </pre>
8499: </div>
8500: </div>
1.41 asau 8501: <div class="sect2">
1.1 dsieger 8502: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8503: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8504: <p>Some source files trigger bugs in the compiler, based on
8505: combinations of compiler version and architecture and almost
8506: always relation to optimisation being enabled. Common symptoms
8507: are gcc internal errors or never finishing compiling a
8508: file.</p>
8509: <p>Typically, a workaround involves testing the
8510: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8511: optimisation for that combination of file,
8512: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8513: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8514: number of examples.</p>
8515: </div>
1.41 asau 8516: <div class="sect2">
1.1 dsieger 8517: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 8518: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8519: </h3></div></div></div>
1.1 dsieger 8520: <p>This error message often means that a package did not
8521: link to a shared library it needs. The following functions are
8522: known to cause this error message over and over.</p>
8523: <div class="informaltable">
8524: <a name="undefined-reference-functions"></a><table border="1">
8525: <colgroup>
8526: <col>
8527: <col>
8528: <col>
8529: </colgroup>
8530: <thead><tr>
8531: <th>Function</th>
8532: <th>Library</th>
8533: <th>Affected platforms</th>
8534: </tr></thead>
8535: <tbody>
8536: <tr>
8537: <td>accept, bind, connect</td>
8538: <td>-lsocket</td>
8539: <td>Solaris</td>
8540: </tr>
8541: <tr>
8542: <td>crypt</td>
8543: <td>-lcrypt</td>
8544: <td>DragonFly, NetBSD</td>
8545: </tr>
8546: <tr>
8547: <td>dlopen, dlsym</td>
8548: <td>-ldl</td>
8549: <td>Linux</td>
8550: </tr>
8551: <tr>
8552: <td>gethost*</td>
8553: <td>-lnsl</td>
8554: <td>Solaris</td>
8555: </tr>
8556: <tr>
8557: <td>inet_aton</td>
8558: <td>-lresolv</td>
8559: <td>Solaris</td>
8560: </tr>
8561: <tr>
8562: <td>nanosleep, sem_*, timer_*</td>
8563: <td>-lrt</td>
8564: <td>Solaris</td>
8565: </tr>
8566: <tr>
8567: <td>openpty</td>
8568: <td>-lutil</td>
8569: <td>Linux</td>
8570: </tr>
8571: </tbody>
8572: </table>
8573: </div>
8574: <p>To fix these linker errors, it is often sufficient to say
8575: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8576: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8577: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8578: bmake</strong></span>.</p>
1.41 asau 8579: <div class="sect3">
1.1 dsieger 8580: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8581: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8582: <p>When you are using the SunPro compiler, there is another
8583: possibility. That compiler cannot handle the following code:</p>
8584: <pre class="programlisting">
8585: extern int extern_func(int);
8586:
8587: static inline int
8588: inline_func(int x)
8589: {
8590: return extern_func(x);
8591: }
8592:
8593: int main(void)
8594: {
8595: return 0;
8596: }
8597: </pre>
8598: <p>It generates the code for <code class="function">inline_func</code> even if
8599: that function is never used. This code then refers to
8600: <code class="function">extern_func</code>, which can usually not be resolved. To
8601: solve this problem you can try to tell the package to disable inlining
8602: of functions.</p>
8603: </div>
8604: </div>
1.41 asau 8605: <div class="sect2">
1.1 dsieger 8606: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8607: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8608: <p>Sometimes packages fail to build because the compiler runs
8609: into an operating system specific soft limit. With the
8610: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8611: to unlimit the resources. Currently, the allowed values are
1.23 wiz 8612: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.1 dsieger 8613: Setting this variable is similar to running the shell builtin
1.10 hubertf 8614: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8615: segment size or maximum stack size of a process, respectively, to
8616: their hard limits.</p>
8617: </div>
8618: </div>
1.41 asau 8619: <div class="sect1">
1.1 dsieger 8620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8621: <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 8622: <div class="sect2">
1.1 dsieger 8623: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8624: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8625: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8626: with some operating systems cannot create more than one
8627: directory at a time. As such, you should call
8628: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8629: <pre class="programlisting">
8630: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8631: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8632: </pre>
1.23 wiz 8633: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8634: dir2</code></span>”</span> to the
1.1 dsieger 8635: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8636: automatically do the right thing.</p>
8637: </div>
1.41 asau 8638: <div class="sect2">
1.1 dsieger 8639: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8640: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8641: <p>In general, documentation should be installed into
8642: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8643: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8644: includes the version number of the package).</p>
8645: <p>Many modern packages using GNU autoconf allow to set the
8646: directory where HTML documentation is installed with the
1.23 wiz 8647: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8648: is needed because otherwise the documentation ends up in
8649: <code class="filename">${PREFIX}/share/doc/html</code> or other
8650: places.</p>
8651: <p>An exception to the above is that library API documentation
8652: 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
8653: browsers (devhelp) should be left at their default location, which
8654: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8655: documentation can be recognized from files ending in
8656: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8657: (It is also acceptable to install such files in
8658: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8659: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8660: <code class="filename">.devhelp*</code> file must be directly in that
8661: directory then, no additional subdirectory level is allowed in
8662: this case. This is usually achieved by using
1.23 wiz 8663: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8664: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8665: though.)</p>
8666: </div>
1.41 asau 8667: <div class="sect2">
1.1 dsieger 8668: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8669: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8670: <p>Certain packages, most of them in the games category, install
8671: a score file that allows all users on the system to record their
8672: highscores. In order for this to work, the binaries need to be
8673: installed setgid and the score files owned by the appropriate
1.35 wiz 8674: group and/or owner (traditionally the "games" user/group). Set
8675: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8676: following variables, documented in more detail in
8677: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8678: behaviour: <code class="varname">GAMEDATAMODE</code>,
8679: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8680: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.14 jmcneill 8681: <p>A package should therefore never hard code file ownership or
1.1 dsieger 8682: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8683: <code class="varname">INSTALL_GAME_DATA</code> to set these
8684: correctly.</p>
8685: </div>
1.41 asau 8686: <div class="sect2">
1.1 dsieger 8687: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8688: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8689: <p><code class="varname">DESTDIR</code> support means that a package
8690: installs into a staging directory, not the final location of the
8691: files. Then a binary package is created which can be used for
8692: installation as usual. There are two ways: Either the package must
1.23 wiz 8693: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8694: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8695: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8696: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 8697: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8698: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8699: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8700: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8701: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8702: the inclusion.</p></li>
1.23 wiz 8703: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8704: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8705: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8706: automatically. Many manual rules and pre/post-install often are
8707: incorrect; fix them.</p></li>
1.23 wiz 8708: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8709: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8710: <li class="listitem"><p>In general, packages should support
1.4 rillig 8711: <code class="varname">UNPRIVILEGED</code> to be able to use
8712: DESTDIR.</p></li>
8713: </ul></div>
8714: </div>
1.41 asau 8715: <div class="sect2">
1.4 rillig 8716: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8717: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8718: <p>Your package may also contain scripts with hardcoded paths to
8719: other interpreters besides (or as well as) perl. To correct the
8720: full pathname to the script interpreter, you need to set the
8721: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8722: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8723: <pre class="programlisting">
8724: REPLACE_INTERPRETER+= tcl
8725: REPLACE.tcl.old= .*/bin/tclsh
8726: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8727: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8728: # relative to ${WRKSRC}, just as in REPLACE_PERL
8729: </pre>
1.41 asau 8730: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8731: <h3 class="title">Note</h3>
8732: <p>Before March 2006, these variables were called
8733: <code class="varname">_REPLACE.*</code> and
8734: <code class="varname">_REPLACE_FILES.*</code>.</p>
8735: </div>
8736: </div>
1.41 asau 8737: <div class="sect2">
1.1 dsieger 8738: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8739: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8740: <p>Makefiles of packages providing perl5 modules should include
8741: the Makefile fragment
8742: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8743: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8744: configuration for such modules as well as various hooks to tune
8745: this configuration. See comments in this file for
8746: details.</p>
8747: <p>Perl5 modules will install into different places depending
8748: on the version of perl used during the build process. To
8749: address this, pkgsrc will append lines to the
8750: <code class="filename">PLIST</code> corresponding to the files listed in
8751: the installed <code class="filename">.packlist</code> file generated by
8752: most perl5 modules. This is invoked by defining
8753: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8754: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8755: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8756: e.g.:</p>
1.1 dsieger 8757: <pre class="programlisting">
1.47 wiz 8758: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 8759: </pre>
1.47 wiz 8760: <p>The perl5 config variables
8761: <code class="varname">installarchlib</code>,
8762: <code class="varname">installscript</code>,
8763: <code class="varname">installvendorbin</code>,
8764: <code class="varname">installvendorscript</code>,
8765: <code class="varname">installvendorarch</code>,
8766: <code class="varname">installvendorlib</code>,
8767: <code class="varname">installvendorman1dir</code>, and
8768: <code class="varname">installvendorman3dir</code> represent those
8769: locations in which components of perl5 modules may be installed,
8770: provided as variable with uppercase and prefixed with
8771: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8772: and may be used by perl5 packages that don't have a packlist.
8773: These variables are also substituted for in the
8774: <code class="filename">PLIST</code> as uppercase prefixed with
8775: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8776: </div>
1.41 asau 8777: <div class="sect2">
1.1 dsieger 8778: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8779: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8780: <p>Some packages install info files or use the
1.23 wiz 8781: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8782: commands. <code class="varname">INFO_FILES</code> should be defined in
8783: the package Makefile so that <code class="filename">INSTALL</code> and
8784: <code class="filename">DEINSTALL</code> scripts will be generated to
8785: handle registration of the info files in the Info directory
1.23 wiz 8786: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8787: files registration is either provided by the system, or by a
8788: special purpose package automatically added as dependency if
8789: needed.</p>
8790: <p><code class="varname">PKGINFODIR</code> is the directory under
8791: <code class="filename">${PREFIX}</code> where info files are primarily
8792: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8793: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8794: <p>The info files for the package should be listed in the
8795: package <code class="filename">PLIST</code>; however any split info files
8796: need not be listed.</p>
1.23 wiz 8797: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8798: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8799: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8800: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8801: should be noted with the <code class="varname">TEXINFO_REQD</code>
8802: variable in the package <code class="filename">Makefile</code>. By
8803: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8804: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8805: does not match the required minimum, a build dependency on the
8806: <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
8807: be added automatically.</p>
8808: <p>The build and installation process of the software provided
8809: by the package should not use the
1.10 hubertf 8810: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8811: info files is the task of the package
8812: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8813: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8814: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8815: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8816: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8817: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8818: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8819: no effect except the logging of a message. The script overriding
1.10 hubertf 8820: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8821: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8822: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8823: </div>
1.41 asau 8824: <div class="sect2">
1.1 dsieger 8825: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8826: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8827: <p>All packages that install manual pages should install them
8828: into the same directory, so that there is one common place to look
8829: for them. In pkgsrc, this place is
8830: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8831: should be used in packages. The default for
8832: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8833: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8834: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8835: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8836: <h3 class="title">Note</h3>
8837: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8838: is far from complete.</p>
8839: </div>
8840: <p>The <code class="filename">PLIST</code> files can just use
8841: <code class="filename">man/</code> as the top level directory for the man
8842: page file entries, and the pkgsrc framework will convert as
8843: needed. In all other places, the correct
8844: <code class="varname">PKGMANDIR</code> must be used.</p>
8845: <p>Packages that are
8846: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8847: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8848: <code class="filename">./configure</code>
8849: --mandir switch to set where the man pages should be installed.
8850: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8851: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8852: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8853: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8854: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8855: Or if the <code class="filename">./configure</code> script uses
8856: a non-standard use of --mandir, you can set
8857: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8858: <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 8859: information on installation of compressed manual pages.</p>
8860: </div>
1.41 asau 8861: <div class="sect2">
1.1 dsieger 8862: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8863: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8864: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8865: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8866: you need to take some extra steps to make sure they get registered
8867: in the database:</p>
1.23 wiz 8868: <div class="orderedlist"><ol class="orderedlist" type="1">
8869: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8870: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8871: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8872: deinstallation time, and tells the package where to install
1.7 rillig 8873: GConf data files using some standard configure arguments. It
1.1 dsieger 8874: also disallows any access to the database directly from the
8875: package.</p></li>
1.23 wiz 8876: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8877: <code class="filename">.schemas</code> files under
8878: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8879: installed under <code class="filename">${PREFIX}/etc</code>, you will
8880: need to manually patch the package.</p></li>
1.23 wiz 8881: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8882: directory, as they will be handled automatically. See
1.65 wiz 8883: <a class="xref" href="#faq.conf" title="9.14. How do I change the location of configuration files?">Section 9.14, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.23 wiz 8884: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8885: your <code class="filename">Makefile</code> with a list of all
8886: <code class="filename">.schemas</code> files installed by the package, if
8887: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8888: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8889: your <code class="filename">Makefile</code> with a
8890: list of all <code class="filename">.entries</code> files installed by the
8891: package, if any. Names must not contain any directories in
8892: them.</p></li>
8893: </ol></div>
8894: </div>
1.41 asau 8895: <div class="sect2">
1.1 dsieger 8896: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8897: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8898: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8899: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8900: get registered in the database:</p>
1.23 wiz 8901: <div class="orderedlist"><ol class="orderedlist" type="1">
8902: <li class="listitem"><p>Include
1.18 snj 8903: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8904: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8905: takes care of rebuilding the scrollkeeper database at
8906: installation and deinstallation time, and disallows any access
8907: to it directly from the package.</p></li>
1.23 wiz 8908: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8909: <code class="filename">libdata/scrollkeeper</code> directory, as they
8910: will be handled automatically.</p></li>
1.23 wiz 8911: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8912: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8913: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8914: </ol></div>
8915: </div>
1.41 asau 8916: <div class="sect2">
1.1 dsieger 8917: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8918: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8919: <p>If a package installs font files, you will need to rebuild
8920: the fonts database in the directory where they get installed at
8921: installation and deinstallation time. This can be automatically
8922: done by using the pkginstall framework.</p>
8923: <p>You can list the directories where fonts are installed in the
8924: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8925: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8926: <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 8927: Also make sure that the database file
8928: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8929: <p>Note that you should not create new directories for fonts;
8930: instead use the standard ones to avoid that the user needs to
8931: manually configure his X server to find them.</p>
8932: </div>
1.41 asau 8933: <div class="sect2">
1.1 dsieger 8934: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8935: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8936: <p>If a package installs GTK2 immodules or loaders, you need to
8937: take some extra steps to get them registered in the GTK2 database
8938: properly:</p>
1.23 wiz 8939: <div class="orderedlist"><ol class="orderedlist" type="1">
8940: <li class="listitem"><p>Include
1.1 dsieger 8941: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8942: <code class="filename">buildlink3.mk</code> file. This takes care of
8943: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8944: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8945: your package installs GTK2 immodules.</p></li>
1.23 wiz 8946: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8947: GTK2 loaders.</p></li>
1.23 wiz 8948: <li class="listitem">
1.1 dsieger 8949: <p>Patch the package to not touch any of the GTK2
8950: databases directly. These are:</p>
1.41 asau 8951: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8952: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8953: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8954: </ul></div>
8955: </li>
1.23 wiz 8956: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8957: any entries under the <code class="filename">libdata/gtk-2.0</code>
8958: directory, as they will be handled automatically.</p></li>
8959: </ol></div>
8960: </div>
1.41 asau 8961: <div class="sect2">
1.1 dsieger 8962: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8963: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8964: <p>If a package installs SGML or XML data files that need to be
8965: registered in system-wide catalogs (like DTDs, sub-catalogs,
8966: etc.), you need to take some extra steps:</p>
1.23 wiz 8967: <div class="orderedlist"><ol class="orderedlist" type="1">
8968: <li class="listitem"><p>Include
1.1 dsieger 8969: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8970: your <code class="filename">Makefile</code>, which takes care of
8971: registering those files in system-wide catalogs at
8972: installation and deinstallation time.</p></li>
1.23 wiz 8973: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8974: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8975: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8976: any XML catalogs installed by the package.</p></li>
1.23 wiz 8977: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8978: to be added to the SGML catalog. These come in groups of
8979: three strings; see xmlcatmgr(1) for more information
8980: (specifically, arguments recognized by the 'add' action).
8981: Note that you will normally not use this variable.</p></li>
1.23 wiz 8982: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8983: to be added to the XML catalog. These come in groups of three
8984: strings; see xmlcatmgr(1) for more information (specifically,
8985: arguments recognized by the 'add' action). Note that you will
8986: normally not use this variable.</p></li>
8987: </ol></div>
8988: </div>
1.41 asau 8989: <div class="sect2">
1.1 dsieger 8990: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8991: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8992: <p>If a package provides extensions to the MIME database by
8993: installing <code class="filename">.xml</code> files inside
8994: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8995: need to take some extra steps to ensure that the database is kept
8996: consistent with respect to these new files:</p>
1.23 wiz 8997: <div class="orderedlist"><ol class="orderedlist" type="1">
8998: <li class="listitem"><p>Include
1.1 dsieger 8999: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9000: (avoid using the <code class="filename">buildlink3.mk</code> file from
9001: this same directory, which is reserved for inclusion from
9002: other <code class="filename">buildlink3.mk</code> files). It takes
9003: care of rebuilding the MIME database at installation and
9004: deinstallation time, and disallows any access to it directly
9005: from the package.</p></li>
1.23 wiz 9006: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9007: <code class="filename">share/mime</code> directory,
9008: <span class="emphasis"><em>except</em></span> for files saved under
9009: <code class="filename">share/mime/packages</code>. The former are
9010: handled automatically by
9011: the update-mime-database program, but the latter are
9012: package-dependent and must be removed by the package that
9013: installed them in the first place.</p></li>
1.23 wiz 9014: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9015: from the PLIST. They will be handled by the shared-mime-info
9016: package.</p></li>
9017: </ol></div>
9018: </div>
1.41 asau 9019: <div class="sect2">
1.1 dsieger 9020: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9021: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9022: <p>If a package uses intltool during its build, add
9023: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9024: which forces it to use the intltool package provided by pkgsrc,
9025: instead of the one bundled with the distribution file.</p>
9026: <p>This tracks intltool's build-time dependencies and uses the
9027: latest available version; this way, the package benefits of any
9028: bug fixes that may have appeared since it was released.</p>
9029: </div>
1.41 asau 9030: <div class="sect2">
1.1 dsieger 9031: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9032: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9033: <p>If a package contains a rc.d script, it won't be copied into
9034: the startup directory by default, but you can enable it, by adding
9035: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9036: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9037: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9038: it will automatically remove the scripts when the package is
9039: deinstalled.</p>
9040: </div>
1.41 asau 9041: <div class="sect2">
1.1 dsieger 9042: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9043: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9044: <p>If a package installs TeX packages into the texmf tree,
9045: the <code class="filename">ls-R</code> database of the tree needs to be
9046: updated.</p>
1.41 asau 9047: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9048: <h3 class="title">Note</h3>
1.22 jakllsch 9049: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9050: packages should install files
1.22 jakllsch 9051: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9052: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9053: </div>
1.23 wiz 9054: <div class="orderedlist"><ol class="orderedlist" type="1">
9055: <li class="listitem"><p>Include
1.22 jakllsch 9056: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9057: takes care of rebuilding the <code class="filename">ls-R</code>
9058: database at installation and deinstallation time.</p></li>
1.23 wiz 9059: <li class="listitem">
1.1 dsieger 9060: <p>If your package installs files into a texmf
9061: tree other than the one
1.22 jakllsch 9062: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9063: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9064: trees that need database update.</p>
9065: <p>If your package also installs font map files that need
1.10 hubertf 9066: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9067: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9068: set <code class="varname">TEX_MAP_FILES</code> and/or
9069: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9070: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9071: be run automatically at installation/deinstallation to
9072: enable/disable font map files for TeX output
9073: drivers.</p>
9074: </li>
1.23 wiz 9075: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9076: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9077: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9078: </ol></div>
9079: </div>
1.41 asau 9080: <div class="sect2">
1.1 dsieger 9081: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9082: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9083: emulation</h3></div></div></div>
9084: <p>There are some packages that provide libraries and
9085: executables for running binaries from a one operating system
9086: on a different one (if the latter supports it). One example
9087: is running Linux binaries on NetBSD.</p>
9088: <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>
9089: helps in extracting and packaging Linux rpm packages.</p>
9090: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9091: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9092: if all libraries for each installed executable can be found by
9093: the dynamic linker. Since the standard dynamic linker is run,
9094: this fails for emulation packages, because the libraries used
9095: by the emulation are not in the standard directories.</p>
9096: </div>
1.41 asau 9097: <div class="sect2">
1.1 dsieger 9098: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9099: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9100: <p>If a package installs images under the
9101: <code class="filename">share/icons/hicolor</code> and/or updates the
9102: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9103: database, you need to take some extra steps to make sure that the
9104: shared theme directory is handled appropriately and that the cache
9105: database is rebuilt:</p>
1.23 wiz 9106: <div class="orderedlist"><ol class="orderedlist" type="1">
9107: <li class="listitem"><p>Include
1.1 dsieger 9108: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 9109: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 9110: entry that refers to the theme cache.</p></li>
1.23 wiz 9111: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 9112: directories from the <code class="filename">share/icons/hicolor</code>
9113: hierarchy because they will be handled automatically.</p></li>
9114: </ol></div>
9115: <p>The best way to verify that the PLIST is correct with
9116: respect to the last two points is to regenerate it using
1.10 hubertf 9117: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9118: </div>
1.41 asau 9119: <div class="sect2">
1.1 dsieger 9120: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9121: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9122: <p>If a package installs <code class="filename">.desktop</code> files
9123: under <code class="filename">share/applications</code> and these include
1.53 rodent 9124: MIME information (MimeType key), you need to take extra steps to
9125: ensure that they are registered into the MIME database:</p>
1.23 wiz 9126: <div class="orderedlist"><ol class="orderedlist" type="1">
9127: <li class="listitem"><p>Include
1.1 dsieger 9128: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 9129: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 9130: <code class="filename">share/applications/mimeinfo.cache</code> file.
9131: It will be handled automatically.</p></li>
9132: </ol></div>
9133: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9134: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9135: print-PLIST</strong></span>.</p>
9136: </div>
9137: </div>
1.41 asau 9138: <div class="sect1">
1.1 dsieger 9139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9140: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9141: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 9142: immediately. In this case, one can plainly mark a package as broken. For
9143: this, one just sets the variable <code class="varname">BROKEN</code> to the
9144: reason why the package is broken (similar to the
9145: <code class="varname">RESTRICTED</code> variable). A user trying to build
9146: the package will immediately be shown this message, and the build
9147: will not be even tried.</p>
9148: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 9149: intervals.</p>
9150: </div>
9151: </div>
1.41 asau 9152: <div class="chapter">
1.1 dsieger 9153: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9154: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9155: <p>To check out all the gotchas when building a package, here are
9156: the steps that I do in order to get a package working. Please note
9157: this is basically the same as what was explained in the previous
9158: sections, only with some debugging aids.</p>
1.41 asau 9159: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9160: <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>
9161: <li class="listitem">
1.1 dsieger 9162: <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>,
9163: create a directory for a new package, change into it, then run
1.10 hubertf 9164: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9165: <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>
9166: <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>
9167: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9168: </li>
1.23 wiz 9169: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9170: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9171: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9172: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 9173: configure step to the package's
9174: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 9175: <li class="listitem">
1.1 dsieger 9176: <p>Make the package compile, doing multiple rounds of</p>
9177: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9178: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9179: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9180: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9181: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9182: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9183: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9184: <p>Doing this step as non-root user will ensure that no files
9185: are modified that shouldn't be, especially during the build
1.10 hubertf 9186: phase. <span class="command"><strong>mkpatches</strong></span>,
9187: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1 dsieger 9188: 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>
9189: package.</p>
9190: </li>
1.23 wiz 9191: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9192: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9193: <li class="listitem">
1.1 dsieger 9194: <p>Generate a <code class="filename">PLIST</code>:</p>
9195: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9196: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9197: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9198: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9199: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9200: <p>You usually need to be <code class="username">root</code> to do
9201: this. Look if there are any files left:</p>
9202: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9203: <p>If this reveals any files that are missing in
9204: <code class="filename">PLIST</code>, add them.</p>
9205: </li>
1.23 wiz 9206: <li class="listitem">
1.1 dsieger 9207: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9208: package again and make a binary package:</p>
9209: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9210: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9211: </li>
1.23 wiz 9212: <li class="listitem">
1.1 dsieger 9213: <p>Delete the installed package:</p>
9214: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9215: </li>
1.23 wiz 9216: <li class="listitem">
1.10 hubertf 9217: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9218: command, which shouldn't find anything now:</p>
9219: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9220: </li>
1.23 wiz 9221: <li class="listitem">
1.1 dsieger 9222: <p>Reinstall the binary package:</p>
9223: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9224: </li>
1.23 wiz 9225: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9226: <li class="listitem">
1.10 hubertf 9227: <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 9228: reports:</p>
9229: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9230: </li>
1.23 wiz 9231: <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 9232: </ul></div>
9233: </div>
1.41 asau 9234: <div class="chapter">
1.1 dsieger 9235: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9236: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9237: <div class="toc">
9238: <p><b>Table of Contents</b></p>
9239: <dl>
1.6 rillig 9240: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9241: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9242: <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 9243: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 9244: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 9245: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9246: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9247: </dl>
9248: </div>
1.41 asau 9249: <div class="sect1">
1.1 dsieger 9250: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9251: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9252: <p>Our policy is that we accept binaries only from pkgsrc
9253: developers to guarantee that the packages don't contain any
9254: trojan horses etc. This is not to annoy anyone but rather to
9255: protect our users! You're still free to put up your home-made
9256: binary packages and tell the world where to get them. NetBSD
9257: developers doing bulk builds and wanting to upload them please
1.66 ! asau 9258: 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
! 9259: builds)</i></a>.</p>
1.1 dsieger 9260: </div>
1.41 asau 9261: <div class="sect1">
1.1 dsieger 9262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9263: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9264: <p>First, check that your package is complete, compiles and
1.10 hubertf 9265: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.29 dholland 9266: 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 9267: archive that contains all files that make up the package.
9268: Finally, send this package to the pkgsrc bug tracking system,
1.29 dholland 9269: 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 9270: that, go to the web page
1.10 hubertf 9271: <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 9272: which contains some instructions and a link to a form where you
9273: can submit packages. The
9274: <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
9275: also available as a substitute for either of the above two tools.
9276: </p>
1.1 dsieger 9277: <p>In the form of the problem report, the category should be
1.23 wiz 9278: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9279: and version number, and the description field should contain a
9280: short description of your package (contents of the COMMENT
9281: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9282: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9283: <p>If you want to submit several packages, please send a
9284: separate PR for each one, it's easier for us to track things
9285: that way.</p>
9286: <p>Alternatively, you can also import new packages into
1.23 wiz 9287: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.10 hubertf 9288: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1 dsieger 9289: for details.</p>
9290: </div>
1.41 asau 9291: <div class="sect1">
1.1 dsieger 9292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9293: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9294: <p>Please note all package additions, updates, moves, and
9295: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9296: important to keep this file up to date and conforming to the
9297: existing format, because it will be used by scripts to
1.10 hubertf 9298: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9299: sites. Additionally, check the
9300: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9301: for the package you updated or removed, in case it was mentioned
9302: there.</p>
9303: <p>When the <code class="varname">PKGREVISION</code> of a package is
9304: bumped, the change should appear in
9305: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9306: related or otherwise relevant. Mass bumps that result from a
9307: dependency being updated should not be mentioned. In all other
9308: cases it's the developer's decision.</p>
9309: <p>There is a make target that helps in creating proper
1.10 hubertf 9310: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9311: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9312: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9313: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9314: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9315: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9316: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9317: For new packages, or package moves or removals, set the
9318: <code class="varname">CTYPE</code> variable on the command line to "Added",
9319: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9320: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9321: not the same as your NetBSD login name. The target also automatically
9322: removes possibly existing entries for the package in the
9323: <code class="filename">TODO</code> file. Don't forget to commit
1.66 ! asau 9324: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9325: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9326: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9327: makes the cvs commands use the main repository.
9328: </p>
1.1 dsieger 9329: </div>
1.41 asau 9330: <div class="sect1">
1.1 dsieger 9331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 9332: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9333: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9334: access to the pkgsrc repository.</p>
9335: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9336: Start by adding the directory and then files in the directory. Don't
9337: forget to add the new package to the category's
9338: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9339: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9340: <pre class="programlisting">
9341: <code class="prompt">$</code> cd .../pkgsrc/category
9342: <code class="prompt">$</code> cvs add pkgname
9343: <code class="prompt">$</code> cd pkgname
9344: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9345: <code class="prompt">$</code> cvs add patches/p*
9346: <code class="prompt">$</code> cvs status | less
1.34 wiz 9347: <code class="prompt">$</code> cvs commit
1.33 wiz 9348: <code class="prompt">$</code> cd ..
9349: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9350: <code class="prompt">$</code> cvs commit Makefile
1.66 ! asau 9351: <code class="prompt">$</code> cd pkgname
! 9352: <code class="prompt">$</code> make CTYPE=Added changes-entry
! 9353: <code class="prompt">$</code> make commit-changes-entry
1.33 wiz 9354: </pre>
1.1 dsieger 9355: <p>The commit message of the initial import should include part of the
9356: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9357: what the package is/does.</p>
1.33 wiz 9358: <p>Also mention the new package in
9359: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9360: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9361: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</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="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9366: <p>Please always put a concise, appropriate and relevant summary of the
9367: changes between old and new versions into the commit log when updating
9368: a package. There are various reasons for this:</p>
1.41 asau 9369: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9370: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9371: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9372: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9373: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9374: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9375: repository is very useful for people who read the pkgsrc-changes mailing
9376: list, so that they can make tactical decisions about when to upgrade
9377: the package.</p></li>
9378: </ul></div>
9379: <p>Please also recognize that, just because a new version of a package
9380: has been released, it should not automatically be upgraded in the CVS
9381: repository. We prefer to be conservative in the packages that are
9382: included in pkgsrc - development or beta packages are not really the
9383: best thing for most places in which pkgsrc is used. Please use your
9384: judgement about what should go into pkgsrc, and bear in mind that
9385: stability is to be preferred above new and possibly untested features.</p>
9386: </div>
1.41 asau 9387: <div class="sect1">
1.1 dsieger 9388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 9389: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9390: <p>Renaming packages is not recommended.</p>
9391: <p>When renaming packages, be sure to fix any references to old name
9392: in other Makefiles, options, buildlink files, etc.</p>
9393: <p>Also When renaming a package, please define
9394: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9395: pattern(s) of the previous package name.
9396: This may be repeated for multiple renames.
9397: The new package would be an exact replacement.
9398: </p>
1.23 wiz 9399: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9400: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9401: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9402: not be an exact replacement but is a suggestion for the replaced
9403: functionality.</p>
9404: </div>
1.41 asau 9405: <div class="sect1">
1.20 snj 9406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9407: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9408: <p>It is preferred that packages are not renamed or moved, but if needed
9409: please follow these steps.
9410: </p>
1.23 wiz 9411: <div class="orderedlist"><ol class="orderedlist" type="1">
9412: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9413: <li class="listitem">
1.1 dsieger 9414: <p>Remove all CVS dirs.</p>
9415: <p>Alternatively to the first two steps you can also do:</p>
9416: <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>
9417: <p>and use that for further work.</p>
9418: </li>
1.23 wiz 9419: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9420: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9421: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9422: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9423: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9424: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9425: for doing an update using pkgsrc building; for example, it can
1.29 dholland 9426: 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 9427: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9428: new <code class="varname">PKGPATH</code> for that moved package. Note that
9429: it may have multiple matches, so the tool should also check on the
9430: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9431: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9432: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9433: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9434: place.</p></li>
1.23 wiz 9435: <li class="listitem">
1.1 dsieger 9436: <p>Check if any package depends on it:
9437: </p>
9438: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9439: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9440: </li>
1.23 wiz 9441: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9442: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9443: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9444: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9445: <li class="listitem">
1.1 dsieger 9446: <p>Commit the changed and removed files:</p>
9447: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9448: <p>(and any packages from step 5, of course).</p>
9449: </li>
9450: </ol></div>
9451: </div>
9452: </div>
1.41 asau 9453: <div class="chapter">
1.1 dsieger 9454: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9455: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9456: <p>This section contains the answers to questions that may
9457: arise when you are writing a package. If you don't find your
9458: question answered here, first have a look in the other chapters,
9459: and if you still don't have the answer, ask on the
9460: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9461: <div class="qandaset">
1.66 ! asau 9462: <a name="idm30948932"></a><dl>
1.6 rillig 9463: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9464: MAKEFLAGS, .MAKEFLAGS and
9465: MAKE_FLAGS?</a>
9466: </dt>
1.6 rillig 9467: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9468: MAKE, GMAKE and
9469: MAKE_PROGRAM?</a>
9470: </dt>
1.6 rillig 9471: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9472: CC, PKG_CC and
9473: PKGSRC_COMPILER?</a>
9474: </dt>
1.6 rillig 9475: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9476: BUILDLINK_LDFLAGS,
9477: BUILDLINK_LDADD and
9478: BUILDLINK_LIBS?</a>
9479: </dt>
1.6 rillig 9480: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9481: VARNAME=BUILDLINK_PREFIX.foo
9482: say it's empty?</a>
9483: </dt>
1.6 rillig 9484: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9485: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9486: don't understand the := inside
9487: it.</a>
9488: </dt>
1.6 rillig 9489: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9490: developers?</a>
9491: </dt>
1.6 rillig 9492: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9493: documentation?</a>
9494: </dt>
1.6 rillig 9495: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9496: do?</a>
9497: </dt>
9498: </dl>
1.41 asau 9499: <table border="0" style="width: 100%;">
9500: <colgroup>
1.1 dsieger 9501: <col align="left" width="1%">
1.23 wiz 9502: <col>
1.41 asau 9503: </colgroup>
1.1 dsieger 9504: <tbody>
1.41 asau 9505: <tr class="question">
1.1 dsieger 9506: <td align="left" valign="top">
1.66 ! asau 9507: <a name="devfaq.makeflags"></a><a name="idm30948740"></a><p><b>22.1.</b></p>
1.1 dsieger 9508: </td>
9509: <td align="left" valign="top"><p>What is the difference between
9510: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9511: <code class="varname">MAKE_FLAGS</code>?</p></td>
9512: </tr>
9513: <tr class="answer">
9514: <td align="left" valign="top"></td>
9515: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.29 dholland 9516: 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 9517: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9518: the <code class="varname">MAKE_PROGRAM</code> when building the
9519: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9520: </tr>
1.41 asau 9521: <tr class="question">
1.1 dsieger 9522: <td align="left" valign="top">
1.66 ! asau 9523: <a name="devfaq.make"></a><a name="idm30938372"></a><p><b>22.2.</b></p>
1.1 dsieger 9524: </td>
9525: <td align="left" valign="top"><p>What is the difference between
9526: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9527: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9528: </tr>
9529: <tr class="answer">
9530: <td align="left" valign="top"></td>
9531: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.29 dholland 9532: <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 9533: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9534: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9535: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9536: Make program that is used for building the
9537: package.</p></td>
9538: </tr>
1.41 asau 9539: <tr class="question">
1.1 dsieger 9540: <td align="left" valign="top">
1.66 ! asau 9541: <a name="devfaq.cc"></a><a name="idm30936068"></a><p><b>22.3.</b></p>
1.1 dsieger 9542: </td>
9543: <td align="left" valign="top"><p>What is the difference between
9544: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9545: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9546: </tr>
9547: <tr class="answer">
9548: <td align="left" valign="top"></td>
9549: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9550: compiler, which can be configured by the pkgsrc user.
9551: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9552: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9553: path to a compiler, but the type of compiler that should be
9554: used. See <code class="filename">mk/compiler.mk</code> for more
9555: information about the latter variable.</p></td>
9556: </tr>
1.41 asau 9557: <tr class="question">
1.1 dsieger 9558: <td align="left" valign="top">
1.66 ! asau 9559: <a name="devfaq.bl3flags"></a><a name="idm30933956"></a><p><b>22.4.</b></p>
1.1 dsieger 9560: </td>
9561: <td align="left" valign="top"><p>What is the difference between
9562: <code class="varname">BUILDLINK_LDFLAGS</code>,
9563: <code class="varname">BUILDLINK_LDADD</code> and
9564: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9565: </tr>
9566: <tr class="answer">
9567: <td align="left" valign="top"></td>
9568: <td align="left" valign="top"><p>[FIXME]</p></td>
9569: </tr>
1.41 asau 9570: <tr class="question">
1.1 dsieger 9571: <td align="left" valign="top">
1.66 ! asau 9572: <a name="devfaq.bl3prefix"></a><a name="idm30932868"></a><p><b>22.5.</b></p>
1.1 dsieger 9573: </td>
1.10 hubertf 9574: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9575: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9576: say it's empty?</p></td>
9577: </tr>
9578: <tr class="answer">
9579: <td align="left" valign="top"></td>
9580: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9581: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9582: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9583: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9584: command.</p></td>
9585: </tr>
1.41 asau 9586: <tr class="question">
1.1 dsieger 9587: <td align="left" valign="top">
1.66 ! asau 9588: <a name="devfaq.master_sites"></a><a name="idm30931268"></a><p><b>22.6.</b></p>
1.1 dsieger 9589: </td>
9590: <td align="left" valign="top"><p>What does
9591: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9592: don't understand the <code class="literal">:=</code> inside
9593: it.</p></td>
9594: </tr>
9595: <tr class="answer">
9596: <td align="left" valign="top"></td>
9597: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9598: assignment operator, like you might expect at first sight.
9599: Instead, it is a degenerate form of
9600: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.29 dholland 9601: 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 9602: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9603: case of <code class="varname">MASTER_SITE_*</code>,
9604: <em class="replaceable"><code>old_string</code></em> is the empty string and
9605: <em class="replaceable"><code>new_string</code></em> is
9606: <code class="literal">package/</code>. That's where the
9607: <code class="literal">:</code> and the <code class="literal">=</code> fall
9608: together.</p></td>
9609: </tr>
1.41 asau 9610: <tr class="question">
1.1 dsieger 9611: <td align="left" valign="top">
1.66 ! asau 9612: <a name="devfaq.mailinglists"></a><a name="idm30927300"></a><p><b>22.7.</b></p>
1.1 dsieger 9613: </td>
9614: <td align="left" valign="top"><p>Which mailing lists are there for package
9615: developers?</p></td>
9616: </tr>
9617: <tr class="answer">
9618: <td align="left" valign="top"></td>
1.41 asau 9619: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9620: <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 9621: <dd><p>This is a list for technical discussions related
9622: to pkgsrc development, e.g. soliciting feedback for changes to
9623: pkgsrc infrastructure, proposed new features, questions related
9624: to porting pkgsrc to a new platform, advice for maintaining a
9625: package, patches that affect many packages, help requests moved
9626: from pkgsrc-users when an infrastructure bug is found,
9627: etc.</p></dd>
1.10 hubertf 9628: <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 9629: <dd><p>All bug reports in category "pkg" sent with
1.29 dholland 9630: <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 9631: directly; use one of the other mailing
9632: lists.</p></dd>
9633: </dl></div></td>
9634: </tr>
1.41 asau 9635: <tr class="question">
1.1 dsieger 9636: <td align="left" valign="top">
1.66 ! asau 9637: <a name="devfaq.documentation"></a><a name="idm30925252"></a><p><b>22.8.</b></p>
1.1 dsieger 9638: </td>
9639: <td align="left" valign="top"><p>Where is the pkgsrc
9640: documentation?</p></td>
9641: </tr>
9642: <tr class="answer">
9643: <td align="left" valign="top"></td>
9644: <td align="left" valign="top">
9645: <p>There are many places where you can find
9646: documentation about pkgsrc:</p>
1.41 asau 9647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9648: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9649: of chapters that explain large parts of pkgsrc, but some
9650: chapters tend to be outdated. Which ones they are is hard to
9651: say.</p></li>
1.23 wiz 9652: <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 9653: about certain features, announcements of new parts of the pkgsrc
9654: infrastructure and sometimes even announcements that a certain
9655: feature has been marked as obsolete. The benefit here is that
9656: each message has a date appended to it.</p></li>
1.23 wiz 9657: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9658: <code class="filename">mk/</code> directory start with a comment that
9659: describes the purpose of the file and how it can be used by the
9660: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9661: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9662: help</strong></span>.</p></li>
1.23 wiz 9663: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9664: information, but they tend to be highly abbreviated, especially
9665: for actions that occur often. Some contain a detailed
9666: description of what has changed, but they are geared towards the
9667: other pkgsrc developers, not towards an average pkgsrc user.
9668: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9669: don't know what has been before, these messages may not be worth
9670: too much to you.</p></li>
1.23 wiz 9671: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9672: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9673: mind of the developer who wrote the code. To get this
1.10 hubertf 9674: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9675: to see who has written it and ask on the
9676: <code class="literal">tech-pkg</code> mailing list, so that others can
9677: find your questions later (see above). To be sure that the
9678: developer in charge reads the mail, you may CC him or
9679: her.</p></li>
9680: </ul></div>
9681: </td>
9682: </tr>
1.41 asau 9683: <tr class="question">
1.1 dsieger 9684: <td align="left" valign="top">
1.66 ! asau 9685: <a name="devfaq.too-much-time"></a><a name="idm30921988"></a><p><b>22.9.</b></p>
1.1 dsieger 9686: </td>
9687: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9688: do?</p></td>
9689: </tr>
9690: <tr class="answer">
9691: <td align="left" valign="top"></td>
9692: <td align="left" valign="top">
9693: <p>This is not really an FAQ yet, but here's the answer
9694: anyway.</p>
1.41 asau 9695: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9696: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1 dsieger 9697: <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
9698: will tell you about newer versions of installed packages that are
9699: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9700: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9701: — it contains a list of suggested new packages and a list of
1.1 dsieger 9702: cleanups and enhancements for pkgsrc that would be nice to
9703: have.</p></li>
1.23 wiz 9704: <li class="listitem"><p>Review packages for which review was requested on
1.10 hubertf 9705: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1 dsieger 9706: mailing list.</p></li>
9707: </ul></div>
9708: </td>
9709: </tr>
9710: </tbody>
9711: </table>
9712: </div>
9713: </div>
1.41 asau 9714: <div class="chapter">
1.1 dsieger 9715: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9716: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9717: <div class="toc">
9718: <p><b>Table of Contents</b></p>
9719: <dl>
1.6 rillig 9720: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9721: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9722: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9723: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9724: </dl>
9725: </div>
1.10 hubertf 9726: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9727: site</a>:</p>
9728: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9729: environment, an intuitive and attractive desktop for users, and the
9730: GNOME development platform, an extensive framework for building
9731: applications that integrate into the rest of the desktop.</p></blockquote></div>
9732: <p>pkgsrc provides a seamless way to automatically build and install
9733: a complete GNOME environment <span class="emphasis"><em>under many different
9734: platforms</em></span>. We can say with confidence that pkgsrc is one of
9735: the most advanced build and packaging systems for GNOME due to its
9736: included technologies buildlink3, the wrappers and tools framework and
9737: automatic configuration file management. Lots of efforts are put into
9738: achieving a completely clean deinstallation of installed software
9739: components.</p>
1.10 hubertf 9740: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9741: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9742: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9743: pkgsrc as its preferred packaging system, contributing lots of
9744: portability fixes to make GNOME build and install under it.</p>
9745: <p>This chapter is aimed at pkgsrc developers and other people
9746: interested in helping our GNOME porting and packaging efforts. It
9747: provides instructions on how to manage the existing packages and some
9748: important information regarding their internals.</p>
1.41 asau 9749: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9750: <h3 class="title">We need your help!</h3>
9751: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9752: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9753: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9754: work</a> list! There is still a long way to go to get a
9755: fully-functional GNOME desktop under NetBSD and we need your help to
9756: achieve it!</p>
9757: </div>
1.41 asau 9758: <div class="sect1">
1.1 dsieger 9759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9760: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9761: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9763: <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 9764: the core GNOME desktop environment. It only includes the necessary
9765: bits to get it to boot correctly, although it may lack important
9766: functionality for daily operation. The idea behind this package is
9767: to let end users build their own configurations on top of this one,
9768: first installing this meta package to achieve a functional setup and
9769: then adding individual applications.</p></li>
1.23 wiz 9770: <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 9771: complete installation of the GNOME platform and desktop as defined
9772: by the GNOME project; this is based on the components distributed in
9773: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9774: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9775: official FTP server. Developer-only tools found in those
9776: directories are not installed unless required by some other
9777: component to work properly. Similarly, packages from the bindings
9778: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9779: in unless required as a dependency for an end-user component. This
9780: package "extends" <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
1.23 wiz 9781: <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 9782: Installs all the tools required to build a GNOME component when
9783: fetched from the CVS repository. These are required to let the
1.10 hubertf 9784: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9785: </ul></div>
9786: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9787: sorted in a way that eases updates: a package may depend on other
9788: packages listed before it but not on any listed after it. It is very
9789: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9790: change it to alphabetical sorting!</em></span></p>
9791: </div>
1.41 asau 9792: <div class="sect1">
1.1 dsieger 9793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9794: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9795: <p>Almost all GNOME applications are written in C and use a common
9796: set of tools as their build system. Things get different with the new
9797: bindings to other languages (such as Python), but the following will
9798: give you a general idea on the minimum required tools:</p>
1.41 asau 9799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9800: <li class="listitem">
1.1 dsieger 9801: <p>Almost all GNOME applications use the GNU Autotools as their
9802: build system. As a general rule you will need to tell this to your
9803: package:</p>
9804: <pre class="programlisting">
9805: GNU_CONFIGURE=yes
9806: USE_LIBTOOL=yes
9807: USE_TOOLS+=gmake
9808: </pre>
9809: </li>
1.23 wiz 9810: <li class="listitem">
1.1 dsieger 9811: <p>If the package uses pkg-config to detect dependencies, add this
9812: tool to the list of required utilities:</p>
9813: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9814: <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
9815: the end of the build process to ensure that you did not miss to
9816: specify any dependency in your package and that the version
9817: requirements are all correct.</p>
9818: </li>
1.23 wiz 9819: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9820: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9821: to handle dependencies and to force the package to use the latest
9822: available version.</p></li>
1.23 wiz 9823: <li class="listitem">
1.1 dsieger 9824: <p>If the package uses gtk-doc (a documentation generation
9825: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9826: tool is rather big and the distfile should come with pregenerated
9827: documentation anyway; if it does not, it is a bug that you ought to
9828: report. For such packages you should disable gtk-doc (unless it is
9829: the default):</p>
9830: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9831: <p>The default location of installed HTML files
9832: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9833: and should not be changed unless the package insists on installing
9834: them somewhere else. Otherwise programs as
1.10 hubertf 9835: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9836: do that with an entry similar to:</p>
9837: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9838: </li>
9839: </ul></div>
9840: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9841: files under the installation prefix to maintain databases. In this
9842: context, shared means that those exact same directories and files are
9843: used among several different packages, leading to conflicts in the
9844: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9845: handle the most common cases, so you have to forget about using
9846: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9847: omitting shared files from them. If you find yourself doing those,
9848: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9849: <p>The following table lists the common situations that result in
9850: using shared directories or files. For each of them, the appropriate
9851: solution is given. After applying the solution be sure to
9852: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9853: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9854: <div class="table">
1.6 rillig 9855: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 9856: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
9857: <colgroup>
9858: <col>
9859: <col>
9860: </colgroup>
9861: <thead><tr>
9862: <th>If the package...</th>
9863: <th>Then...</th>
9864: </tr></thead>
9865: <tbody>
9866: <tr>
9867: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9868: <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 9869: </tr>
9870: <tr>
9871: <td>Installs icons under the
9872: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9873: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9874: <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 9875: </tr>
9876: <tr>
9877: <td>Installs files under
9878: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9879: <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 9880: </tr>
9881: <tr>
9882: <td>Installs <code class="filename">.desktop</code> files under
9883: <code class="filename">share/applications</code> and these include MIME
9884: information.</td>
1.10 hubertf 9885: <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 9886: </tr>
9887: </tbody>
9888: </table></div>
9889: </div>
9890: <br class="table-break">
9891: </div>
1.41 asau 9892: <div class="sect1">
1.1 dsieger 9893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9894: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9895: <p>When seeing GNOME as a whole, there are two kinds of
9896: updates:</p>
1.41 asau 9897: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9898: <dt><span class="term">Major update</span></dt>
9899: <dd>
9900: <p>Given that there is still a very long way for GNOME 3 (if it
9901: ever appears), we consider a major update one that goes from a
9902: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9903: where <code class="literal">Y</code> is even and greater than
9904: <code class="literal">X</code>. These are hard to achieve because they
9905: introduce lots of changes in the components' code and almost all
9906: GNOME distfiles are updated to newer versions. Some of them can
9907: even break API and ABI compatibility with the previous major
9908: version series. As a result, the update needs to be done all at
9909: once to minimize breakage.</p>
9910: <p>A major update typically consists of around 80 package
9911: updates and the addition of some new ones.</p>
9912: </dd>
9913: <dt><span class="term">Minor update</span></dt>
9914: <dd>
9915: <p>We consider a minor update one that goes from a
9916: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9917: one where <code class="literal">Y</code> is greater than
9918: <code class="literal">X</code>. These are easy to achieve because they do
9919: not update all GNOME components, can be done in an incremental way
9920: and do not break API nor ABI compatibility.</p>
9921: <p>A minor update typically consists of around 50 package
9922: updates, although the numbers here may vary a lot.</p>
9923: </dd>
9924: </dl></div>
9925: <p>In order to update the GNOME components in pkgsrc to a new stable
9926: release (either major or minor), the following steps should be
9927: followed:</p>
1.23 wiz 9928: <div class="orderedlist"><ol class="orderedlist" type="1">
9929: <li class="listitem">
1.1 dsieger 9930: <p>Get a list of all the tarballs that form the new release by
9931: using the following commands. These will leave the full list of the
1.18 snj 9932: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9933: file:</p>
9934: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9935: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9936: awk '{ print $9 }' >list.txt</code></strong>
9937: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9938: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9939: awk '{ print $9 }' >>list.txt</code></strong></pre>
9940: </li>
1.23 wiz 9941: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9942: bump their version to the release you are updating them to. The
9943: three meta packages should be always consistent with versioning.
9944: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9945: in them.</p></li>
1.23 wiz 9946: <li class="listitem">
1.1 dsieger 9947: <p>For each meta package, update all its
9948: <code class="varname">DEPENDS</code> lines to match the latest versions as
9949: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9950: newer version (even if found in the FTP) because the meta packages
9951: are supposed to list the exact versions that form a specific GNOME
9952: release. Exceptions are permitted here if a newer version solves a
9953: serious issue in the overall desktop experience; these typically
9954: come in the form of a revision bump in pkgsrc, not in newer versions
9955: from the developers.</p>
9956: <p>Packages not listed in the <code class="filename">list.txt</code> file
9957: should be updated to the latest version available (if found in
9958: pkgsrc). This is the case, for example, of the dependencies on the
9959: 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>
9960: </li>
1.23 wiz 9961: <li class="listitem">
1.1 dsieger 9962: <p>Generate a patch from the modified meta packages and extract the
9963: list of "new" lines. This will provide you an outline on what
9964: packages need to be updated in pkgsrc and in what order:</p>
9965: <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>
9966: </li>
1.23 wiz 9967: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9968: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9969: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9970: of <code class="filename">todo.txt</code> and update the packages listed in
9971: it in order. For major desktop updates none of these should be
9972: committed until the entire set is completed because there are chances
9973: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9974: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9975: the tree one by one with appropriate log messages. At the end,
9976: commit the three meta package updates and all the corresponding
9977: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9978: <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>
9979: </ol></div>
9980: </div>
1.41 asau 9981: <div class="sect1">
1.1 dsieger 9982: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9983: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9984: <p>GNOME is a very big component in pkgsrc which approaches 100
9985: packages. Please, it is very important that you always, always,
9986: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9987: 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 9988: their attention on portability issues and to ensure that future versions
9989: can be built out-of-the box on NetBSD. The less custom patches in
9990: pkgsrc, the easier further updates are. Those developers in charge of
9991: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9992: <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 9993: Bugzilla</a>. Not all components use these to track bugs, but most
9994: of them do. Do not be short on your reports: always provide detailed
9995: explanations of the current failure, how it can be improved to achieve
9996: maximum portability and, if at all possible, provide a patch against CVS
9997: head. The more verbose you are, the higher chances of your patch being
9998: accepted.</p>
9999: <p>Also, please avoid using preprocessor magic to fix portability
10000: issues. While the FreeBSD GNOME people are doing a great job in porting
10001: GNOME to their operating system, the official GNOME sources are now
10002: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10003: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 10004: 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 10005: details.</p>
10006: </div>
10007: </div>
10008: </div>
1.41 asau 10009: <div class="part">
1.1 dsieger 10010: <div class="titlepage"><div><div><h1 class="title">
10011: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10012: <div class="partintro">
1.1 dsieger 10013: <div></div>
10014: <p>This part of the guide deals with everything
10015: from the infrastructure that is behind the interfaces described
10016: in the developer's guide. A casual package maintainer should not
10017: need anything from this part.</p>
10018: <div class="toc">
10019: <p><b>Table of Contents</b></p>
10020: <dl>
1.6 rillig 10021: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10022: <dd><dl>
1.6 rillig 10023: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10024: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10025: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10026: <dd><dl>
1.6 rillig 10027: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10028: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10029: </dl></dd>
1.6 rillig 10030: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10031: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10032: <dd><dl>
1.6 rillig 10033: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10034: <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 10035: </dl></dd>
1.6 rillig 10036: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10037: <dd><dl>
1.23 wiz 10038: <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>
10039: <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 10040: </dl></dd>
10041: </dl></dd>
1.6 rillig 10042: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10043: <dd><dl>
1.6 rillig 10044: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10045: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10046: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10047: <dd><dl>
1.6 rillig 10048: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10049: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10050: </dl></dd>
10051: </dl></dd>
1.6 rillig 10052: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10053: <dd><dl>
1.6 rillig 10054: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10055: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10056: </dl></dd>
10057: </dl>
10058: </div>
10059: </div>
1.41 asau 10060: <div class="chapter">
1.1 dsieger 10061: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10062: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10063: <div class="toc">
10064: <p><b>Table of Contents</b></p>
10065: <dl>
1.6 rillig 10066: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10067: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10068: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10069: <dd><dl>
1.6 rillig 10070: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10071: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10072: </dl></dd>
1.6 rillig 10073: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10074: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10075: <dd><dl>
1.6 rillig 10076: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10077: <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 10078: </dl></dd>
1.6 rillig 10079: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10080: <dd><dl>
1.23 wiz 10081: <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>
10082: <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 10083: </dl></dd>
10084: </dl>
10085: </div>
10086: <p>The pkgsrc infrastructure consists of many small Makefile
10087: fragments. Each such fragment needs a properly specified
10088: interface. This chapter explains how such an interface looks
10089: like.</p>
1.41 asau 10090: <div class="sect1">
1.1 dsieger 10091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10092: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10093: <p>Whenever a variable is defined in the pkgsrc
10094: infrastructure, the location and the way of definition provide
10095: much information about the intended use of that variable.
10096: Additionally, more documentation may be found in a header
10097: comment or in this pkgsrc guide.</p>
10098: <p>A special file is
10099: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10100: variables that are intended to be user-defined. They are either
10101: defined using the <code class="literal">?=</code> operator or they are
10102: left undefined because defining them to anything would
1.23 wiz 10103: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10104: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10105: file.</p>
10106: <p>Outside this file, the following conventions apply:
10107: Variables that are defined using the <code class="literal">?=</code>
10108: operator may be overridden by a package.</p>
10109: <p>Variables that are defined using the <code class="literal">=</code>
10110: operator may be used read-only at run-time.</p>
10111: <p>Variables whose name starts with an underscore must not be
10112: accessed outside the pkgsrc infrastructure at all. They may
10113: change without further notice.</p>
1.41 asau 10114: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10115: <h3 class="title">Note</h3>
10116: <p>These conventions are currently not applied
10117: consistently to the complete pkgsrc
10118: infrastructure.</p>
10119: </div>
10120: </div>
1.41 asau 10121: <div class="sect1">
1.1 dsieger 10122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10123: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10124: <p>All variables that contain lists of things should default
10125: to being empty. Two examples that do not follow this rule are
10126: <code class="varname">USE_LANGUAGES</code> and
10127: <code class="varname">DISTFILES</code>. These variables cannot simply be
10128: modified using the <code class="literal">+=</code> operator in package
10129: <code class="filename">Makefile</code>s (or other files included by
10130: them), since there is no guarantee whether the variable is
10131: already set or not, and what its value is. In the case of
1.23 wiz 10132: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10133: the default value and just define it as in the following
10134: example.</p>
10135: <pre class="programlisting">
10136: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10137: </pre>
10138: <p>Because of the selection of this default value, the same
10139: value appears in many package Makefiles. Similarly for
10140: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10141: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10142: doesn't stand out. Nevertheless it is mentioned in many
10143: files.</p>
10144: </div>
1.41 asau 10145: <div class="sect1">
1.1 dsieger 10146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10147: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 10148: <div class="sect2">
1.1 dsieger 10149: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10150: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10151: <p>Variable evaluation takes place either at load time or at
10152: runtime, depending on the context in which they occur. The
10153: contexts where variables are evaluated at load time are:</p>
1.41 asau 10154: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10155: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10156: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10157: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10158: <code class="literal">.for</code>,</p></li>
1.23 wiz 10159: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10160: </ul></div>
10161: <p>A special exception are references to the iteration
10162: variables of <code class="literal">.for</code> loops, which are expanded
10163: inline, no matter in which context they appear.</p>
10164: <p>As the values of variables may change during load time,
10165: care must be taken not to evaluate them by accident. Typical
10166: examples for variables that should not be evaluated at load time
10167: are <code class="varname">DEPENDS</code> and
10168: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10169: clear, here is an example:</p>
10170: <pre class="programlisting">
10171: CONFIGURE_ARGS= # none
10172: CFLAGS= -O
10173: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10174:
10175: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10176:
10177: CFLAGS+= -Wall
10178: </pre>
10179: <p>This code shows how the use of the <code class="literal">:=</code>
10180: operator can quickly lead to unexpected results. The first
10181: paragraph is fairly common code. The second paragraph evaluates
10182: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10183: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10184: <code class="literal">-Wall</code> is appended to the
10185: <code class="varname">CFLAGS</code>, but this addition will not appear in
10186: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10187: paragraphs from above typically occur in completely unrelated
10188: files.</p>
10189: </div>
1.41 asau 10190: <div class="sect2">
1.1 dsieger 10191: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10192: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10193: <p>After all the files have been loaded, the values of the
10194: variables cannot be changed anymore. Variables that are used in
10195: the shell commands are expanded at this point.</p>
10196: </div>
10197: </div>
1.41 asau 10198: <div class="sect1">
1.1 dsieger 10199: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10200: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10201: <p>There are many ways in which the definition and use of a
10202: variable can be restricted in order to detect bugs and
10203: violations of the (mostly unwritten) policies. See the
10204: <code class="literal">pkglint</code> developer's documentation for further
10205: details.</p>
10206: </div>
1.41 asau 10207: <div class="sect1">
1.1 dsieger 10208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10209: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10210: <p>Most of the <code class="filename">.mk</code> files fall into one
10211: of the following classes. Cases where a file falls into more
10212: than one class should be avoided as it often leads to subtle
10213: bugs.</p>
1.41 asau 10214: <div class="sect2">
1.1 dsieger 10215: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10216: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10217: <p>In a traditional imperative programming language some of
10218: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10219: procedures. They take some input parameters and—after
10220: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10221: variables in <code class="filename">Makefile</code>s have global scope
10222: care must be taken not to use parameter names that have already
10223: another meaning. For example, <code class="varname">PKGNAME</code> is a
10224: bad choice for a parameter name.</p>
10225: <p>Procedures are completely evaluated at preprocessing time.
10226: That is, when calling a procedure all input parameters must be
10227: completely resolvable. For example,
10228: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10229: parameter since it is very likely that further text will be
10230: added after calling the procedure, which would effectively apply
10231: the procedure to only a part of the variable. Also, references
10232: to other variables wit will be modified after calling the
10233: procedure.</p>
10234: <p>A procedure can declare its output parameters either as
10235: suitable for use in preprocessing directives or as only
10236: available at runtime. The latter alternative is for variables
10237: that contain references to other runtime variables.</p>
10238: <p>Procedures shall be written such that it is possible to
10239: call the procedure more than once. That is, the file must not
10240: contain multiple-inclusion guards.</p>
10241: <p>Examples for procedures are
10242: <code class="filename">mk/bsd.options.mk</code> and
10243: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10244: that the parameters are evaluated at load time, they should be
10245: assigned using the <code class="literal">:=</code> operator, which should
10246: be used only for this purpose.</p>
10247: </div>
1.41 asau 10248: <div class="sect2">
1.1 dsieger 10249: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10250: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10251: <p>Action files take some input parameters and may define
10252: runtime variables. They shall not define loadtime variables.
10253: There are action files that are included implicitly by the
10254: pkgsrc infrastructure, while other must be included
10255: explicitly.</p>
10256: <p>An example for action files is
10257: <code class="filename">mk/subst.mk</code>.</p>
10258: </div>
10259: </div>
1.41 asau 10260: <div class="sect1">
1.1 dsieger 10261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10262: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10263: <p>Package <code class="filename">Makefile</code>s usually consist of
10264: a set of variable definitions, and include the file
10265: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10266: Before that, they may also include various other
10267: <code class="filename">*.mk</code> files if they need to query the
10268: availability of certain features like the type of compiler or
10269: the X11 implementation. Due to the heavy use of preprocessor
10270: directives like <code class="literal">.if</code> and
10271: <code class="literal">.for</code>, the order in which the files are loaded
10272: matters.</p>
10273: <p>This section describes at which point the various files
10274: are loaded and gives reasons for that order.</p>
1.41 asau 10275: <div class="sect2">
1.1 dsieger 10276: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10277: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10278: </h3></div></div></div>
10279: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10280: is to define some essential variables like
10281: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10282: <code class="varname">MACHINE_ARCH</code>.</p>
10283: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10284: 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 10285: After that, those variables
1.1 dsieger 10286: that have not been overridden by the user are loaded from
10287: <code class="filename">mk/defaults/mk.conf</code>.</p>
10288: <p>After the user settings, the system settings and platform
10289: settings are loaded, which may override the user
10290: settings.</p>
10291: <p>Then, the tool definitions are loaded. The tool wrappers
10292: are not yet in effect. This only happens when building a
10293: package, so the proper variables must be used instead of the
10294: direct tool names.</p>
10295: <p>As the last steps, some essential variables from the
10296: wrapper and the package system flavor are loaded, as well as the
10297: variables that have been cached in earlier phases of a package
10298: build.</p>
10299: </div>
1.41 asau 10300: <div class="sect2">
1.1 dsieger 10301: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10302: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10303: </h3></div></div></div>
10304: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10305: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10306: loaded, which fill default values for those variables that have
10307: not been defined by the package. These variables may later
10308: be used even in unrelated files.</p>
10309: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10310: provides the target <code class="literal">error-check</code> that is added
10311: as a special dependency to all other targets that use
10312: <code class="varname">DELAYED_ERROR_MSG</code> or
10313: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10314: <p>Then, the package-specific hacks from
10315: <code class="filename">hacks.mk</code> are included.</p>
10316: <p>Then, various other files follow. Most of them don't have
10317: any dependencies on what they need to have included before or
10318: after them, though some do.</p>
10319: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10320: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10321: restricts the use of these variables to all the files that have
10322: been included before. Appearances in later files will be
10323: silently ignored.</p>
10324: <p>Then, the files for the main targets are included, in the
10325: order of later execution, though the actual order should not
10326: matter.</p>
10327: <p>At last, some more files are included that don't set any
10328: interesting variables but rather just define make targets to be
10329: executed.</p>
10330: </div>
10331: </div>
10332: </div>
1.41 asau 10333: <div class="chapter">
1.1 dsieger 10334: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10335: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10336: <div class="toc">
10337: <p><b>Table of Contents</b></p>
10338: <dl>
1.6 rillig 10339: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10340: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10341: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10342: <dd><dl>
1.6 rillig 10343: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10344: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10345: </dl></dd>
10346: </dl>
10347: </div>
10348: <p>The pkgsrc infrastructure consists of a large codebase,
10349: and there are many corners where every little bit of a file is
10350: well thought out, making pkgsrc likely to fail as soon as
10351: anything is changed near those parts. To prevent most changes
10352: from breaking anything, a suite of regression tests should go
10353: along with every important part of the pkgsrc infrastructure.
10354: This chapter describes how regression tests work in pkgsrc and
10355: how you can add new tests.</p>
1.41 asau 10356: <div class="sect1">
1.1 dsieger 10357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10358: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10359: <p></p>
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="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1 dsieger 10364: <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 10365: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10366: can simply run that command, which will run all tests in the
10367: <code class="filename">regress</code> category.</p>
10368: </div>
1.41 asau 10369: <div class="sect1">
1.1 dsieger 10370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10371: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10372: <p>Every directory in the <code class="filename">regress</code>
10373: category that contains a file called <code class="filename">spec</code>
10374: is considered a regression test. This file is a shell program
1.10 hubertf 10375: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10376: The following functions can be overridden to suit your
10377: needs.</p>
1.41 asau 10378: <div class="sect2">
1.1 dsieger 10379: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10380: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10381: <p>These functions do not take any parameters. They are all
1.23 wiz 10382: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.1 dsieger 10383: to check the exitcodes of any commands you run in the
10384: test.</p>
1.41 asau 10385: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10386: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10387: <dd><p>This function prepares the environment for the
10388: test. By default it does nothing.</p></dd>
10389: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10390: <dd><p>This function runs the actual test. By default,
10391: it calls <code class="varname">TEST_MAKE</code> with the arguments
10392: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10393: error messages into the file
10394: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10395: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10396: <dd><p>This function is run after the test and is
10397: typically used to compare the actual output from the one that is
10398: expected. It can make use of the various helper functions from
10399: the next section.</p></dd>
10400: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10401: <dd><p>This function cleans everything up after the
10402: test has been run. By default it does nothing.</p></dd>
10403: </dl></div>
10404: </div>
1.41 asau 10405: <div class="sect2">
1.1 dsieger 10406: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10407: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.41 asau 10408: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10409: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10410: <dd><p>This function compares the exitcode of the
1.10 hubertf 10411: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1 dsieger 10412: If they differ, the test will fail.</p></dd>
10413: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10414: <dd><p>This function checks for each of its parameters
1.10 hubertf 10415: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1 dsieger 10416: extended regular expression. If it does not, the test will
10417: fail.</p></dd>
10418: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10419: <dd><p>This function checks for each of its parameters
1.10 hubertf 10420: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10421: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10422: If any of the regular expressions matches, the test will
10423: fail.</p></dd>
10424: </dl></div>
10425: </div>
10426: </div>
10427: </div>
1.41 asau 10428: <div class="chapter">
1.1 dsieger 10429: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10430: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10431: <div class="toc">
10432: <p><b>Table of Contents</b></p>
10433: <dl>
1.6 rillig 10434: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10435: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10436: </dl>
10437: </div>
10438: <p>The pkgsrc system has already been ported to many
10439: operating systems, hardware architectures and compilers. This
10440: chapter explains the necessary steps to make pkgsrc even more
10441: portable.</p>
1.41 asau 10442: <div class="sect1">
1.1 dsieger 10443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10444: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10445: <p>To port pkgsrc to a new operating system (called
10446: <code class="literal">MyOS</code> in this example), you need to touch the
10447: following files:</p>
1.41 asau 10448: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10449: <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>
10450: <dd><p>This file contains some basic definitions, for
10451: example the name of the C
10452: compiler.</p></dd>
10453: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10454: <dd><p>Insert code that defines the variables
10455: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10456: <code class="varname">LOWER_OS_VERSION</code>,
10457: <code class="varname">LOWER_VENDOR</code>,
10458: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10459: <code class="varname">APPEND_ELF</code>, and the other variables that
10460: appear in this file.</p></dd>
10461: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10462: <dd><p>This file contains the platform-specific
10463: definitions that are used by pkgsrc. Start by copying one of the
10464: other files and edit it to your
10465: needs.</p></dd>
10466: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10467: <dd><p>This file defines the paths to all the tools
10468: that are needed by one or the other package in pkgsrc, as well
10469: as by pkgsrc itself. Find out where these tools are on your
10470: platform and add them.</p></dd>
10471: </dl></div>
10472: <p>Now, you should be able to build some basic packages, like
10473: <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>
10474: </div>
1.41 asau 10475: <div class="sect1">
1.1 dsieger 10476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10477: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10478: <p>TODO</p>
10479: </div>
10480: </div>
10481: </div>
1.41 asau 10482: <div class="appendix">
10483: <div class="titlepage"><div><div><h1 class="title">
10484: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10485: <div class="toc">
10486: <p><b>Table of Contents</b></p>
10487: <dl>
10488: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10489: <dd><dl>
10490: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10491: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10492: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10493: <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 10494: </dl></dd>
10495: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10496: </dl>
10497: </div>
10498: <p>We checked to find a piece of software that wasn't in the packages
10499: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10500: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10501: present in the tree is beyond us, but it's useful for the purposes of
10502: this exercise.</p>
1.41 asau 10503: <div class="sect1">
1.1 dsieger 10504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10505: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10506: <div class="sect2">
1.1 dsieger 10507: <div class="titlepage"><div><div><h3 class="title">
10508: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10509: <pre class="programlisting">
10510: # $NetBSD$
10511: #
10512:
10513: DISTNAME= bison-1.25
10514: CATEGORIES= devel
10515: MASTER_SITES= ${MASTER_SITE_GNU}
10516:
1.29 dholland 10517: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10518: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10519: COMMENT= GNU yacc clone
10520:
10521: GNU_CONFIGURE= yes
1.46 wiz 10522: INFO_FILES= yes
1.1 dsieger 10523:
10524: .include "../../mk/bsd.pkg.mk"
10525: </pre>
10526: </div>
1.41 asau 10527: <div class="sect2">
1.1 dsieger 10528: <div class="titlepage"><div><div><h3 class="title">
10529: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10530: <pre class="programlisting">
10531: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.29 dholland 10532: 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 10533: of the NetBSD source tree is beyond me.
10534: </pre>
10535: </div>
1.41 asau 10536: <div class="sect2">
1.1 dsieger 10537: <div class="titlepage"><div><div><h3 class="title">
10538: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10539: <pre class="programlisting">
10540: @comment $NetBSD$
10541: bin/bison
10542: man/man1/bison.1.gz
10543: share/bison.simple
10544: share/bison.hairy
10545: </pre>
10546: </div>
1.41 asau 10547: <div class="sect2">
1.1 dsieger 10548: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10549: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10550: </h3></div></div></div>
10551: <p>The NetBSD package system comes with
10552: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10553: which helps to check the contents of these
10554: files. After installation it is quite easy to use, just change to the
10555: directory of the package you wish to examine and execute
1.10 hubertf 10556: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10557: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10558: looks fine.</pre>
10559: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10560: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10561: -Wall</strong></span> for a very thorough check.</p>
10562: </div>
10563: </div>
1.41 asau 10564: <div class="sect1">
1.1 dsieger 10565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10566: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10567: <p>Create the directory where the package lives,
10568: plus any auxiliary directories:</p>
10569: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10570: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10571: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10572: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10573: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 10574: <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 10575: then continue with fetching the distfile:</p>
10576: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10577: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10578: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10579: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10580: ftp: Error retrieving file: 500 Internal error
10581:
10582: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10583: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10584: ftp: Error retrieving file: 500 Internal error
10585:
10586: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10587: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10588: Successfully retrieved file.</pre>
10589: <p>Generate the checksum of the distfile into
10590: <code class="filename">distinfo</code>:</p>
10591: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10592: <p>Now compile:</p>
10593: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10594: >> Checksum OK for bison-1.25.tar.gz.
10595: ===> Extracting for bison-1.25
10596: ===> Patching for bison-1.25
10597: ===> Ignoring empty patch directory
10598: ===> Configuring for bison-1.25
10599: creating cache ./config.cache
10600: checking for gcc... cc
10601: checking whether we are using GNU C... yes
10602: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10603: checking how to run the C preprocessor... cc -E
10604: checking for minix/config.h... no
10605: checking for POSIXized ISC... no
10606: checking whether cross-compiling... no
10607: checking for ANSI C header files... yes
10608: checking for string.h... yes
10609: checking for stdlib.h... yes
10610: checking for memory.h... yes
10611: checking for working const... yes
10612: checking for working alloca.h... no
10613: checking for alloca... yes
10614: checking for strerror... yes
10615: updating cache ./config.cache
10616: creating ./config.status
10617: creating Makefile
10618: ===> Building for bison-1.25
10619: 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
10620: 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
10621: 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
10622: 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
10623: 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
10624: 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
10625: 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
10626: 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
10627: 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
10628: 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
10629: 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
10630: 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
10631: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
10632: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
10633: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
10634: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reduce.c
10635: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
10636: 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
10637: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
10638: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
10639: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt1.c
10640: 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
10641: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10642: rm -f bison.s1
10643: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10644: <p>Everything seems OK, so install the files:</p>
10645: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10646: >> Checksum OK for bison-1.25.tar.gz.
10647: ===> Installing for bison-1.25
10648: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10649: rm -f /usr/pkg/bin/bison
10650: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10651: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10652: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10653: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10654: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10655: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10656: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10657: ===> Registering installation for bison-1.25</pre>
10658: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10659: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10660: binary package, do this now:</p>
10661: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10662: >> Checksum OK for bison-1.25.tar.gz.
10663: ===> Building package for bison-1.25
10664: Creating package bison-1.25.tgz
10665: Registering depends:.
10666: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10667: <p>Now that you don't need the source and object files
10668: any more, clean up:</p>
10669: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10670: ===> Cleaning for bison-1.25</pre>
10671: </div>
10672: </div>
1.41 asau 10673: <div class="appendix">
10674: <div class="titlepage"><div><div><h1 class="title">
10675: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10676: <div class="toc">
10677: <p><b>Table of Contents</b></p>
10678: <dl>
10679: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10680: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10681: </dl>
10682: </div>
1.41 asau 10683: <div class="sect1">
1.1 dsieger 10684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10685: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10686: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10687: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10688: => figlet221.tar.gz doesn't seem to exist on this system.
10689: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10690: => [172219 bytes]
10691: Connected to ftp.plig.net.
10692: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10693: 331 Guest login ok, send your complete e-mail address as password.
10694: 230-You are user #5 of 500 simultaneous users allowed.
10695: 230-
10696: 230- ___ _ _ _
10697: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10698: 230- | _| _| . |_| . | | | . |_| . | _| . |
10699: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10700: 230- |_| |_| |___| |___|
10701: 230-
10702: 230-** Welcome to ftp.plig.org **
10703: 230-
10704: 230-Please note that all transfers from this FTP site are logged. If you
10705: 230-do not like this, please disconnect now.
10706: 230-
1.18 snj 10707: 230-This archive is available via
1.1 dsieger 10708: 230-
10709: 230-HTTP: http://ftp.plig.org/
10710: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10711: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10712: 230-
10713: 230-Please email comments, bug reports and requests for packages to be
10714: 230-mirrored to ftp-admin@plig.org.
10715: 230-
10716: 230-
10717: 230 Logged in anonymously.
10718: Remote system type is UNIX.
10719: Using binary mode to transfer files.
10720: 200 Type okay.
10721: 250 "/pub" is new cwd.
10722: 250-"/pub/figlet" is new cwd.
10723: 250-
10724: 250-Welcome to the figlet archive at ftp.figlet.org
10725: 250-
10726: 250- ftp://ftp.figlet.org/pub/figlet/
10727: 250-
10728: 250-The official FIGlet web page is:
10729: 250- http://www.figlet.org/
10730: 250-
10731: 250-If you have questions, please mailto:info@figlet.org. If you want to
10732: 250-contribute a font or something else, you can email us.
10733: 250
10734: 250 "/pub/figlet/program" is new cwd.
10735: 250 "/pub/figlet/program/unix" is new cwd.
10736: local: figlet221.tar.gz remote: figlet221.tar.gz
10737: 502 Unimplemented command.
10738: 227 Entering Passive Mode (195,40,6,41,246,104)
10739: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10740: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10741: 226 Transfer completed.
10742: 172219 bytes received in 00:02 (75.99 KB/s)
10743: 221 Goodbye.
10744: => Checksum OK for figlet221.tar.gz.
10745: ===> Extracting for figlet-2.2.1nb2
10746: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10747: ===> Patching for figlet-2.2.1nb2
10748: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10749: ===> Overriding tools for figlet-2.2.1nb2
10750: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10751: ===> Configuring for figlet-2.2.1nb2
10752: ===> Building for figlet-2.2.1nb2
10753: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10754: chmod a+x figlet
10755: gcc -O2 -o chkfont chkfont.c
10756: => Unwrapping files-to-be-installed.
10757: <code class="prompt">#</code>
10758: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10759: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10760: ===> Installing for figlet-2.2.1nb2
10761: install -d -o root -g wheel -m 755 /usr/pkg/bin
10762: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10763: mkdir -p /usr/pkg/share/figlet
10764: cp figlet /usr/pkg/bin
10765: cp chkfont /usr/pkg/bin
10766: chmod 555 figlist showfigfonts
10767: cp figlist /usr/pkg/bin
10768: cp showfigfonts /usr/pkg/bin
10769: cp fonts/*.flf /usr/pkg/share/figlet
10770: cp fonts/*.flc /usr/pkg/share/figlet
10771: cp figlet.6 /usr/pkg/man/man6
10772: ===> Registering installation for figlet-2.2.1nb2
10773: <code class="prompt">#</code></pre>
10774: </div>
1.41 asau 10775: <div class="sect1">
1.1 dsieger 10776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10777: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10778: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10779: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10780: ===> Packaging figlet-2.2.1nb2
10781: ===> Building binary package for figlet-2.2.1nb2
10782: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10783: Using SrcDir value of /usr/pkg
10784: Registering depends:.
10785: <code class="prompt">#</code></pre>
10786: </div>
10787: </div>
1.41 asau 10788: <div class="appendix">
10789: <div class="titlepage"><div><div><h1 class="title">
10790: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10791: <div class="toc">
10792: <p><b>Table of Contents</b></p>
10793: <dl>
1.23 wiz 10794: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10795: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10796: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10797: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10798: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10799: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10800: source packages</a></span></dt>
10801: </dl>
10802: </div>
10803: <p>As in other big projects, the directory layout of pkgsrc
10804: is quite complex for newbies. This chapter explains where you
10805: find things on the FTP server. The base directory on
1.10 hubertf 10806: <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 10807: On other servers it may be different, but inside this directory,
10808: everything should look the same, no matter on which server you
10809: are. This directory contains some subdirectories, which are
10810: explained below.</p>
1.41 asau 10811: <div class="sect1">
1.1 dsieger 10812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10813: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10814: <p>The directory <code class="filename">distfiles</code> contains lots
10815: of archive files from all pkgsrc packages, which are mirrored
10816: here. The subdirectories are called after their package names
10817: and are used when the distributed files have names that don't
10818: explicitly contain a version number or are otherwise too generic
10819: (for example <code class="filename">release.tar.gz</code>).</p>
10820: </div>
1.41 asau 10821: <div class="sect1">
1.1 dsieger 10822: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10823: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10824: <p>This directory contains things that individual pkgsrc
10825: developers find worth publishing.</p>
10826: </div>
1.41 asau 10827: <div class="sect1">
1.1 dsieger 10828: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10829: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10830: <p>This directory contains binary packages for the various
10831: platforms that are supported by pkgsrc.
10832: 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 10833: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10834: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10835: operating system for which the packages have been built. The
1.10 hubertf 10836: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10837: command, so it may differ from the one you are used to
10838: hear.</p></li>
1.23 wiz 10839: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10840: architecture of the platform for which the packages have been
1.10 hubertf 10841: built. It also includes the <code class="varname">ABI</code> (Application
10842: Binary Interface) for platforms that have several of
10843: them.</p></li>
1.23 wiz 10844: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10845: the operating system. For version numbers that change often (for
10846: example NetBSD-current), the often-changing part should be
10847: replaced with an <code class="literal">x</code>, for example
10848: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10849: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10850: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10851: for a stable branch, or <code class="literal">head</code> for packages
10852: built from the HEAD branch. The latter should only be used when
10853: the packages are updated on a regular basis. Otherwise the date
10854: from checking out pkgsrc should be appended, for example
10855: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10856: </ul></div>
10857: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10858: can quickly click through the directories on the
10859: server and find the best binary packages for their machines. Since they
10860: usually know the operating system and the hardware architecture, OPSYS
10861: and ARCH are placed first. After these choices, they can select the
10862: best combination of OSVERSION and TAG together, since it is usually the
10863: case that packages stay compatible between different version of the
10864: operating system.</p>
10865: <p>In each of these directories, there is a
10866: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10867: <code class="filename">All</code> which contains all binary packages.
10868: Besides that, there are various category directories that
10869: contain symbolic links to the real binary packages.</p>
10870: </div>
1.41 asau 10871: <div class="sect1">
1.1 dsieger 10872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10873: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10874: <p>Here are the reports from bulk builds, for those who want
10875: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10876: 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 10877: </div>
1.41 asau 10878: <div class="sect1">
1.8 rillig 10879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10880: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10881: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10882: source packages</h2></div></div></div>
1.23 wiz 10883: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10884: that is the files that define how to create binary packages from
10885: source archives.</p>
10886: <p>The directory <code class="filename">pkgsrc</code> contains a
10887: snapshot of the CVS repository, which is updated regularly. The
10888: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10889: directory, ready to be downloaded as a whole.</p>
10890: <p>In the directories for the quarterly branches, there is an
10891: additional file called
1.22 jakllsch 10892: <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 10893: which contains the state of pkgsrc when it was branched.</p>
10894: </div>
10895: </div>
1.41 asau 10896: <div class="appendix">
10897: <div class="titlepage"><div><div><h1 class="title">
10898: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10899: <div class="toc">
10900: <p><b>Table of Contents</b></p>
10901: <dl>
10902: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10903: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10904: </dl>
10905: </div>
10906: <p>This section contains information on editing the pkgsrc
10907: guide itself.</p>
1.41 asau 10908: <div class="sect1">
1.1 dsieger 10909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10910: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10911: <p>The pkgsrc guide's source code is stored in
10912: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10913: are created from it:</p>
1.41 asau 10914: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10915: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10916: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10917: <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>
10918: <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 10919: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10920: <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 10921: PostScript version of the pkgsrc guide.</p></li>
10922: </ul></div>
10923: </div>
1.41 asau 10924: <div class="sect1">
1.1 dsieger 10925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10926: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10927: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10928: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10929: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10930: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10931: documentation) installed. These are automatically installed when
10932: 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 10933: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10934: right directory. All further steps will take place
10935: here.</p></li>
1.41 asau 10936: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10937: <code class="filename">files/</code>.</p></li>
1.41 asau 10938: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10939: guide for valid XML and to build the final output files. If you
10940: get any errors at this stage, you can just edit the files, as
10941: there are only symbolic links in the working directory, pointing
10942: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10943: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10944: commit)</strong></span></p></li>
1.41 asau 10945: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10946: regenerate the output files with the proper RCS
10947: Ids.</p></li>
1.41 asau 10948: <li class="step">
1.10 hubertf 10949: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10950: commit the files in both <code class="filename">pkgsrc/doc</code> and
10951: <code class="filename">htdocs</code>.</p>
1.41 asau 10952: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10953: <h3 class="title">Note</h3>
10954: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10955: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10956: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10957: directory.</p>
10958: </div>
10959: </li>
10960: </ol></div>
10961: </div>
10962: </div>
10963: </div></body>
10964: </html>
CVSweb <webmaster@jp.NetBSD.org>