Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.77
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.76 jnemeth 33: <div><p class="copyright">Copyright © 1994-2014 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.27 2014/09/19 04:53:09 jnemeth Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
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.71 wiz 136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
138: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
139: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 140: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 142: </dl></dd>
143: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
144: <dd><dl>
1.23 wiz 145: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
146: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
151: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
152: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
153: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
154: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
155: <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>
156: <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 157: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
158: <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>
159: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
160: <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 161: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.65 wiz 162: <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>
163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
164: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
165: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
168: <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 169: </dl></dd>
170: </dl></dd>
171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
172: <dd><dl>
1.6 rillig 173: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 174: <dd><dl>
1.6 rillig 175: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 176: <dd><dl>
1.6 rillig 177: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 178: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 179: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 180: </dl></dd>
1.6 rillig 181: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
182: <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>
183: </dl></dd>
184: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
185: <dd><dl>
1.23 wiz 186: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
187: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 188: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
189: <dd><dl>
190: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
193: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
194: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
195: </dl></dd>
196: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
197: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
198: <dd><dl>
199: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
201: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
202: </dl></dd>
1.23 wiz 203: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
204: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 205: </dl></dd>
1.23 wiz 206: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 207: <dd><dl>
208: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 209: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 210: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
211: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
212: <dd><dl>
213: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
214: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
215: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
216: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
217: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
218: </dl></dd>
219: </dl></dd>
220: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
221: <dd><dl>
222: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 223: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
224: <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 225: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
226: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 227: <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 228: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
229: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
230: </dl></dd>
231: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
232: <dd><dl>
233: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 234: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 235: <dd><dl>
236: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 237: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
238: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
239: and
240: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
241: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 242: </dl></dd>
1.23 wiz 243: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 244: <dd><dl>
1.23 wiz 245: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 246: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
247: </dl></dd>
248: </dl></dd>
249: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
250: <dd><dl>
251: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
254: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
255: </dl></dd>
256: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
257: <dd><dl>
1.23 wiz 258: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 259: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
260: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
261: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
262: </dl></dd>
263: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
264: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
265: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
266: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
267: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
268: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
269: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
270: </dl></dd>
271: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
272: <dd><dl>
273: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 274: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 275: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 276: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 277: </dl></dd>
278: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
281: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
282: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
283: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 284: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 285: <dd><dl>
286: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
287: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
288: </dl></dd>
1.23 wiz 289: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 299: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
300: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
301: </dl></dd>
302: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
303: <dd><dl>
304: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
305: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
306: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
307: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6 rillig 315: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
1.23 wiz 326: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
330: </dl></dd>
1.23 wiz 331: <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 332: <dd><dl>
333: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
336: </dl></dd>
337: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
338: <dd><dl>
339: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
340: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
341: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 342: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
343: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 344: </dl></dd>
1.23 wiz 345: <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 346: <dd><dl>
347: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
348: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 349: <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 350: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
351: </dl></dd>
1.23 wiz 352: <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 353: <dd><dl>
354: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
355: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
356: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
357: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
358: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
359: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
360: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
361: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 362: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 363: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 364: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
365: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
366: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
367: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
368: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
369: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
370: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
371: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 372: emulation</a></span></dt>
1.6 rillig 373: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
374: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 375: </dl></dd>
1.6 rillig 376: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 377: </dl></dd>
1.6 rillig 378: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
379: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 380: <dd><dl>
1.6 rillig 381: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
382: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
383: <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 384: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 385: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 386: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
387: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 388: </dl></dd>
389: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
390: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
391: <dd><dl>
392: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
393: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
394: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
395: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 396: </dl></dd>
397: </dl></dd>
398: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
399: <dd><dl>
1.6 rillig 400: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 401: <dd><dl>
1.6 rillig 402: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
403: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 405: <dd><dl>
1.6 rillig 406: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
407: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 408: </dl></dd>
1.6 rillig 409: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
410: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 411: <dd><dl>
1.6 rillig 412: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
413: <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 414: </dl></dd>
1.6 rillig 415: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 416: <dd><dl>
1.23 wiz 417: <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>
418: <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 419: </dl></dd>
420: </dl></dd>
1.6 rillig 421: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 422: <dd><dl>
1.6 rillig 423: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
424: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 426: <dd><dl>
1.6 rillig 427: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
428: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 429: </dl></dd>
430: </dl></dd>
1.6 rillig 431: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 432: <dd><dl>
1.6 rillig 433: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
434: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 435: </dl></dd>
436: </dl></dd>
437: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
440: <dd><dl>
441: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
442: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
443: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 444: <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 445: </dl></dd>
446: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
447: </dl></dd>
448: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
449: <dd><dl>
450: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
451: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
452: </dl></dd>
453: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
454: <dd><dl>
1.23 wiz 455: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
456: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
457: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
458: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
459: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
460: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 461: source packages</a></span></dt>
462: </dl></dd>
463: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
464: <dd><dl>
465: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
466: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
467: </dl></dd>
468: </dl>
469: </div>
470: <div class="list-of-tables">
471: <p><b>List of Tables</b></p>
472: <dl>
473: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
474: </dt>
1.6 rillig 475: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 476: </dt>
1.6 rillig 477: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 478: </dt>
479: </dl>
480: </div>
1.41 asau 481: <div class="chapter">
482: <div class="titlepage"><div><div><h1 class="title">
483: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 484: <div class="toc">
485: <p><b>Table of Contents</b></p>
486: <dl>
487: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
488: <dd><dl>
489: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
490: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
491: </dl></dd>
492: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
493: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
494: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
495: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
496: </dl>
497: </div>
1.41 asau 498: <div class="sect1">
1.1 dsieger 499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
500: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
501: <p>There is a lot of software freely available for Unix-based
502: systems, which is usually available in form of the source code. Before
503: such software can be used, it needs to be configured to the local
504: system, compiled and installed, and this is exactly what The NetBSD
505: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
506: to handle binary packages, so that not every user has to build the
507: packages for himself, which is a time-costly task.</p>
508: <p>pkgsrc currently contains several thousand packages,
509: including:</p>
1.41 asau 510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 511: <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 512: web server</p></li>
1.23 wiz 513: <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 514: web browser</p></li>
1.23 wiz 515: <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 516: Desktop Environment</p></li>
1.23 wiz 517: <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 518: Desktop Environment</p></li>
519: </ul></div>
520: <p>...just to name a few.</p>
521: <p>pkgsrc has built-in support for handling varying dependencies,
522: such as pthreads and X11, and extended features such as IPv6 support on
523: a range of platforms.</p>
1.41 asau 524: <div class="sect2">
1.1 dsieger 525: <div class="titlepage"><div><div><h3 class="title">
526: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
527: <p>
528: pkgsrc provides the following key features:
529: </p>
1.41 asau 530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 531: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 532: and installation of binary packages. The source and latest
533: patches are retrieved from a master or mirror download site, checksum
534: verified, then built on your system. Support for binary-only
535: distributions is available for both native platforms and NetBSD
536: emulated platforms.</p></li>
1.23 wiz 537: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 538: including binaries, libraries, man pages and other
539: documentation.</p></li>
1.23 wiz 540: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1 dsieger 541: are handled automatically. The configuration files of various
542: packages are handled automatically during updates, so local changes
543: are preserved.</p></li>
1.23 wiz 544: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 545: consists of highly portable code. This allows the greatest speed of
1.25 spz 546: development when porting to a new platform. This portability also
1.1 dsieger 547: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
548: platforms</em></span>.</p></li>
1.23 wiz 549: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 550: international encryption requirements and build-time options for a
551: large number of packages are all set in a simple, central
552: configuration file.</p></li>
1.23 wiz 553: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 554: freely available under a BSD license, so you may extend and adapt
555: pkgsrc to your needs. Support for local packages and patches is
556: available right out of the box, so you can configure it specifically
557: for your environment.</p></li>
558: </ul></div>
559: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 561: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 562: — That means, if a package contains bugs, it's better to find
1.1 dsieger 563: them and to complain about them rather than to just install the package
564: and hope that it works. There are numerous checks in pkgsrc that try to
565: 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
566: of shell scripts), and post-installation checks (installed files,
567: references to shared libraries, script interpreters).</p></li>
1.23 wiz 568: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 569: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 570: pkgsrc has been ported to many operating systems. Care is taken that
571: packages behave the same on all platforms.</p></li>
572: </ul></div>
573: </div>
1.41 asau 574: <div class="sect2">
1.1 dsieger 575: <div class="titlepage"><div><div><h3 class="title">
576: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
577: <p>pkgsrc consists of both a source distribution and a binary
578: distribution for these operating systems. After retrieving the required
579: source or binaries, you can be up and running with pkgsrc in just
580: minutes!</p>
581: <p>pkgsrc was derived from FreeBSD's ports system, and
582: initially developed for NetBSD only. Since then, pkgsrc has
583: grown a lot, and now supports the following platforms:</p>
584: <div class="table">
585: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
586: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
587: <colgroup>
588: <col>
589: <col>
590: </colgroup>
591: <thead><tr>
592: <th>Platform</th>
593: <th>Date Support Added</th>
594: </tr></thead>
595: <tbody>
596: <tr>
1.10 hubertf 597: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 598: <td align="center">Aug 1997</td>
599: </tr>
600: <tr>
1.10 hubertf 601: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 602: <td align="center">Mar 1999</td>
603: </tr>
604: <tr>
1.10 hubertf 605: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 606: <td align="center">Jun 1999</td>
607: </tr>
608: <tr>
609: <td>
1.10 hubertf 610: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
611: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 612: </td>
613: <td align="center">Oct 2001</td>
614: </tr>
615: <tr>
1.10 hubertf 616: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 617: <td align="center">Nov 2002</td>
618: </tr>
619: <tr>
1.10 hubertf 620: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 621: <td align="center">Nov 2002</td>
622: </tr>
623: <tr>
1.10 hubertf 624: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 625: <td align="center">Dec 2002</td>
626: </tr>
627: <tr>
628: <td>BSD/OS</td>
629: <td align="center">Dec 2003</td>
630: </tr>
631: <tr>
1.10 hubertf 632: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 633: <td align="center">Dec 2003</td>
634: </tr>
635: <tr>
636: <td>
1.10 hubertf 637: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 638: (Microsoft Windows Services for Unix)
639: </td>
640: <td align="center">Mar 2004</td>
641: </tr>
642: <tr>
1.10 hubertf 643: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 644: <td align="center">Oct 2004</td>
645: </tr>
646: <tr>
1.10 hubertf 647: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 648: <td align="center">Nov 2004</td>
649: </tr>
650: <tr>
1.10 hubertf 651: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 652: <td align="center">Apr 2007</td>
653: </tr>
1.23 wiz 654: <tr>
655: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
656: <td align="center">Sep 2010</td>
657: </tr>
1.45 obache 658: <tr>
659: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 660: <td align="center">Jan 2011</td>
1.45 obache 661: </tr>
662: <tr>
663: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
664: <td align="center">Nov 2011</td>
665: </tr>
666: <tr>
667: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
668: <td align="center">Mar 2013</td>
669: </tr>
1.58 ryoon 670: <tr>
671: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
672: <td align="center">Jul 2013</td>
673: </tr>
1.1 dsieger 674: </tbody>
675: </table></div>
676: </div>
677: <br class="table-break">
678: </div>
679: </div>
1.41 asau 680: <div class="sect1">
1.1 dsieger 681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
682: <a name="overview"></a>1.2. Overview</h2></div></div></div>
683: <p>This document is divided into three parts. The first,
1.10 hubertf 684: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 685: describes how one can use one of the packages in the Package
686: Collection, either by installing a precompiled binary package,
687: or by building one's own copy using the NetBSD package system.
1.10 hubertf 688: 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 689: package so it can be easily built by other NetBSD users without
690: knowing about the package's building details. The third part,
1.10 hubertf 691: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 692: is intended for those who want to understand how pkgsrc is
693: implemented.</p>
694: <p>This document is available in various formats:
1.10 hubertf 695: <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 696: </div>
1.41 asau 697: <div class="sect1">
1.1 dsieger 698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
699: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 700: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
701: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 702: terminology used within this document.</p>
1.41 asau 703: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 704: <dt><span class="term">Package</span></dt>
705: <dd><p>A set of files and building instructions
706: that describe what's necessary
707: to build a certain piece of software using
708: pkgsrc. Packages are traditionally stored under
709: <code class="filename">/usr/pkgsrc</code>.</p></dd>
710: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 711: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 712: is part of the NetBSD operating system and can be bootstrapped
713: to run on non-NetBSD operating systems as well. It handles
714: building (compiling), installing, and removing of
715: packages.</p></dd>
716: <dt><span class="term">Distfile</span></dt>
717: <dd><p>This term describes the file or files that are
718: provided by the author of the piece of software to
719: distribute his work. All the changes necessary to build on
720: NetBSD are reflected in the corresponding package. Usually
721: the distfile is in the form of a compressed tar-archive,
722: but other types are possible, too. Distfiles are usually
723: stored below
724: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
725: <dt><span class="term">Port</span></dt>
726: <dd><p>This is the term used by FreeBSD and OpenBSD people
727: for what we call a package.
1.23 wiz 728: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 729: architecture.</p></dd>
730: <dt><span class="term">Precompiled/binary package</span></dt>
731: <dd>
732: <p>A set of binaries built with pkgsrc from a distfile
733: and stuffed together in a single <code class="filename">.tgz</code>
734: file so it can be installed on machines of the same
735: machine architecture without the need to
736: recompile. Packages are usually generated in
737: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 738: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 739: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 740: especially in the context of precompiled packages.</p>
741: </dd>
742: <dt><span class="term">Program</span></dt>
743: <dd><p>The piece of software to be installed which will be
744: constructed from all the files in the distfile by the
745: actions defined in the corresponding package.</p></dd>
746: </dl></div>
1.41 asau 747: <div class="sect2">
1.1 dsieger 748: <div class="titlepage"><div><div><h3 class="title">
749: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 750: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 751: <dt><span class="term">pkgsrc users</span></dt>
752: <dd>
753: <p>The
754: pkgsrc users are people who use the packages provided by pkgsrc.
755: Typically they are system administrators. The people using the
1.23 wiz 756: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
757: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 758: <p>There are two kinds of pkgsrc users: Some only want to
759: install pre-built binary packages. Others build the pkgsrc
760: packages from source, either for installing them directly or for
1.10 hubertf 761: 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 762: documentation.</p>
763: </dd>
764: <dt><span class="term">package maintainers</span></dt>
765: <dd><p>A
1.10 hubertf 766: 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 767: <dt><span class="term">infrastructure developers</span></dt>
768: <dd><p>These people are involved in all those files
769: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 770: 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 771: too.</p></dd>
772: </dl></div>
773: </div>
774: </div>
1.41 asau 775: <div class="sect1">
1.1 dsieger 776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
777: <a name="typography"></a>1.4. Typography</h2></div></div></div>
778: <p>When giving examples for commands, shell prompts are used to
779: show if the command should/can be issued as root, or if
1.23 wiz 780: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 781: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
782: shell prompt, assuming they use the C-shell or tcsh.</p>
783: </div>
784: </div>
1.41 asau 785: <div class="part">
1.1 dsieger 786: <div class="titlepage"><div><div><h1 class="title">
787: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
788: <div class="toc">
789: <p><b>Table of Contents</b></p>
790: <dl>
791: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
792: <dd><dl>
793: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
794: <dd><dl>
1.51 asau 795: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 796: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 797: </dl></dd>
798: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
799: <dd><dl>
800: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
801: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
802: </dl></dd>
803: </dl></dd>
804: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
805: <dd><dl>
806: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
807: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
808: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
809: <dd><dl>
1.45 obache 810: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
811: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
812: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 813: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
814: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
815: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
816: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
817: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
818: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
819: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 820: </dl></dd>
821: </dl></dd>
822: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
823: <dd><dl>
824: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
825: <dd><dl>
826: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
827: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
828: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
829: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
830: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
831: <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>
832: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
833: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
834: </dl></dd>
835: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
836: <dd><dl>
837: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
838: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
839: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
840: </dl></dd>
841: </dl></dd>
842: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
843: <dd><dl>
844: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
845: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 846: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 847: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 848: <dd><dl>
1.4 rillig 849: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 850: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
851: <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 852: </dl></dd>
1.4 rillig 853: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
854: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 855: </dl></dd>
856: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
857: <dd><dl>
858: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
859: <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 860: </dl></dd>
861: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
862: builds)</a></span></dt>
1.1 dsieger 863: <dd><dl>
1.71 wiz 864: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
865: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
866: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
867: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 868: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
869: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 870: </dl></dd>
871: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
872: <dd><dl>
1.23 wiz 873: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
874: <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 875: </dl></dd>
876: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
877: <dd><dl>
878: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
879: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
880: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
881: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
882: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
883: <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>
884: <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 885: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
886: <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>
887: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
888: <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 889: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.65 wiz 890: <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>
891: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
892: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
893: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
894: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
895: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
896: <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 897: </dl></dd>
898: </dl>
899: </div>
1.41 asau 900: <div class="chapter">
1.1 dsieger 901: <div class="titlepage"><div><div><h2 class="title">
902: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
903: <div class="toc">
904: <p><b>Table of Contents</b></p>
905: <dl>
906: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
907: <dd><dl>
1.51 asau 908: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 909: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 910: </dl></dd>
911: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
912: <dd><dl>
913: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
914: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
915: </dl></dd>
916: </dl>
917: </div>
918: <p>Before you download and extract the files, you need to decide
919: where you want to extract them. When using pkgsrc as root user, pkgsrc
920: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
921: free to install the sources and binary packages wherever you want in
922: your filesystem, provided that the pathname does not contain white-space
923: or other characters that are interpreted specially by the shell and some
924: other programs. A safe bet is to use only letters, digits, underscores
925: and dashes.</p>
1.41 asau 926: <div class="sect1">
1.1 dsieger 927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
928: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
929: <p>Before you download any pkgsrc files, you should decide
930: whether you want the <span class="emphasis"><em>current</em></span> branch or the
931: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
932: quarterly basis from the current branch and only gets modified
933: for security updates. The names of the stable branches are built
934: from the year and the quarter, for example
1.21 snj 935: <code class="literal">2009Q1</code>.</p>
1.1 dsieger 936: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 937: want to download pkgsrc. You can get it as a tar file or via CVS.
938: Both ways are described here.</p>
1.51 asau 939: <p>Note that tar archive contains CVS working copy.
940: Thus you can switch to using CVS at any later time.</p>
941: <p>Note also that quarterly branch is not frozen in stone.
942: It receives critical updates.</p>
1.41 asau 943: <div class="sect2">
1.1 dsieger 944: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 945: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 946: <p>The primary download location for all pkgsrc files is
1.51 asau 947: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
948: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
949: (it points to the same location).
950: There are a number of subdirectories for different purposes,
951: 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>
952: <p>The tar archive for the current branch is in the directory
953: <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 954: It is autogenerated daily.</p>
1.51 asau 955: <p>To save download time we provide bzip2- and
956: xz-compressed archives which are published at
957: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
958: and
959: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
960: respectively.
961: </p>
962: <p>You can fetch the same files using FTP.</p>
1.59 jnemeth 963: <p>The tar file for the stable branch 2013Q1 is in the
964: 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 965: <p>To download a pkgsrc stable tarball, run:</p>
966: <pre class="screen">
1.59 jnemeth 967: <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 968: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 969: stable branch to be downloaded, for example,
1.59 jnemeth 970: <span class="quote">“<span class="quote">pkgsrc-2013Q1</span>”</span>.</p>
1.51 asau 971: <p>You can use fetch it also using "wget", "curl",
972: or your web browser.</p>
1.12 weinem 973: <p>Then, extract it with:</p>
1.22 jakllsch 974: <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 975: <p>This will create the directory <code class="filename">pkgsrc/</code>
976: in <code class="filename">/usr/</code> and all the package source will be
977: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
978: <p>To download pkgsrc-current, run:</p>
979: <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 980: </div>
1.41 asau 981: <div class="sect2">
1.1 dsieger 982: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 983: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
984: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 985: <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 986: </pre>
987: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
988: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
989: <p>This will create the directory <code class="filename">pkgsrc/</code>
990: in your <code class="filename">/usr/</code> directory and all the package source
991: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
992: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 993: <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 994: </pre>
1.29 dholland 995: <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 996: <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 997: <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 998: </pre>
999: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1000: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1001: or better globally in <code class="filename">/etc/profile</code>:</p>
1002: <pre class="programlisting">
1003: # set CVS remote shell command
1004: CVS_RSH=ssh
1005: export CVS_RSH
1006: </pre>
1007: <p>By default, CVS doesn't do things like most people would expect it to do.
1008: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1009: in your home directory and saving the following lines to it.
1010: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1011: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1012: <pre class="programlisting">
1013: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1014: cvs -q -z2
1.2 rillig 1015: checkout -P
1.4 rillig 1016: update -dP
1017: diff -upN
1.2 rillig 1018: rdiff -u
1.23 wiz 1019: release -d
1.2 rillig 1020: </pre>
1.1 dsieger 1021: </div>
1022: </div>
1.41 asau 1023: <div class="sect1">
1.1 dsieger 1024: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1025: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1026: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1027: (which also works if you have first installed it via a tar
1028: file). It saves bandwidth and hard disk activity, compared to
1029: downloading the tar file again.</p>
1.41 asau 1030: <div class="sect2">
1.1 dsieger 1031: <div class="titlepage"><div><div><h3 class="title">
1032: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1033: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1034: <h3 class="title">Warning</h3>
1035: <p>When updating from a tar file, you first need to
1036: completely remove the old pkgsrc directory. Otherwise those
1037: files that have been removed from pkgsrc in the mean time will
1038: not be removed on your local disk, resulting in inconsistencies.
1039: When removing the old files, any changes that you have done to
1040: the pkgsrc files will be lost after updating. Therefore updating
1041: via CVS is strongly recommended.</p>
1042: </div>
1043: <p>Note that by default the distfiles and the binary packages
1044: are saved in the pkgsrc tree, so don't forget to rescue them
1045: before updating. You can also configure pkgsrc to use other than
1046: the default directories by setting the
1047: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1048: 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 1049: <p>To update pkgsrc from a tar file, download the tar file as
1050: explained above. Then, make sure that you have not made any
1051: changes to the files in the pkgsrc directory. Remove the pkgsrc
1052: directory and extract the new tar file. Done.</p>
1053: </div>
1.41 asau 1054: <div class="sect2">
1.1 dsieger 1055: <div class="titlepage"><div><div><h3 class="title">
1056: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1057: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1058: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1059: </pre>
1060: <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>
1061: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1062: </pre>
1.41 asau 1063: <div class="sect3">
1.1 dsieger 1064: <div class="titlepage"><div><div><h4 class="title">
1065: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1066: <p>When updating pkgsrc, the CVS program keeps track of the
1067: branch you selected. But if you, for whatever reason, want to
1068: switch from the stable branch to the current one, you can do it
1.23 wiz 1069: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1070: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1071: back to the stable branch, add the
1.23 wiz 1072: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.1 dsieger 1073: </div>
1.41 asau 1074: <div class="sect3">
1.1 dsieger 1075: <div class="titlepage"><div><div><h4 class="title">
1076: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1077: <p>When you update pkgsrc, the CVS program will only touch
1078: those files that are registered in the CVS repository. That
1079: means that any packages that you created on your own will stay
1080: unmodified. If you change files that are managed by CVS, later
1081: updates will try to merge your changes with those that have been
1082: done by others. See the CVS manual, chapter
1.23 wiz 1083: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1084: </div>
1085: </div>
1086: </div>
1087: </div>
1.41 asau 1088: <div class="chapter">
1.1 dsieger 1089: <div class="titlepage"><div><div><h2 class="title">
1090: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1091: <div class="toc">
1092: <p><b>Table of Contents</b></p>
1093: <dl>
1094: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1095: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1096: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1097: <dd><dl>
1.45 obache 1098: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1099: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1100: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.58 ryoon 1101: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
1102: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
1103: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
1104: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
1105: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
1106: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
1107: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.1 dsieger 1108: </dl></dd>
1109: </dl>
1110: </div>
1.41 asau 1111: <div class="sect1">
1.1 dsieger 1112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1113: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1114: <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 1115: </div>
1.41 asau 1116: <div class="sect1">
1.1 dsieger 1117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1118: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1119: <p>pkgsrc can be bootstrapped for use in two different modes:
1120: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1121: to privileged one all programs are installed under one particular user
1.43 asau 1122: and cannot utilise privileged operations (packages don't create
1123: special users and all special file permissions like setuid are ignored).
1124: </p>
1.1 dsieger 1125: <p>Installing the bootstrap kit from source should be as simple as:</p>
1126: <pre class="screen">
1.60 asau 1127: <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 1128: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1129: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1130: </pre>
1.43 asau 1131: <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>
1132: <p>By default, in privileged mode pkgsrc uses
1133: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1134: where programs will be installed in,
1.1 dsieger 1135: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1136: directory where pkgsrc will do its internal bookkeeping,
1137: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1138: where packages install their persistent data.
1139: In unprivileged mode pkgsrc uses
1140: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1141: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1142: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1143: </p>
1144: <p>You can change default layout using command-line arguments.
1145: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1146: </p>
1.41 asau 1147: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1148: <h3 class="title">Note</h3>
1.10 hubertf 1149: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1150: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1151: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1152: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1153: </div>
1.43 asau 1154: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1155: <h3 class="title">Note</h3>
1156: <p>It is possible to bootstrap multiple instances of pkgsrc
1157: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1158: corresponding to the installation you're working with to build
1159: and install packages.
1160: </p>
1161: </div>
1.1 dsieger 1162: </div>
1.41 asau 1163: <div class="sect1">
1.1 dsieger 1164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1165: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1166: <p>Here are some platform-specific notes you should be aware of.</p>
1.41 asau 1167: <div class="sect2">
1.1 dsieger 1168: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1169: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1170: <p>Cygwin 1.7.x and later are supported.</p>
1171: <p>You need to install minimal base packages in `Base' category
1172: plus any of compiler, gcc, gcc4, and/or clang.
1173: For gcc and gcc4, C and C++ compiler will be installed by default,
1174: but you can install Fortran compiler additionally
1175: because it will be required to use libtool.
1176: If it is not installed (or too old), Fortran compiler will be
1177: installed with pkgsrc automatically.</p>
1178: <p>As noted in
1179: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1180: su(1) command has been in Cygwin distribution, but it has never worked.
1181: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1182: </p>
1183: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1184: then pick "Run as administrator".</p></li></ul></div>
1185: </div>
1186: <div class="sect2">
1187: <div class="titlepage"><div><div><h3 class="title">
1188: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.41 asau 1189: <p>Darwin 5.x and up are supported.</p>
1190: <p>Before you start, you need to download and install
1191: the Mac OS X Developer Tools from Apple's Developer Connection.
1192: This requires (free) membership. See
1.22 jakllsch 1193: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.41 asau 1194: for details. Also, make sure you install X11 (an optional
1195: package included with the Developer Tools) if you intend
1196: to build packages that use the X11 Window System.
1197: (If you don't want or need the full Xcode GUI,
1198: download and install Command Line Tools for Xcode.)</p>
1.1 dsieger 1199: </div>
1.41 asau 1200: <div class="sect2">
1.1 dsieger 1201: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1202: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.29 dholland 1203: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1 dsieger 1204: other versions may work.</p>
1205: <p>Care should be taken so that the tools that this kit installs do not conflict
1206: with the FreeBSD userland tools. There are several steps:</p>
1.23 wiz 1207: <div class="orderedlist"><ol class="orderedlist" type="1">
1208: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1 dsieger 1209: <code class="filename">/var/db/pkg</code>. It is therefore
1210: recommended that you choose a different location (e.g.
1211: <code class="filename">/usr/pkgdb</code>) by
1212: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1213: <li class="listitem">
1.1 dsieger 1214: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1215: good idea to move them out of the way to avoid confusion, e.g.</p>
1216: <pre class="screen">
1217: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1218: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1219: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1220: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1221: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1222: </pre>
1223: </li>
1.23 wiz 1224: <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 1225: <code class="filename">/etc/mk.conf.example</code> file
1226: when you use the bootstrap script.</p></li>
1227: </ol></div>
1228: </div>
1.41 asau 1229: <div class="sect2">
1.1 dsieger 1230: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1231: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
1232: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
1233: Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
1234: <p> You should install ncurses (libncurses and libncurses-dev)
1235: packages.</p>
1236: </div>
1237: <div class="sect2">
1238: <div class="titlepage"><div><div><h3 class="title">
1239: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.1 dsieger 1240: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1241: providing a Unix-like environment with a tighter kernel integration than
1242: available with Cygwin. It is part of the Windows Services for Unix
1243: package, available for free for any licensed copy of Windows 2000, XP
1.10 hubertf 1244: (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 1245: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1246: are not officially supported. (The main difference in 3.0/3.1 is lack
1247: of pthreads, but other parts of libc may also be lacking.)</p>
1.24 wiz 1248: <p>Services for Unix Applications (aka SUA) is an integrated
1249: component of Windows Server 2003 R2 (5.2), Windows Vista and
1250: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1251: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1252: 6.1 (64bit) subsystems have been tested. Other versions may
1253: work as well. The Interix 5.x subsystem has not yet been tested
1254: with pkgsrc.</p>
1.41 asau 1255: <div class="sect3">
1.1 dsieger 1256: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1257: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.1 dsieger 1258: <p>At an absolute minimum, the following packages must be installed from
1259: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.41 asau 1260: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1261: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1262: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1263: <li class="listitem"><p>Remote Connectivity</p></li>
1264: <li class="listitem"><p>Interix SDK</p></li>
1.1 dsieger 1265: </ul></div>
1266: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1267: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1268: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1269: pkgsrc (or from a binary package).</p>
1270: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1271: not need to be installed, but Remote Connectivity itself should be
1272: installed in order to have a working inetd.</p>
1273: <p>During installation you may be asked whether to enable setuid
1274: behavior for Interix programs, and whether to make pathnames default to
1275: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1276: enabled. (Without case-sensitivity, a large number of packages including
1277: perl will not build.)</p>
1278: <p>NOTE: Newer Windows service packs change the way binary execution
1279: works (via the Data Execution Prevention feature). In order to use
1280: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1281: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1282: must be installed. Hotfixes are available from Microsoft through a
1.14 jmcneill 1283: support contract; however, Debian Interix Port has made most Interix
1284: 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 1285: <p>In addition to the hotfix noted above, it may be necessary to
1286: disable Data Execution Prevention entirely to make Interix functional.
1287: This may happen only with certain types of CPUs; the cause is not fully
1288: understood at this time. If gcc or other applications still segfault
1289: repeatedly after installing one of the hotfixes note above, the
1290: following option can be added to the appropriate "boot.ini" line on the
1291: Windows boot drive: /NoExecute=AlwaysOff
1292: (WARNING, this will disable DEP completely, which may be a security
1293: risk if applications are often run as a user in the Administrators
1294: group!)</p>
1295: </div>
1.41 asau 1296: <div class="sect3">
1.1 dsieger 1297: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1298: <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 1299: <p>If SFU is already installed and you wish to alter these settings to work
1300: with pkgsrc, note the following things.</p>
1.41 asau 1301: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1302: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1 dsieger 1303: Windows Services for UNIX, then click Change. In the installer, choose
1304: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.23 wiz 1305: <li class="listitem">
1.1 dsieger 1306: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1307: change the following registry key:</p>
1308: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1309: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1310: </li>
1.23 wiz 1311: <li class="listitem">
1.1 dsieger 1312: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1313: following registry key:</p>
1314: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1315: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1316: </li>
1317: </ul></div>
1318: </div>
1.41 asau 1319: <div class="sect3">
1.1 dsieger 1320: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1321: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.1 dsieger 1322: <p>The package manager (either the pkgsrc "su" user, or the user
1323: running "pkg_add") must be a member of the local Administrators
1324: group. Such a user must also be used to run the bootstrap. This is
1325: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1326: <p>The package manager should use a umask of 002. "make install" will
1327: automatically complain if this is not the case. This ensures that
1328: directories written in /var/db/pkg are Administrators-group writeable.</p>
1329: <p>The popular Interix binary packages from http://www.interopsystems.com/
1330: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1331: NOT be used in conjunction with pkgsrc. If you choose to use them at
1332: the same time as the pkgsrc packages, ensure that you use the proper
1333: pkg_* tools for each type of binary package.</p>
1334: <p>The TERM setting used for DOS-type console windows (including those
1335: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1336: don't have a termcap/terminfo entry for it, but the following .termcap
1337: entry provides adequate emulation in most cases:</p>
1338: <pre class="programlisting">
1339: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1340: </pre>
1341: </div>
1.41 asau 1342: <div class="sect3">
1.1 dsieger 1343: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1344: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.1 dsieger 1345: <p>Though Interix suffices as a familiar and flexible substitute
1346: for a full Unix-like platform, it has some drawbacks that should
1347: be noted for those desiring to make the most of Interix.</p>
1.41 asau 1348: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1349: <li class="listitem">
1.1 dsieger 1350: <p><span class="strong"><strong>X11:</strong></span></p>
1351: <p>Interix comes with the standard set of X11R6 client libraries,
1352: and can run X11 based applications, but it does
1353: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.10 hubertf 1354: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1355: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1 dsieger 1356: (available in a trimmed version for Interix from Interop Systems as the
1.10 hubertf 1357: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1 dsieger 1358: and the free X11 server included with
1.10 hubertf 1359: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1 dsieger 1360: </li>
1.23 wiz 1361: <li class="listitem">
1.1 dsieger 1362: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1363: <p>Because Interix runs in a completely different NT subsystem from
1364: Win32 applications, it does not currently support various X11
1365: protocol extensions for acceleration (such as MIT-SHM or DGA).
1366: Most interactive applications to a local X server will run
1367: reasonably fast, but full motion video and other graphics
1368: intensive applications may require a faster-than-expected CPU.</p>
1369: </li>
1.23 wiz 1370: <li class="listitem">
1.1 dsieger 1371: <p><span class="strong"><strong>Audio:</strong></span></p>
1372: <p>Interix has no native support for audio output. For audio
1.10 hubertf 1373: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1 dsieger 1374: audio system on Interix. Unlike on most platforms, the
1375: <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 1376: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1 dsieger 1377: server component. To output audio via an Interix host, the
1378: <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
1379: must also be installed.</p>
1380: </li>
1.23 wiz 1381: <li class="listitem">
1.1 dsieger 1382: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1383: <p>Direct device access is not currently supported in Interix, so it
1384: is not currently possible to access CD/DVD drives, USB devices,
1385: or SCSI devices through non-filesystem means. Among other things,
1386: this makes it impossible to use Interix directly for CD/DVD
1387: burning.</p>
1388: </li>
1.23 wiz 1389: <li class="listitem">
1.1 dsieger 1390: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1391: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1392: drives are also not directly accessible in Interix. However,
1393: support is in work to make tape drive access possible by using
1394: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1395: esound server).</p>
1396: </li>
1397: </ul></div>
1398: </div>
1.41 asau 1399: <div class="sect3">
1.1 dsieger 1400: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1401: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.1 dsieger 1402: <p>It is not necessary, in general, to have a "root" user on the
1403: Windows system; any member of the local Administrators group will
1404: suffice. However, some packages currently assume that the user
1405: named "root" is the privileged user. To accommodate these, you
1406: may create such a user; make sure it is in the local group
1407: Administrators (or your language equivalent).</p>
1.10 hubertf 1408: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1 dsieger 1409: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1410: time being, install packages as the local Administrator (or
1411: your language equivalent), or run the following command after
1412: installing a package to work around the issue:</p>
1413: <pre class="screen">
1414: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1415: </pre>
1416: </div>
1417: </div>
1.41 asau 1418: <div class="sect2">
1.1 dsieger 1419: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1420: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.1 dsieger 1421: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1422: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1423: according to your preference. If you do not have a license for the MIPSpro
1.10 hubertf 1424: 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 1425: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.29 dholland 1426: 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 1427: etc.</p>
1428: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1429: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1430: you start out using "abi=n32", that's what all your packages will be built
1431: with.</p>
1432: <p>Therefore, please make sure that you have no conflicting
1433: <code class="varname">CFLAGS</code> in your environment or the
1.10 hubertf 1434: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1435: try to link n32 object files with lib64 or vice versa. Check your
1436: <code class="filename">/etc/compiler.defaults</code>!</p>
1437: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1438: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1439: as it appears that IRIX linker occasionally runs into issues when trying to
1440: link over a network-mounted file system.</p>
1441: <p>The bootstrapping process should set all the right options for programs such
1442: as imake(1), but you may want to set some options depending on your local
1443: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1444: course, your compiler's man pages for details.</p>
1445: <p>If you are using SGI's MIPSPro compiler, please set
1446:
1447: </p>
1448: <pre class="programlisting">
1449: PKGSRC_COMPILER= mipspro
1450: </pre>
1451: <p>
1452:
1.10 hubertf 1453: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1454: are using gcc and may end up passing invalid flags to the compiler. Note that
1455: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1456: default.</p>
1457: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1458: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1459: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1460: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1461: '--preserve-path' flag.</p>
1462: </div>
1.41 asau 1463: <div class="sect2">
1.1 dsieger 1464: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1465: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.1 dsieger 1466: <p>Some versions of Linux (for example Debian GNU/Linux) need
1467: either libtermcap or libcurses (libncurses). Installing the
1468: distributions libncurses-dev package (or equivalent) should fix
1469: the problem.</p>
1470: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1471: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1472: i386 have been tested.</p>
1473: <p>To bootstrap using icc, assuming the default icc installation
1474: directory:</p>
1475: <pre class="programlisting">
1.31 wiz 1476: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1 dsieger 1477: </pre>
1.41 asau 1478: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1479: <h3 class="title">Note</h3>
1.31 wiz 1480: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1481: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1482: <p>For icc 10.1 neither of these appears to be necessary.</p>
1483: </div>
1484: <p>Use a value for ICCBASE that corresponds to the directory
1485: where icc is installed. After bootstrapping, set
1486: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30 wiz 1487: <pre class="programlisting">
1.31 wiz 1488: ICCBASE= /opt/intel/cc/10.1.008
1.1 dsieger 1489: </pre>
1.31 wiz 1490: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1491: <code class="filename">/opt/intel_cc_80</code>. This is the default
1492: install directory for icc 8.0. If you are using a more recent
1493: version, be sure to set the correct path explicitly.
1494: </p>
1.1 dsieger 1495: <p>pkgsrc uses the static linking method of the runtime libraries
1496: provided by icc, so binaries can be run on other systems which do not
1497: have the shared libraries installed.</p>
1498: <p>Libtool, however, extracts a list of libraries from the
1.29 dholland 1499: <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 1500: records it, throwing away the -Bstatic and -Bdynamic options
1501: interspersed between the libraries. This means that
1502: libtool-linked C++ shared libraries will have a runtime
1503: dependency on the icc libraries until this is fixed in
1504: libtool.</p>
1505: </div>
1.41 asau 1506: <div class="sect2">
1.1 dsieger 1507: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1508: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.57 bsiegert 1509: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
1510: Older versions might also work. Releases before #10 are not
1511: supported.</p>
1512: <p>The package tools of the (older) native ports tree,
1513: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
1514: have the same names as the ones used by pkgsrc. Care should be taken
1515: that the right tools are used. When installing packages from source,
1516: use the <code class="filename">bmake</code> command for pkgsrc and
1517: <code class="filename">mmake</code> for MirPorts.</p>
1518: <p>pkgsrc and MirPorts use the same location for the package
1519: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
1520: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
1521: tree is self-contained. This is also the default setting used in the
1522: binary package builds.</p>
1523: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
1524: server. The bootstrap kit there already contains the
1525: <span class="command"><strong>pkgin</strong></span> package manager. See the
1526: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
1527: page for more details.</p>
1528: </div>
1529: <div class="sect2">
1530: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1531: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.29 dholland 1532: <p>OpenBSD 5.1 has been tested and supported,
1533: other versions may work.</p>
1.1 dsieger 1534: <p>Care should be taken so that the tools that this kit installs do not conflict
1535: with the OpenBSD userland tools. There are several steps:</p>
1.23 wiz 1536: <div class="orderedlist"><ol class="orderedlist" type="1">
1537: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1 dsieger 1538: <code class="filename">/var/db/pkg</code>. It is therefore
1539: recommended that you choose a different location (e.g.
1540: <code class="filename">/usr/pkgdb</code>) by
1541: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1542: <li class="listitem">
1.1 dsieger 1543: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1544: good idea to move them out of the way to avoid confusion, e.g.</p>
1545: <pre class="screen">
1546: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1547: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1548: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1549: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1550: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1551: </pre>
1552: </li>
1.23 wiz 1553: <li class="listitem">
1.10 hubertf 1554: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1555: <code class="filename">/etc/mk.conf.example</code> file
1556: when you use the bootstrap script. OpenBSD's make program uses
1.10 hubertf 1557: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1558: as well. You can work around this by enclosing all the pkgsrc-specific parts
1559: of the file with:</p>
1560: <pre class="programlisting">
1561: .ifdef BSD_PKG_MK
1562: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1563: .else
1564: # OpenBSD stuff
1565: .endif
1566: </pre>
1567: </li>
1568: </ol></div>
1569: </div>
1.41 asau 1570: <div class="sect2">
1.1 dsieger 1571: <div class="titlepage"><div><div><h3 class="title">
1.58 ryoon 1572: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.35 wiz 1573: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1574: You will need a working C compiler. Both gcc 4.5.3 and
1.1 dsieger 1575: Sun WorkShop 5 have been tested.</p>
1576: <p>The following packages are required on Solaris 8 for the bootstrap
1577: process and to build packages.</p>
1.41 asau 1578: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1579: <li class="listitem"><p>SUNWsprot</p></li>
1580: <li class="listitem"><p>SUNWarc</p></li>
1581: <li class="listitem"><p>SUNWbtool</p></li>
1582: <li class="listitem"><p>SUNWtoo</p></li>
1583: <li class="listitem"><p>SUNWlibm</p></li>
1.1 dsieger 1584: </ul></div>
1585: <p>Please note that the use of GNU binutils on Solaris is
1586: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1587: <p>Whichever compiler you use, please ensure the compiler tools and
1588: your $prefix are in your <code class="varname">PATH</code>. This includes
1589: <code class="filename">/usr/ccs/{bin,lib}</code>
1590: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.41 asau 1591: <div class="sect3">
1.1 dsieger 1592: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1593: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.1 dsieger 1594: <p>It makes life much simpler if you only use the same gcc consistently
1595: for building all packages.</p>
1596: <p>It is recommended that an external gcc be used only for bootstrapping,
1597: then either build gcc from
1.35 wiz 1598: <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 1599: package, then remove gcc used during bootstrapping.</p>
1.10 hubertf 1600: <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 1601: </div>
1.41 asau 1602: <div class="sect3">
1.1 dsieger 1603: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1604: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.1 dsieger 1605: <p>You will need at least the following packages installed (from WorkShop
1606: 5.0)</p>
1.41 asau 1607: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1608: <li class="listitem"><p>SPROcc
1.1 dsieger 1609: - Sun WorkShop Compiler C 5.0</p></li>
1.23 wiz 1610: <li class="listitem"><p>SPROcpl
1.1 dsieger 1611: - Sun WorkShop Compiler C++ 5.0</p></li>
1.23 wiz 1612: <li class="listitem"><p>SPROild
1.1 dsieger 1613: - Sun WorkShop Incremental Linker</p></li>
1.23 wiz 1614: <li class="listitem"><p>SPROlang
1.1 dsieger 1615: - Sun WorkShop Compilers common components</p></li>
1616: </ul></div>
1617: <p>You should set the following variables in your
1.10 hubertf 1618: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1619: <pre class="programlisting">
1620: CC= cc
1621: CXX= CC
1622: CPP= cc -E
1623: CXXCPP= CC -E
1624: </pre>
1.41 asau 1625: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1626: <h3 class="title">Note</h3>
1627: <p>The <code class="varname">CPP</code> setting might break some
1628: packages that use the C preprocessor for processing things other
1629: than C source code.</p>
1630: </div>
1631: </div>
1.41 asau 1632: <div class="sect3">
1.1 dsieger 1633: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1634: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.1 dsieger 1635: <p>To build 64-bit packages, you just need to have the
1.10 hubertf 1636: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1637: <pre class="programlisting">
1638: PKGSRC_COMPILER= sunpro
1639: ABI= 64
1640: </pre>
1.41 asau 1641: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1642: <h3 class="title">Note</h3>
1643: <p>This setting has been tested for the SPARC
1644: architecture. Intel and AMD machines need some more
1645: work.</p>
1646: </div>
1647: </div>
1.41 asau 1648: <div class="sect3">
1.1 dsieger 1649: <div class="titlepage"><div><div><h4 class="title">
1.58 ryoon 1650: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.10 hubertf 1651: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1 dsieger 1652: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1653: The workaround is to use another shell for the configure
1654: 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 1655: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1656: <pre class="programlisting">
1657: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1658: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1659: </pre>
1660: <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>
1661: </div>
1662: </div>
1663: </div>
1664: </div>
1.41 asau 1665: <div class="chapter">
1.1 dsieger 1666: <div class="titlepage"><div><div><h2 class="title">
1667: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1668: <div class="toc">
1669: <p><b>Table of Contents</b></p>
1670: <dl>
1671: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1672: <dd><dl>
1673: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1674: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1675: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1676: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1677: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1678: <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>
1679: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1680: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1681: </dl></dd>
1682: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1683: <dd><dl>
1684: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1685: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1686: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1687: </dl></dd>
1688: </dl>
1689: </div>
1690: <p>Basically, there are two ways of using pkgsrc. The first
1691: is to only install the package tools and to use binary packages
1.23 wiz 1692: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1693: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1694: of pkgsrc, too. Then you are able to build your own packages,
1695: and you can still use binary packages from someone else.</p>
1.41 asau 1696: <div class="sect1">
1.1 dsieger 1697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1698: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1699: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1700: server and its mirrors, there are collections of binary packages,
1701: ready to be installed. These binary packages have been built using the
1702: default settings for the directories, that is:</p>
1.41 asau 1703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1704: <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>
1705: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1706: <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 1707: </ul></div>
1708: <p>If you cannot use these directories for whatever reasons (maybe
1709: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1710: 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 1711: <div class="sect2">
1.1 dsieger 1712: <div class="titlepage"><div><div><h3 class="title">
1713: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1714: <p>To install binary packages, you first need to know from where
1715: to get them. The first place where you should look is on the main
1.10 hubertf 1716: 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 1717: <p>This directory contains binary packages for multiple
1718: platforms. First, select your operating system. (Ignore the
1719: directories with version numbers attached to it, they just exist for
1720: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1721: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1722: <p>In this directory, you often find a file called
1723: <code class="filename">bootstrap.tar.gz</code> which contains the package
1724: management tools. If the file is missing, it is likely that your
1725: operating system already provides those tools. Download the file and
1726: extract it in the <code class="filename">/</code> directory. It will create
1727: the directories <code class="filename">/usr/pkg</code> (containing the tools
1728: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1729: (the database of installed packages).</p>
1.1 dsieger 1730: </div>
1.41 asau 1731: <div class="sect2">
1.1 dsieger 1732: <div class="titlepage"><div><div><h3 class="title">
1733: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1734: <p>In the directory from the last section, there is a
1735: subdirectory called <code class="filename">All</code>, which contains all the
1736: binary packages that are available for the platform, excluding those
1737: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1738: medium you are using).</p>
1.9 rillig 1739: <p>To install packages directly from an FTP or HTTP server, run
1740: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1741: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1742: <pre class="screen">
1743: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1744: <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>
1745: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1746: </pre>
1747: <p>Instead of URLs, you can also use local paths, for example if
1748: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1749: repository. If you want to install packages from multiple sources,
1750: you can separate them by a semicolon in
1751: <code class="varname">PKG_PATH</code>.</p>
1752: <p>After these preparations, installing a package is very
1753: easy:</p>
1754: <pre class="screen">
1755: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1756: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1757: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1758: </pre>
1.1 dsieger 1759: <p>Note that any prerequisite packages needed to run the
1760: package in question will be installed, too, assuming they are
1761: present where you install from.</p>
1.23 wiz 1762: <p>Adding packages might install vulnerable packages.
1763: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1764: regularly, especially after installing new packages, and verify
1765: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1766: <p>After you've installed packages, be sure to have
1767: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1768: <code class="varname">PATH</code> so you can actually start the just
1769: installed program.</p>
1770: </div>
1.41 asau 1771: <div class="sect2">
1.1 dsieger 1772: <div class="titlepage"><div><div><h3 class="title">
1773: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1774: <p>To deinstall a package, it does not matter whether it was
1775: installed from source code or from a binary package. The
1.10 hubertf 1776: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1777: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1778: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1779: name can be given with or without version number. Wildcards can
1780: also be used to deinstall a set of packages, for example
1781: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1782: so that the shell does not expand them before
1783: <code class="literal">pkg_delete</code> sees them.</p>
1784: <p>The <code class="option">-r</code> option is very powerful: it
1785: removes all the packages that require the package in question
1786: and then removes the package itself. For example:
1787:
1788: </p>
1789: <pre class="screen">
1790: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1791: </pre>
1792: <p>
1793:
1794: will remove jpeg and all the packages that used it; this allows
1795: upgrading the jpeg package.</p>
1796: </div>
1.41 asau 1797: <div class="sect2">
1.1 dsieger 1798: <div class="titlepage"><div><div><h3 class="title">
1799: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1800: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1801: installed packages or binary package files.</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="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1806: <p>
1807: The NetBSD Security-Officer and Packages Groups maintain a list of
1808: known security vulnerabilities to packages which are (or have been)
1809: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1810: 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 1811: </p>
1812: <p>
1.22 jakllsch 1813: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1814: this list can be downloaded
1815: automatically, and a security audit of all packages installed on a system
1816: can take place.
1817: </p>
1818: <p>
1.22 jakllsch 1819: There are two components to auditing. The first
1820: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1821: is for downloading
1.1 dsieger 1822: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1823: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1824: installed packages are vulnerable. If a package is vulnerable, you
1825: will see output similar to the following:
1826: </p>
1827: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1828: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1829: <p>
1.22 jakllsch 1830: You may wish to have the
1.10 hubertf 1831: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1832: file downloaded daily so that
1833: it remains current. This may be done by adding an appropriate entry
1.29 dholland 1834: 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 1835: </p>
1836: <pre class="screen">
1837: # download vulnerabilities file
1838: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1839: </pre>
1840: <p>
1841: will update the vulnerability list every day at 3AM. You may wish to do
1842: this more often than once a day.
1843:
1844: In addition, you may wish to run the package audit from the daily
1845: security script. This may be accomplished by adding the following
1846: line to <code class="filename">/etc/security.local</code>:
1847: </p>
1848: <pre class="screen">
1849: /usr/sbin/pkg_admin audit
1850: </pre>
1851: <p>
1.1 dsieger 1852: </p>
1853: </div>
1.41 asau 1854: <div class="sect2">
1.1 dsieger 1855: <div class="titlepage"><div><div><h3 class="title">
1856: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1857: <p>
1.12 weinem 1858: 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 1859: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1860: argument to check if your packages are up-to-date, e.g.
1861: </p>
1862: <pre class="screen">
1863: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1864: ...
1865: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1866: </pre>
1.10 hubertf 1867: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1868: package on your system and rebuild any dependencies.
1869: </p>
1870: </div>
1.41 asau 1871: <div class="sect2">
1.1 dsieger 1872: <div class="titlepage"><div><div><h3 class="title">
1873: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1874: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1875: administrative functions on the package system.</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="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1880: <p>Please pay very careful attention to the warnings
1.29 dholland 1881: 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 1882: inherent dangers of installing binary packages which you did
1883: not create yourself, and the security holes that can be
1884: introduced onto your system by indiscriminate adding of such
1885: files.</p>
1886: <p>The same warning of course applies to every package you
1887: install from source when you haven't completely read and
1888: understood the source code of the package, the compiler that
1889: is used to build the package and all the other tools that are
1890: involved.</p>
1891: </div>
1892: </div>
1.41 asau 1893: <div class="sect1">
1.1 dsieger 1894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1895: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1896: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1897: directory now contains a set of packages, organized into
1898: categories. You can browse the online index of packages, or run
1.10 hubertf 1899: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1900: directory to build local <code class="filename">README.html</code> files for
1901: 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>
1902: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1903: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1904: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1905: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1906: different <code class="varname">LOCALBASE</code> definitions on the same
1907: system (inside a chroot is an exception). </p>
1908: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1909: 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 1910: instructions how to create your own packages.</p>
1.41 asau 1911: <div class="sect2">
1.1 dsieger 1912: <div class="titlepage"><div><div><h3 class="title">
1913: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1914: <p>To build packages from source, you need a working C
1915: compiler. On NetBSD, you need to install the
1.23 wiz 1916: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1917: sets. If you want to build X11-related packages, the
1.23 wiz 1918: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1919: sets are required, too.</p>
1920: </div>
1.41 asau 1921: <div class="sect2">
1.1 dsieger 1922: <div class="titlepage"><div><div><h3 class="title">
1923: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1924: <p>The first step for building a package is downloading the
1925: distfiles (i.e. the unmodified source). If they have not yet been
1926: downloaded, pkgsrc will fetch them automatically.</p>
1927: <p>If you have all files that you need in the
1928: <code class="filename">distfiles</code> directory,
1929: you don't need to connect. If the distfiles are on CD-ROM, you can
1930: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1931: </p>
1932: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1933: <p>
1.10 hubertf 1934: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1935: <p>By default a list of distribution sites will be randomly
1936: intermixed to prevent huge load on servers which holding popular
1937: packages (for example, SourceForge.net mirrors). Thus, every
1938: time when you need to fetch yet another distfile all the mirrors
1939: will be tried in new (random) order. You can turn this feature
1940: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1941: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1942: <p>You can overwrite some of the major distribution sites to
1943: fit to sites that are close to your own. By setting one or two
1944: variables you can modify the order in which the master sites are
1945: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1946: delimited list of domain suffixes.
1947: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1948: contains a whitespace delimited list of regular expressions. It
1949: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1950: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1951: some examples. This may save some of your bandwidth and
1952: time.</p>
1953: <p>You can change these settings either in your shell's environment, or,
1954: if you want to keep the settings, by editing the
1.10 hubertf 1955: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1956: and adding the definitions there.</p>
1957: <p>
1958: If a package depends on many other packages (such as
1959: <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
1960: alternate between periods of
1961: downloading source, and compiling. To ensure you have all the source
1962: downloaded initially you can run the command:
1963: </p>
1964: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1965: <p>
1966: which will output and run a set of shell commands to fetch the
1967: necessary files into the <code class="filename">distfiles</code> directory. You can
1968: also choose to download the files manually.
1969: </p>
1970: </div>
1.41 asau 1971: <div class="sect2">
1.1 dsieger 1972: <div class="titlepage"><div><div><h3 class="title">
1973: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1974: <p>
1975: Once the software has downloaded, any patches will be applied, then it
1976: will be compiled for you. This may take some time depending on your
1977: computer, and how many other packages the software depends on and their
1978: compile time.
1979: </p>
1.41 asau 1980: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1981: <h3 class="title">Note</h3>
1982: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1983: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1984: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1985: </div>
1986: <p>For example, type</p>
1987: <pre class="screen">
1988: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1989: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1990: </pre>
1991: <p>at the shell prompt to build the various components of the
1992: package.</p>
1993: <p>The next stage is to actually install the newly compiled
1994: program onto your system. Do this by entering:
1995:
1996: </p>
1997: <pre class="screen">
1998: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1999: </pre>
2000: <p>
2001:
2002: while you are still in the directory for whatever package you
2003: are installing.</p>
2004: <p>Installing the package on your system may require you to
2005: be root. However, pkgsrc has a
2006: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2007: to only become root for the actual installation step.</p>
2008: <p>That's it, the software should now be installed and setup for use.
2009: You can now enter:
2010:
2011: </p>
2012: <pre class="screen">
2013: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2014: </pre>
2015: <p>
2016:
2017: to remove the compiled files in the work directory, as you shouldn't need
2018: them any more. If other packages were also added to your system
2019: (dependencies) to allow your program to compile, you can tidy these up
2020: also with the command:</p>
2021: <pre class="screen">
2022: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2023: </pre>
2024: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 2025: 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 2026: <p>The program is installed under the default root of the
2027: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2028: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2029: variable in your environment, and it will use that value as the
2030: root of your packages tree. So, to use
2031: <code class="filename">/usr/local</code>, set
2032: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2033: Please note that you should use a directory which is dedicated to
2034: packages and not shared with other programs (i.e., do not try and
2035: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2036: to add any of your own files or directories (such as
2037: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2038: <code class="filename">pkgsrc/</code>) below the
2039: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2040: conflicts between programs and other files installed by the
2041: package system and whatever else may have been installed
2042: there.</p>
1.10 hubertf 2043: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2044: alter some configuration options at build time. Have a look at
2045: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2046: of what will be set there by default. Environment variables such
2047: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 2048: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2049: set them each time you want to use pkgsrc.</p>
1.23 wiz 2050: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2051: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 2052: or being installed. This may be for debugging purposes, or out of
2053: simple curiosity. A number of utility values have been added to
2054: help with this.</p>
1.23 wiz 2055: <div class="orderedlist"><ol class="orderedlist" type="1">
2056: <li class="listitem">
1.29 dholland 2057: <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 2058: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2059: information will be displayed. For example,</p>
2060: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2061: <p>will show all the commands that are invoked, up to and
1.23 wiz 2062: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 2063: </li>
1.23 wiz 2064: <li class="listitem">
1.29 dholland 2065: <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 2066: definition, then the <code class="varname">VARNAME</code> definition
2067: should be used, in conjunction with the show-var
1.29 dholland 2068: 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 2069: variable <code class="varname">LOCALBASE</code>:</p>
2070: <pre class="screen">
2071: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2072: /usr/pkg
2073: <code class="prompt">%</code>
2074: </pre>
2075: </li>
2076: </ol></div>
2077: <p>If you want to install a binary package that you've either
2078: created yourself (see next section), that you put into
2079: pkgsrc/packages manually or that is located on a remote FTP
2080: server, you can use the "bin-install" target. This target will
1.29 dholland 2081: 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 2082: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 2083: sites searched is kept in the variable
2084: <code class="varname">BINPKG_SITES</code>, which defaults to
1.29 dholland 2085: 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 2086: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2087: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2088: details.</p>
2089: <p>A final word of warning: If you set up a system that has a
2090: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2091: set that before any packages are installed, as you cannot use
2092: several directories for the same purpose. Doing so will result in
2093: pkgsrc not being able to properly detect your installed packages,
2094: and fail miserably. Note also that precompiled binary packages are
2095: usually built with the default <code class="varname">LOCALBASE</code> of
2096: <code class="filename">/usr/pkg</code>, and that you should
2097: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2098: <code class="varname">LOCALBASE</code>.</p>
2099: </div>
2100: </div>
2101: </div>
1.41 asau 2102: <div class="chapter">
1.1 dsieger 2103: <div class="titlepage"><div><div><h2 class="title">
2104: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2105: <div class="toc">
2106: <p><b>Table of Contents</b></p>
2107: <dl>
2108: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2109: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 2110: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 2111: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2112: <dd><dl>
1.4 rillig 2113: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 2114: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2115: <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 2116: </dl></dd>
1.4 rillig 2117: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2118: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2119: </dl>
2120: </div>
1.4 rillig 2121: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2122: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2123: that file depends on the installation. On NetBSD, when you use
1.29 dholland 2124: <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 2125: <code class="filename">/etc/</code>. In all other cases the default location is
2126: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2127: bootstrap program to install the binary packages.</p>
2128: <p>During the bootstrap, an example configuration file is created. To
2129: use that, you have to create the directory
2130: <code class="filename">${PREFIX}/etc</code> and copy the example file
2131: there.</p>
2132: <p>The format of the configuration file is that of the usual
2133: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2134: is done by setting variables in this file. Note that you can define all
2135: kinds of variables, and no special error checking (for example for
2136: spelling mistakes) takes place, so you have to try it out to see if it
2137: works.</p>
1.41 asau 2138: <div class="sect1">
1.1 dsieger 2139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2140: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2141: <p>In this section, you can find some variables that apply to all
2142: pkgsrc packages. A complete list of the variables that can be
2143: configured by the user is available in
2144: <code class="filename">mk/defaults/mk.conf</code>, together with some
2145: comments that describe each variable's intent.</p>
1.41 asau 2146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2147: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 2148: packages will be installed. The default is
2149: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2150: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 2151: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2152: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 2153: installed. The default is
2154: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 2155: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 2156: X11 is installed on the system. The default is
2157: <code class="filename">/usr/X11R6</code>.</p></li>
1.23 wiz 2158: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 2159: downloaded copies of the original source distributions used
2160: for building pkgsrc packages. The default is
2161: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 2162: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 2163: database about installed packages is stored. The default is
2164: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 2165: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 2166: If set, override the packages'
2167: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 2168: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 2169: Backup location(s) for distribution files and patch files
2170: if not found locally or in
2171: <code class="filename">${MASTER_SITES}</code> or
2172: <code class="filename">${PATCH_SITES}</code> respectively.
2173: The defaults are
1.25 spz 2174: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 2175: and
2176: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 2177: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 2178: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2179: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 2180: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2181: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2182: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 2183: List of acceptable licenses. License names are case-sensitive.
2184: Whenever you try to build a package whose license is not in this
2185: list, you will get an error message. If the license condition is
2186: simple enough, the error message will include specific
2187: instructions on how to change this variable.</p></li>
1.1 dsieger 2188: </ul></div>
2189: </div>
1.41 asau 2190: <div class="sect1">
1.1 dsieger 2191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2192: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2193: <p>XXX
2194: </p>
1.41 asau 2195: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2196: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 2197: directory for the binary packages. The default is
2198: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 2199: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 2200: The top level directory where, if defined, the separate
2201: working directories will get created, and symbolically
2202: linked to from <code class="filename">${WRKDIR}</code> (see below).
2203: This is useful for building packages on several
2204: architectures, then <code class="filename">${PKGSRCDIR}</code>
2205: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2206: is local to every architecture. (It should be noted that
2207: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 2208: — it is an internal definition which refers to the
1.1 dsieger 2209: root of the pkgsrc tree. It is possible to have many
2210: pkgsrc tree instances.)</p></li>
1.23 wiz 2211: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 2212: Directory for local patches that aren't part of pkgsrc.
1.10 hubertf 2213: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2214: information.</p></li>
1.23 wiz 2215: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 2216: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2217: BSD-style Makefile. If this is not set,
2218: <code class="varname">MAKECONF</code> is set to
2219: <code class="filename">/dev/null</code> to avoid picking up
2220: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 2221: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 2222: By default, dependencies are only installed, and no binary
2223: package is created for them. You can set this variable to
1.66 asau 2224: <code class="literal">package-install</code> to automatically create binary
1.1 dsieger 2225: packages after installing dependencies.</p></li>
2226: </ul></div>
2227: </div>
1.41 asau 2228: <div class="sect1">
1.1 dsieger 2229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 2230: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24 wiz 2231: <p>Most packages support installation into a
1.4 rillig 2232: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2233: to be built, before the actual filesystem is touched. DESTDIR
2234: support exists in two variations:</p>
1.41 asau 2235: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2236: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 2237: installation and packaging is still run as root.</p></li>
2238: <li class="listitem"><p>Full DESTDIR support can run the complete
2239: build, installation and packaging as normal user. Root
2240: privileges are only needed to add packages.</p></li>
2241: </ul></div>
2242: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2243: you can set
2244: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2245: so it's preferable to convert a package to DESTDIR instead.</p>
1.4 rillig 2246: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2247: clean</code></strong> needs to be run as root.</p>
1.17 imil 2248: <p>Considering the <code class="filename">foo/bar</code> package,
2249: DESTDIR full support can be tested using the following commands
2250:
2251: </p>
2252: <pre class="programlisting">
2253: <code class="prompt">$</code> id
2254: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2255: <code class="prompt">$</code> mkdir $HOME/packages
2256: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2257: </pre>
2258: <p>
2259:
2260: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2261: should be needed
2262:
2263: </p>
2264: <pre class="programlisting">
1.66 asau 2265: <code class="prompt">$</code> make stage-install
1.17 imil 2266: </pre>
2267: <p>
2268:
2269: Create a package without root privileges
2270:
2271: </p>
2272: <pre class="programlisting">
1.66 asau 2273: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 2274: </pre>
2275: <p>
2276:
2277: For the following command, you must be able to gain root
1.29 dholland 2278: 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 2279:
2280: </p>
2281: <pre class="programlisting">
1.66 asau 2282: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 2283: </pre>
2284: <p>
2285:
2286: Then, as a simple user
2287:
2288: </p>
2289: <pre class="programlisting">
2290: <code class="prompt">$</code> make clean
2291: </pre>
2292: <p>
2293:
2294: </p>
1.4 rillig 2295: </div>
1.41 asau 2296: <div class="sect1">
1.4 rillig 2297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2298: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 2299: <div class="sect2">
1.1 dsieger 2300: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2301: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2302: <p>By default, pkgsrc will use GCC to build packages. This may be
2303: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 2304: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2305: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2306: <dd>
2307: <p>This is a list of values specifying the chain of
2308: compilers to invoke when building packages. Valid values
2309: are:</p>
1.41 asau 2310: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 2311: <li class="listitem"><p><code class="varname">ccc</code>:
2312: Compaq C Compilers (Tru64)</p></li>
2313: <li class="listitem"><p><code class="varname">ccache</code>:
2314: compiler cache (chainable)</p></li>
2315: <li class="listitem"><p><code class="varname">clang</code>:
2316: Clang C and Objective-C compiler</p></li>
1.23 wiz 2317: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 2318: distributed C/C++ (chainable)</p></li>
1.66 asau 2319: <li class="listitem"><p><code class="varname">f2c</code>:
2320: Fortran 77 to C compiler (chainable)</p></li>
2321: <li class="listitem"><p><code class="varname">icc</code>:
2322: Intel C++ Compiler (Linux)</p></li>
2323: <li class="listitem"><p><code class="varname">ido</code>:
2324: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 2325: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 2326: GNU C/C++ Compiler</p></li>
1.66 asau 2327: <li class="listitem"><p><code class="varname">hp</code>:
2328: HP-UX C/aC++ compilers</p></li>
1.23 wiz 2329: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2330: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 2331: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 2332: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 2333: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 2334: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 2335: <li class="listitem"><p><code class="varname">xlc</code>:
2336: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 2337: </ul></div>
2338: <p>The default is
1.23 wiz 2339: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 2340: <code class="varname">ccache</code> and/or
2341: <code class="varname">distcc</code> with an appropriate
2342: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 2343: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 2344: variable should always be terminated with a value for
2345: a real compiler. Note that only one real compiler
1.23 wiz 2346: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 2347: is not allowed).</p>
2348: </dd>
2349: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2350: <dd><p>This specifies the minimum version of GCC to use
2351: when building packages. If the system GCC doesn't
2352: satisfy this requirement, then pkgsrc will build and
2353: install one of the GCC packages to use instead.</p></dd>
2354: </dl></div>
2355: </div>
1.41 asau 2356: <div class="sect2">
1.1 dsieger 2357: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2358: <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 2359: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2360: please make sure to use the <code class="literal">+=</code> operator
2361: instead of the <code class="literal">=</code> operator:</p>
2362: <pre class="programlisting">
2363: CFLAGS+= -your -flags
2364: </pre>
2365: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2366: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2367: need to add their own flags. You may want to take a look
2368: 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 2369: package if you're interested in optimization specifically
2370: for the current CPU. </p>
1.1 dsieger 2371: </div>
1.41 asau 2372: <div class="sect2">
1.1 dsieger 2373: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2374: <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 2375: <p>If you want to pass flags to the linker, both in the configure
2376: step and the build step, you can do this in two ways. Either set
2377: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2378: between the two is that <code class="varname">LIBS</code> will be appended to
2379: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2380: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2381: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2382: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2383: <code class="varname">CFLAGS</code>, if you do not wish to override these
2384: settings, use the <code class="literal">+=</code> operator:</p>
2385: <pre class="programlisting">
2386: LDFLAGS+= -your -linkerflags
2387: </pre>
2388: </div>
2389: </div>
1.41 asau 2390: <div class="sect1">
1.1 dsieger 2391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2392: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 2393: <p>XXX
2394: </p>
1.41 asau 2395: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2396: <li class="listitem">
1.1 dsieger 2397: <p><code class="varname">PKG_DEVELOPER</code>:
2398: Run some sanity checks that package developers want:
2399: </p>
1.41 asau 2400: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2401: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 2402: fuzz</p></li>
1.23 wiz 2403: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 2404: binaries will find their shared libs.</p></li>
2405: </ul></div>
2406: <p>
2407: </p>
2408: </li>
1.23 wiz 2409: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 2410: of debugging output which is displayed whilst making and
2411: installing the package. The default value for this is 0,
2412: which will not display the commands as they are executed
2413: (normal, default, quiet operation); the value 1 will display
2414: all shell commands before their invocation, and the value 2
2415: will display both the shell commands before their invocation,
1.10 hubertf 2416: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 2417: -x</strong></span> will be displayed.</p></li>
2418: </ul></div>
2419: <p>
2420: </p>
2421: </div>
1.41 asau 2422: <div class="sect1">
1.1 dsieger 2423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2424: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2425: <p>Some packages have build time options, usually to select
2426: between different dependencies, enable optional support for big
2427: dependencies or enable experimental features.</p>
2428: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2429: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2430: show-options</strong></span>, for example:</p>
2431: <pre class="programlisting">
2432: The following options are supported by this package:
2433: ssl Enable SSL support.
2434: Exactly one of the following gecko options is required:
2435: firefox Use firefox as gecko rendering engine.
2436: mozilla Use mozilla as gecko rendering engine.
2437: At most one of the following database options may be selected:
2438: mysql Enable support for MySQL database.
2439: pgsql Enable support for PostgreSQL database.
2440:
2441: These options are enabled by default: firefox
2442: These options are currently enabled: mozilla ssl
2443: </pre>
2444: <p>The following variables can be defined in
1.10 hubertf 2445: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2446: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2447: which can be used to select or disable options for all packages
2448: that support them, and
2449: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2450: which can be used to select or disable options specifically for
2451: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2452: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2453: are disabled. A few examples:</p>
2454: <pre class="screen">
1.10 hubertf 2455: <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 2456: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2457: PKG_OPTIONS.kdebase= debug -sasl
2458: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2459: <p>It is important to note that options that were specifically
1.18 snj 2460: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2461: you do not wish to include the option. If you are unsure you can view
2462: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2463: <p>The following settings are consulted in the order given, and
2464: the last setting that selects or disables an option is
2465: used:</p>
1.23 wiz 2466: <div class="orderedlist"><ol class="orderedlist" type="1">
2467: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2468: maintainer</p></li>
1.23 wiz 2469: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2470: variables (see below)</p></li>
1.23 wiz 2471: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2472: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2473: </ol></div>
2474: <p>For groups of mutually exclusive options, the last option
2475: selected is used, all others are automatically disabled. If an
2476: option of the group is explicitly disabled, the previously
2477: selected option, if any, is used. It is an error if no option
2478: from a required group of options is selected, and building the
2479: package will fail.</p>
2480: <p>Before the options framework was introduced, build options
2481: were selected by setting a variable (often named
2482: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2483: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2484: transition to the options framework for the user, these legacy
2485: variables are converted to the appropriate options setting
2486: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2487: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2488: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2489: directly. Support for the legacy variables will be removed
2490: eventually.</p>
2491: </div>
2492: </div>
1.41 asau 2493: <div class="chapter">
1.1 dsieger 2494: <div class="titlepage"><div><div><h2 class="title">
2495: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2496: <div class="toc">
2497: <p><b>Table of Contents</b></p>
2498: <dl>
2499: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2500: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2501: </dl>
2502: </div>
1.41 asau 2503: <div class="sect1">
1.1 dsieger 2504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2505: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2506: <p>Once you have built and installed a package, you can create
2507: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.29 dholland 2508: 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 2509: the same package on a group of hosts and wasting CPU time. It also
2510: provides a simple means for others to install your package, should
2511: you distribute it.</p>
2512: <p>To create a binary package, change into the appropriate
1.10 hubertf 2513: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2514: package</strong></span>:</p>
2515: <pre class="screen">
2516: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2517: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2518: </pre>
2519: <p>This will build and install your package (if not already done),
2520: and then build a binary package from what was installed. You can
1.10 hubertf 2521: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2522: it. Binary packages are created by default in
2523: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2524: 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 2525: 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 2526: <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 2527: such a binary package.</p>
2528: </div>
1.41 asau 2529: <div class="sect1">
1.1 dsieger 2530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2531: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2532: <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 2533: </div>
2534: </div>
1.41 asau 2535: <div class="chapter">
1.6 rillig 2536: <div class="titlepage"><div><div><h2 class="title">
2537: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2538: builds)</h2></div></div></div>
2539: <div class="toc">
2540: <p><b>Table of Contents</b></p>
2541: <dl>
1.71 wiz 2542: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
2543: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
2544: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
2545: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66 asau 2546: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2547: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2548: </dl>
2549: </div>
1.71 wiz 2550: <p>For a number of reasons you may want to build binary packages
2551: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2552: For instance, when you have multiple machines that should run the same software,
2553: it is wasted time if they all build their packages themselves from source.
2554: Or you may want to build a list of packages you want and check them before
2555: deploying onto production system.
2556: There is a way of getting a set of binary packages:
1.66 asau 2557: The bulk build system, or pbulk ("p" stands for "parallel).
2558: This chapter describes how to set it up so that the packages
1.6 rillig 2559: are most likely to be usable later.</p>
1.41 asau 2560: <div class="sect1">
1.6 rillig 2561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2562: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
2563: <p>First of all, you have to decide whether you build all packages
2564: or a limited set of them. Full bulk builds usually consume a lot more resources,
2565: both space and time, than builds for some practical sets of packages.
2566: There exists a number of particularly heavy packages that are not actually
2567: interesting to a wide audience.
2568:
2569: For a limited bulk builds you need to make a list of packages you want to build.
2570: Note, that all their dependencies will be built, so you don't need to track them manually.
2571: </p>
2572: <p>During bulk builds various packages are installed and deinstalled
2573: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2574: so make sure that you don't need any package during the builds.
2575: Essentially, you should provide fresh system, either a chroot environment
2576: or something even more restrictive, depending on what the operating system provides,
2577: or dedicate the whole physical machine.
2578: As a useful side effect this makes sure that bulk builds cannot
2579: break anything in your system. There have been numerous cases where
1.6 rillig 2580: certain packages tried to install files outside the
2581: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2582: <code class="filename">/etc</code>.
2583: </p>
1.6 rillig 2584: </div>
1.41 asau 2585: <div class="sect1">
1.6 rillig 2586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2587: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2588: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2589: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2590: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2591: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2592: </ul></div>
1.41 asau 2593: <div class="sect2">
1.15 rillig 2594: <div class="titlepage"><div><div><h3 class="title">
1.71 wiz 2595: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.68 asau 2596: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
2597: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2598: Configure network access to fetch distribution files.
2599: Create user with name "pbulk".</p>
2600: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2601: <pre class="screen">
1.72 wiz 2602: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && ftp -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2603: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2604: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68 asau 2605: </pre>
2606: <p>Or any other way that fits (e.g., curl, wget).</p>
2607: <p>Deploy and configure pbulk tools, e.g.:</p>
2608: <pre class="screen">
2609: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
2610: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
2611: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2612: </pre>
2613: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2614: <h3 class="title">Note</h3>
2615: <p><code class="filename">mk.conf.frag</code> is a fragment of
2616: <code class="filename">mk.conf</code> that contains settings you want to
2617: apply to packages you build. For instance,</p>
2618: <pre class="programlisting">
2619: PKG_DEVELOPER= yes # perform more checks
2620: X11_TYPE= modular # use pkgsrc X11
2621: SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
2622: </pre>
2623: </div>
2624: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
2625: with your list of packages one per line without empty lines or comments. E.g.:</p>
2626: <pre class="programlisting">
2627: www/firefox
2628: mail/thunderbird
2629: misc/libreoffice4
2630: </pre>
1.69 asau 2631: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2632: and make final amendments, if wanted.</p>
1.68 asau 2633: <p>Start it:</p>
2634: <pre class="screen">
2635: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2636: </pre>
2637: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2638: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2639: </p>
2640: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2641: <h3 class="title">Note</h3>
2642: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2643: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2644: The script is kept small enough for better understanding.</p>
2645: </div>
2646: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2647: <h3 class="title">Note</h3>
2648: <p>The <code class="filename">pbulk.sh</code> script supports running
2649: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2650: </div>
1.6 rillig 2651: </div>
2652: </div>
1.41 asau 2653: <div class="sect1">
1.6 rillig 2654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71 wiz 2655: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
2656: <p>A complete bulk build requires lots of disk space. Some of the
2657: disk space can be read-only, some other must be writable. Some can be on
2658: remote filesystems (such as NFS) and some should be local. Some can be
2659: temporary filesystems, others must survive a sudden reboot.</p>
2660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2661: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2662: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2663: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2664: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2665: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2666: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2667: </ul></div>
2668: </div>
2669: <div class="sect1">
2670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66 asau 2671: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2672: <p>After your pkgsrc bulk-build has completed, you may wish to
2673: create a CD-ROM set of the resulting binary packages to assist
2674: in installing packages on other machines. The
2675: <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
2676: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2677: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2678: way that keeps all the dependencies for a given package on the same
2679: CD as that package.</p>
1.41 asau 2680: <div class="sect2">
1.1 dsieger 2681: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 2682: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2683: <p>Complete documentation for cdpack is found in the cdpack(1)
2684: man page. The following short example assumes that the binary
2685: packages are left in
2686: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2687: sufficient disk space exists in <code class="filename">/u2</code> to
2688: hold the ISO 9660 images.</p>
2689: <pre class="screen">
2690: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2691: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2692: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2693: </pre>
2694: <p>If you wish to include a common set of files
2695: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2696: etc.) on each CD in the collection, then you need to create a
2697: directory which contains these files. e.g.</p>
2698: <pre class="screen">
2699: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2700: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2701: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2702: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2703: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2704: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2705: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2706: </pre>
2707: <p>Now create the images:</p>
2708: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2709: <p>Each image will contain <code class="filename">README</code>,
2710: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2711: in their root directories.</p>
2712: </div>
2713: </div>
2714: </div>
1.41 asau 2715: <div class="chapter">
1.1 dsieger 2716: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2717: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2718: <div class="toc">
2719: <p><b>Table of Contents</b></p>
2720: <dl>
1.23 wiz 2721: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2722: <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 2723: </dl>
2724: </div>
2725: <p>The files that are installed by pkgsrc are organized in a way that
2726: is similar to what you find in the <code class="filename">/usr</code> directory
2727: of the base system. But some details are different. This is because
2728: pkgsrc initially came from FreeBSD and had adopted its file system
2729: hierarchy. Later it was largely influenced by NetBSD. But no matter
2730: which operating system you are using pkgsrc with, you can expect the
2731: same layout for pkgsrc.</p>
2732: <p>There are mainly four root directories for pkgsrc, which are all
2733: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2734: When pkgsrc has been installed as root, the default locations
2735: are:</p>
2736: <pre class="programlisting">
2737: LOCALBASE= /usr/pkg
2738: PKG_SYSCONFBASE= /usr/pkg/etc
2739: VARBASE= /var
2740: PKG_DBDIR= /var/db/pkg
2741: </pre>
2742: <p>In unprivileged mode (when pkgsrc has been installed as any other
2743: user), the default locations are:</p>
2744: <pre class="programlisting">
2745: LOCALBASE= ${HOME}/pkg
2746: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2747: VARBASE= ${HOME}/pkg/var
2748: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2749: </pre>
2750: <p>What these four directories are for, and what they look like is
2751: explained below.</p>
1.41 asau 2752: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2753: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2754: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2755: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2756: the well-known subdirectories like <code class="filename">bin</code>,
2757: <code class="filename">include</code>, <code class="filename">lib</code>,
2758: <code class="filename">share</code> and
2759: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2760: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2761: <code class="filename">/var</code> in the base system. Some programs (especially
2762: games, network daemons) need write access to it during normal
2763: operation.</p></li>
1.23 wiz 2764: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2765: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2766: 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 2767: itself.</p></li>
2768: </ul></div>
1.41 asau 2769: <div class="sect1">
1.1 dsieger 2770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2771: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2772: </h2></div></div></div>
2773: <p>The following directories exist in a typical pkgsrc installation
2774: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2775: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2776: <dt><span class="term"><code class="filename">bin</code></span></dt>
2777: <dd><p>Contains executable programs that are intended to be
2778: directly used by the end user.</p></dd>
2779: <dt><span class="term"><code class="filename">emul</code></span></dt>
2780: <dd><p>Contains files for the emulation layers of various other
2781: operating systems, especially for
2782: NetBSD.</p></dd>
2783: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2784: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2785: <dd><p>Contains
2786: the configuration files.</p></dd>
2787: <dt><span class="term"><code class="filename">include</code></span></dt>
2788: <dd><p>Contains headers for the C and C++ programming
2789: languages.</p></dd>
2790: <dt><span class="term"><code class="filename">info</code></span></dt>
2791: <dd><p>Contains GNU info files of various
2792: packages.</p></dd>
2793: <dt><span class="term"><code class="filename">lib</code></span></dt>
2794: <dd><p>Contains shared and static
2795: libraries.</p></dd>
2796: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2797: <dd><p>Contains data files that don't change after
2798: installation. Other data files belong into
2799: <code class="filename">${VARBASE}</code>.</p></dd>
2800: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2801: <dd><p>Contains programs that are not intended to be used by
2802: end users, such as helper programs or network
2803: daemons.</p></dd>
2804: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2805: <dd><p>Contains programs that are intended to be executed as
2806: CGI scripts by a web server.</p></dd>
2807: <dt><span class="term"><code class="filename">man</code> (the usual value of
2808: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2809: <dd><p>Contains brief
2810: documentation in form of manual pages.</p></dd>
2811: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2812: <dd><p>Contains programs that are intended to be used only by
2813: the super-user.</p></dd>
2814: <dt><span class="term"><code class="filename">share</code></span></dt>
2815: <dd><p>Contains platform-independent data files that don't
2816: change after installation.</p></dd>
2817: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2818: <dd><p>Contains documentation files provided by the
2819: packages.</p></dd>
2820: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2821: <dd><p>Contains example files provided by the packages. Among
2822: others, the original configuration files are saved here and copied to
2823: <code class="filename">${PKG_SYSCONFDIR}</code> during
2824: installation.</p></dd>
2825: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2826: <dd><p>Contains the original files for rc.d
2827: scripts.</p></dd>
2828: <dt><span class="term"><code class="filename">var</code> (the usual location of
2829: <code class="filename">${VARBASE}</code>)</span></dt>
2830: <dd><p>Contains files
2831: that may be modified after
2832: installation.</p></dd>
2833: </dl></div>
2834: </div>
1.41 asau 2835: <div class="sect1">
1.1 dsieger 2836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2837: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2838: </h2></div></div></div>
1.41 asau 2839: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2840: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2841: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2842: <dd><p>Contains
2843: information about the currently installed
2844: packages.</p></dd>
2845: <dt><span class="term"><code class="filename">games</code></span></dt>
2846: <dd><p>Contains highscore
2847: files.</p></dd>
2848: <dt><span class="term"><code class="filename">log</code></span></dt>
2849: <dd><p>Contains log files.</p></dd>
2850: <dt><span class="term"><code class="filename">run</code></span></dt>
2851: <dd><p>Contains informational files about daemons that are
2852: currently running.</p></dd>
2853: </dl></div>
2854: </div>
2855: </div>
1.41 asau 2856: <div class="chapter">
1.1 dsieger 2857: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2858: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2859: <div class="toc">
2860: <p><b>Table of Contents</b></p>
2861: <dl>
1.6 rillig 2862: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2863: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
2864: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
2865: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
2866: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
2867: <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>
2868: <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 2869: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
2870: <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>
2871: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
2872: <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 2873: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.65 wiz 2874: <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>
2875: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
2876: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
2877: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
2878: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2879: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build. What shall I do?</a></span></dt>
2880: <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 2881: </dl>
2882: </div>
2883: <p>This section contains hints, tips & tricks on special things in
2884: pkgsrc that we didn't find a better place for in the previous chapters, and
2885: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2886: <div class="sect1">
1.1 dsieger 2887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2888: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2889: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2890: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2891: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 2892: This is a general purpose list for most issues regarding
2893: pkgsrc, regardless of platform, e.g. soliciting user help
2894: for pkgsrc configuration, unexpected build failures, using
2895: particular packages, upgrading pkgsrc installations,
2896: questions regarding the pkgsrc release branches, etc. General announcements or
2897: proposals for changes that impact the pkgsrc user community,
2898: e.g. major infrastructure changes, new features, package
2899: removals, etc., may also be posted.</p></li>
1.23 wiz 2900: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2901: A list where the results of pkgsrc bulk builds are sent and
2902: discussed.</p></li>
1.23 wiz 2903: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2904: This list is for those who are interested in getting a
2905: commit message for every change committed to pkgsrc. It is
2906: also available in digest form, meaning one daily message
2907: containing all commit messages for changes to the package
2908: source tree in that 24 hour period.</p></li>
2909: </ul></div>
2910: <p>To subscribe, do:</p>
2911: <pre class="programlisting">
2912: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2913: </pre>
2914: <p>Archives for all these mailing lists are available from
1.10 hubertf 2915: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2916: </div>
1.41 asau 2917: <div class="sect1">
1.1 dsieger 2918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2919: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1 dsieger 2920: <p>Pkgviews is tightly integrated with buildlink. You can find a
2921: pkgviews User's guide in
2922: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
2923: </div>
1.41 asau 2924: <div class="sect1">
1.1 dsieger 2925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2926: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2927: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2928: a number of useful utilities for both users and developers of pkgsrc. This
2929: section attempts only to make the reader aware of the utilities and when
2930: they might be useful, and not to duplicate the documentation that comes
2931: with each package.</p>
2932: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.41 asau 2933: <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 2934: Symlinks for use by buildlink.</p></li></ul></div>
2935: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2936: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2937: <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 2938: Calculates various kinds of checksums (including SHA1).</p></li>
1.23 wiz 2939: <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 2940: Compatibility library for pkgsrc tools.</p></li>
1.23 wiz 2941: <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 2942: non-BSD systems due to lack of native mtree.</p></li>
1.23 wiz 2943: <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 2944: Up-to-date replacement for
2945: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2946: systems where pkg_install is not present.</p></li>
2947: </ul></div>
2948: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2949: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2950: <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 2951: Create a binary package from an
1.10 hubertf 2952: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2953: save the old package.</p></li>
1.23 wiz 2954: <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 2955: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2956: from multiple locations. It currently supports the following
2957: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.23 wiz 2958: <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 2959: the best compiler flags to optimise code for your current
1.23 wiz 2960: CPU and compiler. </p></li>
1.1 dsieger 2961: </ul></div>
2962: <p>Utilities for keeping track of installed packages, being up to date,
2963: etc:</p>
1.41 asau 2964: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.65 wiz 2965: <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
2966: update tool similar to apt(1). Download, install, and upgrade
2967: binary packages easily.</p></li>
1.23 wiz 2968: <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 2969: packages whose installed versions do not match the latest pkgsrc
2970: entries.</p></li>
1.23 wiz 2971: <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 2972: dependency graphs of packages, to aid in choosing a strategy for
2973: updating.</p></li>
1.23 wiz 2974: <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 2975: 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 2976: <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 2977: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.23 wiz 2978: <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 2979: does various checks on the complete pkgsrc system.</p></li>
1.23 wiz 2980: <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 2981: packages you have installed.</p></li>
2982: </ul></div>
2983: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2985: <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 2986: making and maintaining patches for a package (includes pkgdiff,
2987: pkgvi, mkpatches, etc.).</p></li>
1.65 wiz 2988: <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 2989: converting to pkgsrc.</p></li>
2990: </ul></div>
2991: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2992: utilities)</p>
1.41 asau 2993: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2994: <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 2995: packages in a chrooted area.</p></li>
1.23 wiz 2996: <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 2997: kernel version for chrooted cross builds.</p></li>
2998: </ul></div>
2999: </div>
1.41 asau 3000: <div class="sect1">
1.1 dsieger 3001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3002: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3003: <p>If you want to use pkgsrc as non-root user, you can set some
3004: variables to make pkgsrc work under these conditions. At the very least,
1.23 wiz 3005: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.1 dsieger 3006: will turn on unprivileged mode and set multiple related variables to allow
3007: installation of packages as non-root.</p>
3008: <p>In case the defaults are not enough, you may want to tune some other
3009: variables used. For example, if the automatic user/group detection leads
3010: to incorrect values (or not the ones you would like to use), you can change
3011: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3012: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3013: <p>As regards bootstrapping, please note that the
1.10 hubertf 3014: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23 wiz 3015: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.1 dsieger 3016: use multiple default directories under <code class="filename">~/pkg</code> as the
3017: installation targets. These directories can be overridden by the
1.23 wiz 3018: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.1 dsieger 3019: that allow finer tuning of the tree layout.</p>
3020: </div>
1.41 asau 3021: <div class="sect1">
1.1 dsieger 3022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3023: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3024: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3025: enable this feature by adding the option
3026: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 3027: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3028: distfile is found, pkgsrc will try to resume it.</p>
3029: <p>You can also
1.61 wiz 3030: use a different program than the platform default program by changing the
1.16 jnemeth 3031: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3032: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3033: by using the value manual. A value of custom disables the system defaults
3034: and dependency tracking for the fetch program. In that case you have to
3035: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3036: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3037: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 3038: <p>For example, if you want to use
1.16 jnemeth 3039: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 3040: like:</p>
3041: <pre class="programlisting">
1.16 jnemeth 3042: FETCH_USING= wget
1.1 dsieger 3043: </pre>
3044: </div>
1.41 asau 3045: <div class="sect1">
1.1 dsieger 3046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3047: <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 3048: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3049: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3050: you will have to add the following line into
1.10 hubertf 3051: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3052: <pre class="programlisting">
1.4 rillig 3053: X11_TYPE=modular
1.1 dsieger 3054: </pre>
1.41 asau 3055: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 3056: <h3 class="title">Note</h3>
1.4 rillig 3057: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3058: </p>
1.1 dsieger 3059: </div>
3060: </div>
1.41 asau 3061: <div class="sect1">
1.1 dsieger 3062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3063: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3064: <p>If you are sitting behind a firewall which does not allow direct
3065: connections to Internet hosts (i.e. non-NAT), you may specify the
3066: relevant proxy hosts. This is done using an environment variable in the
3067: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 3068: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3069: port 80 as the proxy port number. So the proxy environment variables
3070: are:</p>
3071: <pre class="programlisting">
3072: ftp_proxy=ftp://orpheus.amdahl.com:80/
3073: http_proxy=http://orpheus.amdahl.com:80/
3074: </pre>
3075: </div>
1.41 asau 3076: <div class="sect1">
1.1 dsieger 3077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3078: <a name="fetch-https"></a>9.8. How to fetch files from HTTPS sites</h2></div></div></div>
3079: <p>Some fetch tools are not prepared to support HTTPS by default
3080: (for example, the one in NetBSD 6.0), or the one installed by the
3081: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3082: dependency graph).</p>
3083: <p>Usually you won't notice, because distribution files are
3084: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
3085: be often enough if you are following pkgsrc-current. In that case, set
3086: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
3087: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
3088: with HTTPS support by default. Of course, these tools need to be
3089: installed before you can use them this way.</p>
3090: </div>
3091: <div class="sect1">
3092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3093: <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 3094: <p>This depends on which utility is used to retrieve distfiles. From
3095: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3096: the first available command from the following list:</p>
1.41 asau 3097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3098: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3099: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3100: </ul></div>
3101: <p>On a default NetBSD installation, this will be
3102: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3103: connections first, and falls back to active connections if the server
3104: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3105: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3106: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3107: <p>Having that option present will prevent
3108: <code class="filename">/usr/bin/ftp</code> from falling back to active
3109: transfers.</p>
3110: </div>
1.41 asau 3111: <div class="sect1">
1.1 dsieger 3112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3113: <a name="fetching-all-distfiles"></a>9.10. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3114: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3115: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3116: 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 3117: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3118: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3119: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3120: resulting list to your machine at work/school and use it there. If you
1.29 dholland 3121: 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 3122: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3123: URL:</p>
3124: <p>At home:</p>
3125: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3126: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3127: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3128: <p>At work:</p>
3129: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3130: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3131: home.</p>
3132: <p>If you have a machine running NetBSD, and you want to get
3133: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3134: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3135: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3136: directly by running:</p>
3137: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3138: <p>If you even decide to ignore
3139: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3140: by running:</p>
3141: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3142: </div>
1.41 asau 3143: <div class="sect1">
1.1 dsieger 3144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3145: <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 3146: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3147: <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>
3148: package, you get the error from make that it doesn't know how to make
3149: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3150: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3151: the NetBSD base distribution on your machine. It is recommended to do
3152: that to format man pages.</p>
3153: <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
3154: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3155: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 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="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 3160: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3161: when you installed your NetBSD machine. Please get and install it, by
3162: extracting it in <code class="filename">/</code>:</p>
3163: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3164: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3165: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3166: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3167: -r</strong></span>).</p>
3168: </div>
1.41 asau 3169: <div class="sect1">
1.1 dsieger 3170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3171: <a name="using-sudo-with-pkgsrc"></a>9.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3172: <p>When installing packages as non-root user and using the just-in-time
1.29 dholland 3173: <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 3174: password for each required package installed. To avoid this, the sudo
3175: package can be used, which does password caching over a limited time. To
3176: use it, install sudo (either as binary package or from
3177: <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 3178: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3179: <span class="emphasis"><em>after</em></span> the definition of the
3180: <code class="varname">LOCALBASE</code> variable:</p>
3181: <pre class="programlisting">
3182: .if exists(${LOCALBASE}/bin/sudo)
3183: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3184: .endif
3185: </pre>
3186: </div>
1.41 asau 3187: <div class="sect1">
1.1 dsieger 3188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3189: <a name="faq.conf"></a>9.14. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3190: <p>As the system administrator, you can choose where configuration files
3191: are installed. The default settings make all these files go into
3192: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3193: be suboptimal depending on your expectations (e.g., a read-only,
3194: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3195: configuration of the provided packages).</p>
3196: <p>In order to change the defaults, you can modify the
3197: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3198: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3199: directory; some common examples include <code class="filename">/etc</code> or
3200: <code class="filename">/etc/pkg</code>.</p>
3201: <p>Furthermore, you can change this value on a per-package basis by
3202: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3203: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3204: package you would like to modify, that is, the contents of
3205: <code class="varname">PKGBASE</code>.</p>
3206: <p>Note that after changing these settings, you must rebuild and
3207: reinstall any affected packages.</p>
3208: </div>
1.41 asau 3209: <div class="sect1">
1.1 dsieger 3210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3211: <a name="audit-packages"></a>9.15. Automated security checks</h2></div></div></div>
1.1 dsieger 3212: <p>Please be aware that there can often be bugs in third-party software,
3213: and some of these bugs can leave a machine vulnerable to exploitation by
3214: attackers. In an effort to lessen the exposure, the NetBSD packages team
3215: maintains a database of known-exploits to packages which have at one time
3216: been included in pkgsrc. The database can be downloaded automatically, and
3217: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3218: do this, refer to the following two tools (installed as part of the
3219: <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 3220: <div class="orderedlist"><ol class="orderedlist" type="1">
3221: <li class="listitem">
1.20 snj 3222: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3223: download a list of the security vulnerabilities information. This list
1.25 spz 3224: is kept up to date by the pkgsrc security team, and is distributed
3225: from the NetBSD ftp server:</p>
3226: <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 3227: </li>
1.23 wiz 3228: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3229: current machine, checking each known vulnerability. If a
1.1 dsieger 3230: vulnerable package is installed, it will be shown by output to stdout,
3231: including a description of the type of vulnerability, and a URL
3232: containing more information.</p></li>
3233: </ol></div>
1.14 jmcneill 3234: <p>Use of these tools is strongly recommended! After
1.23 wiz 3235: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 3236: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 3237: pkg_install</code></strong>.</p>
1.1 dsieger 3238: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 3239: 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 3240: check.</p>
3241: </div>
1.41 asau 3242: <div class="sect1">
1.1 dsieger 3243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3244: <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 3245: <p>When you add your own preferences to the
3246: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3247: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3248: environment variables to the <code class="filename">./configure</code>
1.29 dholland 3249: 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 3250: <code class="varname">CFLAGS</code> from the environment variable by
3251: overriding them in the <code class="filename">Makefile</code>s of their
3252: package.</p>
3253: <p>Currently there is no solution to this problem. If you
3254: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3255: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3256: directory and then inspect any <code class="filename">Makefile</code> and
3257: <code class="filename">Makefile.in</code> for whether they define
3258: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3259: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3260: programmers write so bad code that it only works for the
3261: specific combination of <code class="varname">CFLAGS</code> they have
3262: chosen.</p>
3263: </div>
1.41 asau 3264: <div class="sect1">
1.1 dsieger 3265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3266: <a name="ufaq-fail"></a>9.17. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3267: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3268: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3269: case that occurs often is that people only update pkgsrc in
3270: parts, because of performance reasons. Since pkgsrc is one large
3271: system, not a collection of many small systems, there are
3272: sometimes changes that only work when the whole pkgsrc tree is
3273: updated.</p></li>
1.41 asau 3274: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3275: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3276: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3277: files.</p></li>
1.41 asau 3278: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3279: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3280: verify this.</p></li>
1.41 asau 3281: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3282: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3283: </ol></div>
3284: </div>
1.41 asau 3285: <div class="sect1">
1.1 dsieger 3286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.65 wiz 3287: <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 3288: <p>You have modified a file from pkgsrc, and someone else has
3289: modified that same file afterwards in the CVS repository. Both changes
3290: are in the same region of the file, so when you updated pkgsrc, the
3291: <code class="literal">cvs</code> command marked the conflicting changes in the
3292: file. Because of these markers, the file is no longer a valid
3293: <code class="filename">Makefile</code>.</p>
3294: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3295: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3296: -dP</strong></span> in that directory to download the current version.</p>
3297: </div>
3298: </div>
3299: </div>
1.41 asau 3300: <div class="part">
1.1 dsieger 3301: <div class="titlepage"><div><div><h1 class="title">
3302: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3303: <div class="partintro">
1.1 dsieger 3304: <div></div>
3305: <p>This part of the book deals with creating and
1.23 wiz 3306: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3307: guide on creating a new package. The remaining chapters are more
3308: like a reference manual for pkgsrc.</p>
3309: <div class="toc">
3310: <p><b>Table of Contents</b></p>
3311: <dl>
1.6 rillig 3312: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3313: <dd><dl>
1.6 rillig 3314: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3315: <dd><dl>
1.6 rillig 3316: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3317: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3318: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3319: </dl></dd>
1.6 rillig 3320: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3321: <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>
3322: </dl></dd>
3323: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3324: <dd><dl>
1.23 wiz 3325: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3326: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3327: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3328: <dd><dl>
3329: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3330: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3331: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3332: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3333: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3334: </dl></dd>
3335: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3336: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3337: <dd><dl>
3338: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3339: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3340: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3341: </dl></dd>
1.23 wiz 3342: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3343: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3344: </dl></dd>
1.23 wiz 3345: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3346: <dd><dl>
3347: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 3348: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 3349: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3350: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3351: <dd><dl>
3352: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3353: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3354: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3355: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3356: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3357: </dl></dd>
3358: </dl></dd>
3359: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3360: <dd><dl>
3361: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 3362: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3363: <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 3364: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3365: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 3366: <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 3367: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3368: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3369: </dl></dd>
3370: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3371: <dd><dl>
3372: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 3373: <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 3374: <dd><dl>
3375: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 3376: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3377: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3378: and
3379: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3380: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3381: </dl></dd>
1.23 wiz 3382: <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 3383: <dd><dl>
1.23 wiz 3384: <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 3385: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3386: </dl></dd>
3387: </dl></dd>
3388: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3389: <dd><dl>
3390: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3391: <dd><dl>
3392: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3393: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3394: </dl></dd>
3395: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3396: <dd><dl>
1.23 wiz 3397: <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 3398: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3399: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3400: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3401: </dl></dd>
3402: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3403: <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>
3404: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3405: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3406: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3407: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3408: <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>
3409: </dl></dd>
3410: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3411: <dd><dl>
3412: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 3413: <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 3414: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3415: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3416: </dl></dd>
3417: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3418: <dd><dl>
3419: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3420: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3421: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3422: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 3423: <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 3424: <dd><dl>
3425: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3426: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3427: </dl></dd>
1.23 wiz 3428: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3429: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3430: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3431: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3432: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3433: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3434: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3435: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3436: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3437: <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 3438: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3439: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3440: </dl></dd>
3441: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3442: <dd><dl>
3443: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3444: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3445: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3446: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3447: </dl></dd>
3448: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3449: <dd><dl>
3450: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3451: <dd><dl>
3452: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 3453: <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 3454: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3455: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3456: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3457: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3458: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3459: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3460: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3461: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3462: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3463: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3464: </dl></dd>
1.23 wiz 3465: <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 3466: <dd><dl>
3467: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3468: <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>
3469: </dl></dd>
1.23 wiz 3470: <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 3471: <dd><dl>
3472: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3473: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3474: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3475: </dl></dd>
3476: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3477: <dd><dl>
3478: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3479: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3480: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 3481: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3482: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 3483: </dl></dd>
1.23 wiz 3484: <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 3485: <dd><dl>
3486: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3487: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 3488: <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 3489: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3490: </dl></dd>
1.23 wiz 3491: <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 3492: <dd><dl>
3493: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3494: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3495: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3496: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3497: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3498: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3499: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3500: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3501: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 3502: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 3503: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3504: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3505: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3506: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3507: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3508: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3509: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3510: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3511: emulation</a></span></dt>
1.6 rillig 3512: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3513: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3514: </dl></dd>
1.6 rillig 3515: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3516: </dl></dd>
1.6 rillig 3517: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3518: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3519: <dd><dl>
1.6 rillig 3520: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3521: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3522: <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 3523: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 3524: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 3525: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3526: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 3527: </dl></dd>
3528: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3529: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3530: <dd><dl>
3531: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3532: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3533: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3534: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3535: </dl></dd>
3536: </dl>
3537: </div>
3538: </div>
1.41 asau 3539: <div class="chapter">
1.1 dsieger 3540: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3541: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3542: <div class="toc">
3543: <p><b>Table of Contents</b></p>
3544: <dl>
1.6 rillig 3545: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3546: <dd><dl>
1.6 rillig 3547: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.66 asau 3548: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.17 imil 3549: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3550: </dl></dd>
1.6 rillig 3551: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3552: <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 3553: </dl>
3554: </div>
3555: <p>When you find a package that is not yet in pkgsrc, you
3556: most likely have a URL from where you can download the source
3557: code. Starting with this URL, creating a package involves only a
3558: few steps.</p>
1.23 wiz 3559: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3560: <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>
3561: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3562: category in which you want to place your package. You can also create a
3563: directory of your own (maybe called <code class="filename">local</code>). In that
3564: category directory, create another directory for your package and change
3565: into it.</p></li>
1.41 asau 3566: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3567: you for a URL. Enter the URL of the distribution file (in most cases a
3568: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3569: of your package are created automatically. The distribution file is
3570: extracted automatically to fill in some details in the
3571: <code class="filename">Makefile</code> that would otherwise have to be done
3572: manually.</p></li>
1.41 asau 3573: <li class="step">
1.1 dsieger 3574: <p>Examine the extracted files to determine the dependencies of
3575: your package. Ideally, this is mentioned in some
3576: <code class="filename">README</code> file, but things may differ. For each of
3577: these dependencies, look where it exists in pkgsrc, and if there is a
3578: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3579: line to your package <code class="filename">Makefile</code> which includes that
3580: file just before the last line. If the
1.25 spz 3581: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3582: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3583: <p>If you just need binaries from a package, add a
1.1 dsieger 3584: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3585: version of the dependency and where it can be found in pkgsrc. This line
3586: should be placed in the third paragraph. If the dependency is only
3587: needed for building the package, but not when using it, use
3588: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3589: Your package may then look like this:</p>
3590: <pre class="programlisting">
3591: [...]
3592:
1.66 asau 3593: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3594: DEPENDS+= screen-[0-9]*:../../misc/screen
3595: DEPENDS+= screen>=4.0:../../misc/screen
3596:
3597: [...]
3598:
3599: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3600: .include "../../devel/glib2/buildlink3.mk"
3601: .include "../../mk/bsd.pkg.mk"
3602: </pre>
3603: </li>
1.41 asau 3604: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3605: 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 3606: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3607: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3608: -e</strong></span>, which outputs additional
3609: explanations.</p></li>
1.41 asau 3610: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3611: 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 3612: over there, you can hopefully continue here.</p></li>
1.41 asau 3613: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3614: directory from the extracted files. Besides these files, a lot of cache
3615: files and other system information has been saved in the working
3616: directory, which may become wrong after you edited the
3617: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3618: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3619: 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 3620: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3621: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3622: everything works.</p></li>
1.41 asau 3623: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3624: contains a list of the files that are installed by the package, is
1.10 hubertf 3625: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3626: >PLIST</strong></span> to generate a probably correct list. Check
3627: the file using your preferred text editor to see if the list of
3628: files looks plausible.</p></li>
1.41 asau 3629: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3630: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3631: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3632: has been registered in the database of installed files, but with an
1.10 hubertf 3633: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3634: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3635: registered with the list of files from
3636: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3637: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3638: package from the set of installed files.</p></li>
3639: </ol></div>
1.41 asau 3640: <div class="sect1">
1.1 dsieger 3641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3642: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3643: <div class="sect2">
1.1 dsieger 3644: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3645: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3646: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3647: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3648: </div>
1.41 asau 3649: <div class="sect2">
1.1 dsieger 3650: <div class="titlepage"><div><div><h3 class="title">
1.66 asau 3651: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
3652: <p>KDE3 applications should always include
1.1 dsieger 3653: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.66 asau 3654: settings that are typical of KDE3 packages.</p>
1.1 dsieger 3655: </div>
1.41 asau 3656: <div class="sect2">
1.17 imil 3657: <div class="titlepage"><div><div><h3 class="title">
3658: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3659: <p>Python modules and programs packages are easily created using a
3660: set of predefined variables.</p>
3661: <p>
1.63 wiz 3662: If some Python versions are not supported by the software, set the
3663: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3664: that are not supported, e.g.
1.17 imil 3665: </p>
3666: <pre class="programlisting">
1.64 wiz 3667: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.17 imil 3668: </pre>
3669: <p>
3670: If the packaged software is a Python module, include
1.23 wiz 3671: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.17 imil 3672: In this case, the package directory should be called
1.23 wiz 3673: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3674: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3675: </p>
3676: <pre class="programlisting">
3677: DISTNAME= foopymodule-1.2.10
3678: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3679: </pre>
1.63 wiz 3680: <p>If it is an application, include
3681: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3682: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3683: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3684: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3685: For example:
1.17 imil 3686: </p>
3687: <pre class="programlisting">
1.35 wiz 3688: REPLACE_PYTHON= *.py
1.17 imil 3689: </pre>
1.63 wiz 3690: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3691: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3692: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3693: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3694: so pkgsrc will use this framework.
3695: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3696: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3697: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3698: to the name of the script.</p>
3699: <p>Otherwise, if the packaged software is egg-aware, you only need
3700: to include
3701: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
3702: <p>Some Python modules have separate distributions for Python-2.x
3703: and Python-3.x support. In pkgsrc this is handled by the
3704: <code class="filename">versioned_dependencies.mk</code> file. Set
3705: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3706: packages that should be depended upon and include
3707: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3708: then the pkgsrc infrastructure will depend on the appropriate package
3709: version. For example:
3710: </p>
3711: <pre class="programlisting">
3712: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
3713: </pre>
3714: <p>
3715: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3716: of supported packages.</p>
1.17 imil 3717: </div>
1.1 dsieger 3718: </div>
1.41 asau 3719: <div class="sect1">
1.1 dsieger 3720: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3721: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 3722: <div class="sect2">
1.1 dsieger 3723: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3724: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3725: <div class="sect3">
1.1 dsieger 3726: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3727: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3728: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3729: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3730: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3731: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3732: <pre class="programlisting">
3733: <code class="prompt">$</code> mkdir www/nvu
3734: <code class="prompt">$</code> cd www/nvu
3735: </pre>
3736: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3737: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3738: <pre class="programlisting">
3739: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3740: </pre>
3741: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3742: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3743: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3744: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3745: <code class="varname">COMMENT</code> fields. Then the package
3746: <code class="filename">Makefile</code> looked like that:</p>
3747: <pre class="programlisting">
3748: # $NetBSD$
3749: #
3750:
3751: DISTNAME= nvu-1.0-sources
3752: PKGNAME= nvu-1.0
3753: CATEGORIES= www
3754: MASTER_SITES= http://cvs.nvu.com/download/
3755: EXTRACT_SUFX= .tar.bz2
3756:
3757: MAINTAINER= rillig@NetBSD.org
3758: HOMEPAGE= http://cvs.nvu.com/
3759: COMMENT= Web Authoring System
3760:
3761: # url2pkg-marker (please do not remove this line.)
3762: .include "../../mk/bsd.pkg.mk"
3763: </pre>
3764: <p>Then, I quit the editor and watched pkgsrc downloading a large
3765: source archive:</p>
3766: <pre class="programlisting">
3767: url2pkg> Running "make makesum" ...
3768: => Required installed package digest>=20010302: digest-20060826 found
3769: => Fetching nvu-1.0-sources.tar.bz2
3770: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3771: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3772: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3773: url2pkg> Running "make extract" ...
3774: => Required installed package digest>=20010302: digest-20060826 found
3775: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3776: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3777: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3778: ===> Installing dependencies for nvu-1.0
3779: ===> Overriding tools for nvu-1.0
3780: ===> Extracting for nvu-1.0
3781: url2pkg> Adjusting the Makefile.
3782:
3783: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3784:
3785: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3786: </pre>
3787: </div>
1.41 asau 3788: <div class="sect3">
1.1 dsieger 3789: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3790: <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 3791: <p>Now that the package has been extracted, let's see what's inside
3792: it. The package has a <code class="filename">README.txt</code>, but that only
3793: says something about mozilla, so it's probably useless for seeing what
3794: dependencies this package has. But since there is a GNU configure script
3795: in the package, let's hope that it will complain about everything it
3796: needs.</p>
3797: <pre class="programlisting">
3798: <code class="prompt">$</code> bmake
3799: => Required installed package digest>=20010302: digest-20060826 found
3800: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3801: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3802: ===> Patching for nvu-1.0
3803: ===> Creating toolchain wrappers for nvu-1.0
3804: ===> Configuring for nvu-1.0
3805: [...]
3806: configure: error: Perl 5.004 or higher is required.
3807: [...]
3808: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3809: [...]
3810: </pre>
3811: <p>That worked quite well. So I opened the package Makefile in my
3812: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3813: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3814: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3815: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3816: from scratch.</p>
3817: <pre class="programlisting">
3818: <code class="prompt">$</code> bmake clean
3819: ===> Cleaning for nvu-1.0
3820: <code class="prompt">$</code> bmake
3821: [...]
3822: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3823: GNU Make. You will not be able to build Mozilla without GNU Make.
3824: [...]
3825: </pre>
1.23 wiz 3826: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3827: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3828: <pre class="programlisting">
3829: [...]
3830: checking for GTK - version >= 1.2.0... no
3831: *** Could not run GTK test program, checking why...
3832: [...]
3833: </pre>
3834: <p>Now to the other dependencies. The first question is: Where is the
3835: GTK package hidden in pkgsrc?</p>
3836: <pre class="programlisting">
3837: <code class="prompt">$</code> echo ../../*/gtk*
3838: [many packages ...]
3839: <code class="prompt">$</code> echo ../../*/gtk
3840: ../../x11/gtk
3841: <code class="prompt">$</code> echo ../../*/gtk2
3842: ../../x11/gtk2
3843: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3844: ../../x11/gtk2/buildlink3.mk
3845: </pre>
3846: <p>The first try was definitely too broad. The second one had exactly
3847: one result, which is very good. But there is one pitfall with GNOME
3848: packages. Before GNOME 2 had been released, there were already many
3849: GNOME 1 packages in pkgsrc. To be able to continue to use these
3850: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3851: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3852: whether this was the case here, and indeed it was.</p>
3853: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3854: file, adding the dependency is very easy. I just inserted an
3855: <code class="literal">.include</code> line before the last line of the package
3856: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3857: <pre class="programlisting">
3858: [...]
3859: .include "../../x11/gtk2/buildlink3.mk"
3860: .include "../../mk/bsd.pkg.mk
3861: </pre>
1.10 hubertf 3862: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3863: was:</p>
3864: <pre class="programlisting">
3865: [...]
3866: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3867: checking for GTK - version >= 1.2.0... no
3868: *** Could not run GTK test program, checking why...
3869: *** The test program failed to compile or link. See the file config.log for the
3870: *** exact error that occured. This usually means GTK was incorrectly installed
3871: *** or that you have moved GTK since it was installed. In the latter case, you
3872: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3873: configure: error: Test for GTK failed.
3874: [...]
3875: </pre>
1.23 wiz 3876: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3877: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3878: told me that this package really wanted to have the GNOME 1 version of
3879: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3880: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3881: So I changed the <code class="literal">x11/gtk2</code> to
3882: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3883: and tried again.</p>
3884: <pre class="programlisting">
3885: [...]
1.59 jnemeth 3886: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3887: In file included from xpidl.c:42:
3888: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3889: In file included from xpidl.c:42:
3890: xpidl.h:132: error: parse error before "IDL_ns"
3891: [...]
3892: </pre>
3893: <p>The package still does not find all of its dependencies. Now the
3894: question is: Which package provides the
3895: <code class="filename">libIDL/IDL.h</code> header file?</p>
3896: <pre class="programlisting">
3897: <code class="prompt">$</code> echo ../../*/*idl*
3898: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3899: <code class="prompt">$</code> echo ../../*/*IDL*
3900: ../../net/libIDL
3901: </pre>
3902: <p>Let's take the one from the second try. So I included the
3903: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3904: again. But the error didn't change. After digging through some of the
3905: code, I concluded that the build process of the package was broken and
3906: couldn't have ever worked, but since the Mozilla source tree is quite
3907: large, I didn't want to fix it. So I added the following to the package
3908: <code class="filename">Makefile</code> and tried again:</p>
3909: <pre class="programlisting">
3910: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3911: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3912: </pre>
3913: <p>The latter line is needed because the package expects the library
3914: <code class="filename">libIDL.so</code>, but only
3915: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3916: wrapper to rewrite that on the fly.</p>
3917: <p>The next problem was related to a recent change of the FreeType
3918: 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>
3919: which patch files were relevant for this issue and copied them to the
3920: <code class="filename">patches</code> directory. Then I retried, fixed the
3921: patches so that they applied cleanly and retried again. This time,
3922: everything worked.</p>
3923: </div>
1.41 asau 3924: <div class="sect3">
1.1 dsieger 3925: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3926: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3927: <pre class="programlisting">
3928: <code class="prompt">$</code> bmake CHECK_FILES=no install
3929: [...]
3930: <code class="prompt">$</code> bmake print-PLIST >PLIST
3931: <code class="prompt">$</code> bmake deinstall
3932: <code class="prompt">$</code> bmake install
3933: </pre>
3934: </div>
3935: </div>
3936: </div>
3937: </div>
1.41 asau 3938: <div class="chapter">
1.1 dsieger 3939: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3940: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3941: <div class="toc">
3942: <p><b>Table of Contents</b></p>
3943: <dl>
1.23 wiz 3944: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3945: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3946: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3947: <dd><dl>
3948: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3949: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3950: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3951: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3952: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3953: </dl></dd>
3954: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3955: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3956: <dd><dl>
3957: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3958: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3959: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3960: </dl></dd>
1.23 wiz 3961: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3962: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3963: </dl>
3964: </div>
3965: <p>Whenever you're preparing a package, there are a number of
3966: files involved which are described in the following
3967: sections.</p>
1.41 asau 3968: <div class="sect1">
1.1 dsieger 3969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3970: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 3971: </h2></div></div></div>
3972: <p>Building, installation and creation of a binary package are all
3973: controlled by the package's <code class="filename">Makefile</code>.
3974: The <code class="filename">Makefile</code> describes various things about
3975: a package, for example from where to get it, how to configure,
3976: build, and install it.</p>
3977: <p>A package <code class="filename">Makefile</code> contains several
3978: sections that describe the package.</p>
3979: <p>In the first section there are the following variables, which
3980: should appear exactly in the order given here. The order and
3981: grouping of the variables is mostly historical and has no further
3982: meaning.</p>
1.41 asau 3983: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3984: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3985: distribution file to be downloaded from the package's
3986: website.</p></li>
1.23 wiz 3987: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3988: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3989: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3990: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3991: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3992: directory name together with the version number. It must match the
3993: regular expression
3994: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3995: starts with a letter or digit, and contains only letters, digits,
3996: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3997: <li class="listitem">
1.1 dsieger 3998: <p><code class="varname">CATEGORIES</code> is a list of categories
3999: which the package fits in. You can choose any of the top-level
4000: directories of pkgsrc for it.</p>
4001: <p>Currently the following values are available for
4002: <code class="varname">CATEGORIES</code>. If more than
4003: one is used, they need to be separated by spaces:</p>
4004: <pre class="programlisting">
4005: archivers cross geography meta-pkgs security
4006: audio databases graphics misc shells
4007: benchmarks devel ham multimedia sysutils
4008: biology editors inputmethod net textproc
4009: cad emulators lang news time
4010: chat finance mail parallel wm
4011: comms fonts math pkgtools www
4012: converters games mbone print x11
4013: </pre>
4014: </li>
1.23 wiz 4015: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 4016: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4017: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4018: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 4019: <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 4020: </ul></div>
4021: <p>The second section contains information about separately
4022: downloaded patches, if any.
4023: </p>
1.41 asau 4024: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4025: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1 dsieger 4026: Name(s) of additional files that contain distribution patches.
4027: There is no default. pkgsrc will look for them at
4028: <code class="varname">PATCH_SITES</code>.
4029: They will automatically be uncompressed before patching if
4030: the names end with <code class="filename">.gz</code> or
4031: <code class="filename">.Z</code>.</p></li>
1.23 wiz 4032: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 4033: Primary location(s) for distribution patch files (see
4034: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4035: </ul></div>
4036: <p>The third section contains the following variables.
4037: </p>
1.41 asau 4038: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4039: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 4040: address of the person who feels responsible for this package,
4041: and who is most likely to look at problems or questions regarding
1.29 dholland 4042: 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 4043: Other developers may contact the <code class="varname">MAINTAINER</code>
4044: before making changes to the package, but are not required to
4045: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4046: to yourself. If you really can't maintain the package for future
4047: updates, set it to
1.10 hubertf 4048: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 4049: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 4050: of <code class="varname">MAINTAINER</code> when you do not want other
4051: developers to update or change the package without contacting
4052: you first. A package Makefile should contain one of
4053: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4054: not both. </p></li>
1.23 wiz 4055: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 4056: find more information about the package.</p></li>
1.23 wiz 4057: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 4058: description of the package (should not include the package
4059: name).</p></li>
4060: </ul></div>
4061: <p>Other variables that affect the build:
4062: </p>
1.41 asau 4063: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4064: <p><code class="varname">WRKSRC</code>: The directory where the
4065: interesting distribution files of the package are found. The
4066: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4067: works for most packages.</p>
4068: <p>If a package doesn't create a subdirectory for itself
4069: (most GNU software does, for instance), but extracts itself in
4070: the current directory, you should set
4071: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4072: <p>If a package doesn't create a subdirectory with the
4073: name of <code class="varname">DISTNAME</code> but some different name,
4074: set <code class="varname">WRKSRC</code> to point to the proper name in
4075: <code class="filename">${WRKDIR}</code>, for example
4076: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4077: <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>
4078: <p>The name of the working directory created by pkgsrc is
4079: taken from the <code class="varname">WRKDIR_BASENAME</code>
4080: variable. By default, its value is
4081: <code class="filename">work</code>. If you want to use the same
4082: pkgsrc tree for building different kinds of binary packages,
4083: you can change the variable according to your needs. Two
4084: other variables handle common cases of setting
4085: <code class="varname">WRKDIR_BASENAME</code> individually. If
4086: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 4087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4088: the host's name is attached to the directory name. If
4089: <code class="varname">OBJMACHINE</code> is defined, the platform name
4090: is attached, which might look like
4091: <code class="filename">work.i386</code> or
4092: <code class="filename">work.sparc</code>.</p>
4093: </li></ul></div>
4094: <p>Please pay attention to the following gotchas:</p>
1.41 asau 4095: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4096: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 4097: installed in compressed form by the package. For packages using
4098: BSD-style makefiles which honor MANZ, there is
4099: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 4100: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4101: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 4102: below).</p></li>
1.23 wiz 4103: <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 4104: </ul></div>
4105: </div>
1.41 asau 4106: <div class="sect1">
1.1 dsieger 4107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4108: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4109: </h2></div></div></div>
4110: <p>The <code class="filename">distinfo</code> file contains the message
4111: digest, or checksum, of each distfile needed for the package. This
4112: ensures that the distfiles retrieved from the Internet have not been
4113: corrupted during transfer or altered by a malign force to introduce
4114: a security hole. Due to recent rumor about weaknesses of digest
4115: algorithms, all distfiles are protected using both SHA1 and RMD160
4116: message digests, as well as the file size.</p>
4117: <p>The <code class="filename">distinfo</code> file also contains the
4118: checksums for all the patches found in the
1.10 hubertf 4119: <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 4120: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10 hubertf 4121: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 4122: command.</p>
4123: <p>Some packages have different sets of distfiles depending on
1.23 wiz 4124: 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 4125: <code class="filename">distinfo</code> file and care should be taken when
4126: upgrading such a package to ensure distfile information is not
4127: lost.</p>
4128: </div>
1.41 asau 4129: <div class="sect1">
1.1 dsieger 4130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4131: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4132: <p>Many packages still don't work out-of-the box on the various
4133: platforms that are supported by pkgsrc. Therefore, a number of custom
4134: patch files are needed to make the package work. These patch files are
4135: found in the <code class="filename">patches/</code> directory.</p>
4136: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4137: applied to the files in <code class="varname">WRKSRC</code> directory after
1.10 hubertf 4138: 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 4139: order</a>.</p>
1.41 asau 4140: <div class="sect2">
1.1 dsieger 4141: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4142: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4143: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 4144: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 4145: problems. (To force patches to apply with fuzz you can set
4146: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4147: should contain only changes for a single file, and no file should be
4148: patched by more than one patch file. This helps to keep future
4149: modifications simple.</p>
4150: <p>Each patch file is structured as follows: In the first line,
4151: there is the RCS Id of the patch itself. The second line should be
4152: empty for aesthetic reasons. After that, there should be a comment for
4153: each change that the patch does. There are a number of standard
4154: cases:</p>
1.41 asau 4155: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4156: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 4157: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 4158: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 4159: platform and other environment (for example, the compiler) that the
4160: patch is needed for.</p></li>
4161: </ul></div>
1.24 wiz 4162: <p>In all, the patch should be commented so that any
1.1 dsieger 4163: developer who knows the code of the application can make some use of
4164: the patch. Special care should be taken for the upstream developers,
4165: since we generally want that they accept our patches, so we have less
4166: work in the future.</p>
4167: </div>
1.41 asau 4168: <div class="sect2">
1.1 dsieger 4169: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4170: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4171: <p>One important thing to mention is to pay attention that no RCS
4172: IDs get stored in the patch files, as these will cause problems when
4173: later checked into the NetBSD CVS tree. Use the
1.10 hubertf 4174: <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 4175: problems.</p>
4176: <p>For even more automation, we recommend using
1.10 hubertf 4177: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4178: whole set of patches. You just have to backup files before you
4179: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4180: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4181: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4182: you upgrade a package this way, you can easily compare the new
4183: set of patches with the previously existing one with
1.24 wiz 4184: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4185: are replaced by new files, so carefully check if you want to take all
4186: the changes.</p>
1.1 dsieger 4187: <p>When you have finished a package, remember to generate
1.10 hubertf 4188: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 4189: 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 4190: <p>When adding a patch that corrects a problem in the
4191: distfile (rather than e.g. enforcing pkgsrc's view of where
4192: man pages should go), send the patch as a bug report to the
4193: maintainer. This benefits non-pkgsrc users of the package,
4194: and usually makes it possible to remove the patch in future
4195: version.</p>
1.2 rillig 4196: <p>The file names of the patch files are usually of the form
1.24 wiz 4197: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4198: Many packages still use the previous convention
4199: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4200: but new patches should be of the form containing the filename.
4201: <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
4202: automatically.</p>
1.1 dsieger 4203: </div>
1.41 asau 4204: <div class="sect2">
1.1 dsieger 4205: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4206: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4207: <p>If you want to share patches between multiple packages
4208: in pkgsrc, e.g. because they use the same distfiles, set
4209: <code class="varname">PATCHDIR</code> to the path where the patch files
4210: can be found, e.g.:</p>
4211: <pre class="programlisting">
4212: PATCHDIR= ${.CURDIR}/../xemacs/patches
4213: </pre>
4214: <p>Patch files that are distributed by the author or other
4215: maintainers can be listed in
4216: <code class="varname">PATCHFILES</code>.</p>
4217: <p>If it is desired to store any patches that should not be
4218: committed into pkgsrc, they can be kept outside the pkgsrc
4219: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4220: directory tree there is expected to have the same
1.23 wiz 4221: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 4222: patches are expected to be stored inside these dirs (also
4223: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4224: example, if you want to keep a private patch for
4225: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4226: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4227: files in the named directory are expected to be patch files,
4228: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4229: applied</em></span>.</p>
4230: </div>
1.41 asau 4231: <div class="sect2">
1.1 dsieger 4232: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4233: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4234: <p>When fixing a portability issue in the code do not use
4235: preprocessor magic to check for the current operating system nor
4236: platform. Doing so hurts portability to other platforms because
4237: the OS-specific details are not abstracted appropriately.</p>
4238: <p>The general rule to follow is: instead of checking for the
4239: operating system the application is being built on, check for the
4240: specific <span class="emphasis"><em>features</em></span> you need. For example,
4241: instead of assuming that kqueue is available under NetBSD and
4242: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 4243: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4244: yes, this generally involves patching the
1.10 hubertf 4245: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4246: that prevents some OSes from adopting interfaces from other OSes
4247: (e.g. Linux implementing kqueue), something that the above checks
4248: cannot take into account.</p>
4249: <p>Of course, checking for features generally involves more
4250: work on the developer's side, but the resulting changes are
4251: cleaner and there are chances they will work on many other
4252: platforms. Not to mention that there are higher chances of being
4253: later integrated into the mainstream sources. Remember:
4254: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4255: <p>Some typical examples:</p>
4256: <div class="table">
1.6 rillig 4257: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4258: <div class="table-contents"><table summary="Patching examples" border="1">
4259: <colgroup>
4260: <col>
4261: <col>
4262: <col>
4263: </colgroup>
4264: <thead><tr>
4265: <th>Where</th>
4266: <th>Incorrect</th>
4267: <th>Correct</th>
4268: </tr></thead>
4269: <tbody>
4270: <tr>
4271: <td>configure script</td>
4272: <td>
4273: <pre class="programlisting">
4274: case ${target_os} in
4275: netbsd*) have_kvm=yes ;;
4276: *) have_kvm=no ;;
4277: esac
4278: </pre>
4279: </td>
4280: <td>
4281: <pre class="programlisting">
4282: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4283: </pre>
4284: </td>
4285: </tr>
4286: <tr>
4287: <td>C source file</td>
4288: <td>
4289: <pre class="programlisting">
4290: #if defined(__NetBSD__)
4291: # include <sys/event.h>
4292: #endif
4293: </pre>
4294: </td>
4295: <td>
4296: <pre class="programlisting">
4297: #if defined(HAVE_SYS_EVENT_H)
4298: # include <sys/event.h>
4299: #endif
4300: </pre>
4301: </td>
4302: </tr>
4303: <tr>
4304: <td>C source file</td>
4305: <td>
4306: <pre class="programlisting">
4307: int
4308: monitor_file(...)
4309: {
4310: #if defined(__NetBSD__)
4311: int fd = kqueue();
4312: ...
4313: #else
4314: ...
4315: #endif
4316: }
4317: </pre>
4318: </td>
4319: <td>
4320: <pre class="programlisting">
4321: int
4322: monitor_file(...)
4323: {
4324: #if defined(HAVE_KQUEUE)
4325: int fd = kqueue();
4326: ...
4327: #else
4328: ...
4329: #endif
4330: }
4331: </pre>
4332: </td>
4333: </tr>
4334: </tbody>
4335: </table></div>
4336: </div>
4337: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 4338: 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
4339: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 4340: 2</a>). It summarizes multiple details on how to make
4341: software easier to package; all the suggestions in it were
4342: collected from our experience in pkgsrc work, so they are possibly
4343: helpful when creating patches too.</p>
4344: </div>
1.41 asau 4345: <div class="sect2">
1.1 dsieger 4346: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4347: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4348: <p>Always, always, <span class="strong"><strong>always</strong></span>
4349: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4350: improvements you do to a package to the mainstream developers.
4351: This is the only way to get their attention on portability issues
4352: and to ensure that future versions can be built out-of-the box on
4353: NetBSD. Furthermore, any user that gets newer distfiles will get
4354: the fixes straight from the packaged code.</p>
4355: <p>This generally involves cleaning up the patches
4356: (because sometimes the patches that are
1.40 wiz 4357: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 4358: appropriate trackers for the projects and working with the
4359: mainstream authors to accept your changes. It is
4360: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4361: the packages in pkgsrc are kept simple and thus further changes
4362: can be done without much hassle.</p>
1.24 wiz 4363: <p>When you have done this, please add a URL to the upstream
4364: bug report to the patch comment.</p>
1.1 dsieger 4365: <p>Support the idea of free software!</p>
4366: </div>
4367: </div>
1.41 asau 4368: <div class="sect1">
1.1 dsieger 4369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4370: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 4371: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4372: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4373: <dd><p>A multi-line description of the piece of software. This should include
4374: any credits where they are due. Please bear in mind that others do not
4375: share your sense of humour (or spelling idiosyncrasies), and that others
4376: will read everything that you write here.</p></dd>
4377: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4378: <dd><p>This file governs the files that are installed on your
4379: system: all the binaries, manual pages, etc. There are other
4380: directives which may be entered in this file, to control the
4381: creation and deletion of directories, and the location of
1.10 hubertf 4382: 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 4383: information.</p></dd>
4384: </dl></div>
4385: </div>
1.41 asau 4386: <div class="sect1">
1.1 dsieger 4387: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4388: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 4389: <div class="sect2">
1.1 dsieger 4390: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4391: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4392: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4393: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4394: <dd>
1.29 dholland 4395: <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 4396: First time after package extraction and before files are
4397: moved in place, the second time after the files to install
4398: are moved in place. This can be used to do any custom
4399: procedures not possible with @exec commands in
1.29 dholland 4400: <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
4401: <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 4402: Please note that you can modify variables in it easily by using
4403: <code class="varname">FILES_SUBST</code> in the package's
4404: <code class="filename">Makefile</code>:</p>
4405: <pre class="programlisting">
4406: FILES_SUBST+= SOMEVAR="somevalue"
4407: </pre>
4408: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4409: <code class="filename">INSTALL</code>. By default, substitution is
4410: performed for <code class="varname">PREFIX</code>,
4411: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4412: <code class="varname">VARBASE</code>, and a few others, type
4413: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4414: complete list.</p>
4415: </dd>
1.1 dsieger 4416: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4417: <dd><p>This script is executed before and after any files are removed. It is
4418: this script's responsibility to clean up any additional messy details
4419: around the package's installation, since all pkg_delete knows is how to
4420: delete the files created in the original distribution.
1.29 dholland 4421: 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>
4422: 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 4423: The same methods to replace variables can be used as for
4424: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4425: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4426: <dd>
4427: <p>This file is displayed after installation of the package.
4428: Useful for things like legal notices on almost-free
4429: software and hints for updating config files after
4430: installing modules for apache, PHP etc.
4431: Please note that you can modify variables in it easily by using
4432: <code class="varname">MESSAGE_SUBST</code> in the package's
4433: <code class="filename">Makefile</code>:</p>
4434: <pre class="programlisting">
4435: MESSAGE_SUBST+= SOMEVAR="somevalue"
4436: </pre>
1.23 wiz 4437: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4438: <code class="filename">MESSAGE</code>. By default, substitution is
4439: performed for <code class="varname">PKGNAME</code>,
4440: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4441: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4442: <code class="varname">X11BASE</code>,
4443: <code class="varname">PKG_SYSCONFDIR</code>,
4444: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4445: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4446: <p>You can display a different or additional files by
4447: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4448: default is <code class="filename">MESSAGE</code>, if the file
4449: exists.</p>
4450: </dd>
4451: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 4452: <dd>
4453: <p>This file is used by the alternatives framework.
4454: It creates, configures, and destroys generic wrappers used to
4455: run programs with similar interfaces.
4456: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4457: for more information.</p>
4458: <p>Each line of the file contains two filenames, first
4459: the wrapper and then the alternative provided by the package.
4460: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4461: </dd>
1.1 dsieger 4462: </dl></div>
4463: </div>
1.41 asau 4464: <div class="sect2">
1.1 dsieger 4465: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4466: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4467: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4468: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4469: <dd><p>This file contains arbitrary things that could
4470: also go into a <code class="filename">Makefile</code>, but its purpose is
4471: to be used by more than one package. This file should only be
4472: used when the packages that will use the file are known in
4473: advance. For other purposes it is often better to write a
4474: <code class="filename">*.mk</code> file and give it a good name that
4475: describes what it does.</p></dd>
4476: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4477: <dd><p>This file contains the dependency information
1.10 hubertf 4478: 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 4479: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4480: <dd><p>This file contains workarounds for compiler bugs
4481: and similar things. It is included automatically by the pkgsrc
4482: infrastructure, so you don't need an extra
4483: <code class="literal">.include</code> line for
4484: it.</p></dd>
4485: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4486: <dd><p>This file contains the code for the
1.10 hubertf 4487: 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 4488: selected by the user. If a package has only one or two options,
4489: it is equally acceptable to put the code directly into the
4490: <code class="filename">Makefile</code>.</p></dd>
4491: </dl></div>
4492: </div>
1.41 asau 4493: <div class="sect2">
1.1 dsieger 4494: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4495: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4496: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4497: <dt><span class="term"><code class="filename">README*</code></span></dt>
4498: <dd><p>These files do not take place in the creation of
4499: a package and thus are purely informative to the package
4500: developer.</p></dd>
4501: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4502: <dd><p>This file contains things that need to be done
4503: to make the package even
4504: better.</p></dd>
4505: </dl></div>
4506: </div>
4507: </div>
1.41 asau 4508: <div class="sect1">
1.1 dsieger 4509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4510: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4511: </h2></div></div></div>
1.10 hubertf 4512: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4513: unpacked into the directory denoted by
4514: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4515: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4516: directory is also used to keep various timestamp files.
4517: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4518: The default is <code class="filename">${.CURDIR}/work</code>
4519: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4520: if <code class="varname">OBJMACHINE</code> is set.</p>
4521: </div>
1.41 asau 4522: <div class="sect1">
1.1 dsieger 4523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4524: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4525: </h2></div></div></div>
4526: <p>If you have any files that you wish to be placed in the package prior
4527: to configuration or building, you could place these files here and use
1.10 hubertf 4528: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4529: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4530: this. Alternatively, you could simply diff the file against
4531: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4532: the creation of this file.</p>
4533: <p>If you want to share files in this way with other
4534: packages, set the <code class="varname">FILESDIR</code> variable to point
4535: to the other package's <code class="filename">files</code> directory,
4536: e.g.:</p>
4537: <pre class="programlisting">
4538: FILESDIR=${.CURDIR}/../xemacs/files
4539: </pre>
4540: </div>
4541: </div>
1.41 asau 4542: <div class="chapter">
1.1 dsieger 4543: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4544: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4545: <div class="toc">
4546: <p><b>Table of Contents</b></p>
4547: <dl>
1.6 rillig 4548: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4549: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4550: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4551: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4552: <dd><dl>
4553: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4554: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4555: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4556: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4557: <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 4558: </dl></dd>
4559: </dl>
4560: </div>
4561: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4562: each of which forms a well-defined part of the pkgsrc system. Using
1.29 dholland 4563: 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 4564: like pkgsrc requires some discipline to keep the code correct and
4565: understandable.</p>
4566: <p>The basic ingredients for <code class="filename">Makefile</code>
4567: programming are variables (which are actually macros) and shell
4568: commands. Among these shell commands may even be more complex ones
1.29 dholland 4569: 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 4570: as intended it is necessary to quote all variables correctly when they
4571: are used.</p>
4572: <p>This chapter describes some patterns, that appear quite often in
4573: <code class="filename">Makefile</code>s, including the pitfalls that come along
4574: with them.</p>
1.41 asau 4575: <div class="sect1">
1.1 dsieger 4576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4577: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4578: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4579: <p>When you are creating a file as a
4580: target of a rule, always write the data to a temporary file first
4581: and finally rename that file. Otherwise there might occur an error
4582: in the middle of generating the file, and when the user runs
1.29 dholland 4583: <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 4584: regenerated properly. Example:</p>
4585: <pre class="programlisting">
4586: wrong:
4587: @echo "line 1" > ${.TARGET}
4588: @echo "line 2" >> ${.TARGET}
4589: @false
4590:
4591: correct:
4592: @echo "line 1" > ${.TARGET}.tmp
4593: @echo "line 2" >> ${.TARGET}.tmp
4594: @false
4595: @mv ${.TARGET}.tmp ${.TARGET}
4596: </pre>
1.10 hubertf 4597: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4598: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4599: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4600: correct</strong></span> gives an error message twice, as expected.</p>
1.29 dholland 4601: <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 4602: <code class="literal">${.TARGET}</code> in case of error, but this only
4603: happens when it is interrupted, for example by pressing
4604: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.29 dholland 4605: 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 4606: </li></ul></div>
4607: </div>
1.41 asau 4608: <div class="sect1">
1.1 dsieger 4609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4610: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4611: <p><code class="filename">Makefile</code> variables contain strings that
4612: can be processed using the five operators ``='', ``+='', ``?='',
1.29 dholland 4613: ``:='', 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 4614: page.</p>
4615: <p>When a variable's value is parsed from a
4616: <code class="filename">Makefile</code>, the hash character ``#'' and the
4617: backslash character ``\'' are handled specially. If a backslash is
4618: followed by a newline, any whitespace immediately in front of the
4619: backslash, the backslash, the newline, and any whitespace
4620: immediately behind the newline are replaced with a single space. A
4621: backslash character and an immediately following hash character are
4622: replaced with a single hash character. Otherwise, the backslash is
4623: passed as is. In a variable assignment, any hash character that is
4624: not preceded by a backslash starts a comment that continues upto the
4625: end of the logical line.</p>
4626: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4627: the only way to create a variable consisting of a single backslash
4628: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4629: <p>So far for defining variables. The other thing you can do with
4630: variables is evaluating them. A variable is evaluated when it is
4631: part of the right side of the ``:='' or the ``!='' operator, or
4632: directly before executing a shell command which the variable is part
1.29 dholland 4633: 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 4634: is, variables are not evaluated until there's no other way. The
4635: ``modifiers'' mentioned in the man page also evaluate the
4636: variable.</p>
4637: <p>Some of the modifiers split the string into words and then
4638: operate on the words, others operate on the string as a whole. When
4639: a string is split into words, it is split as you would expect
1.29 dholland 4640: 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 4641: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.1 dsieger 4642: loop does not follow the shell quoting rules but splits at sequences
4643: of whitespace.</p>
4644: <p>There are several types of variables that should be handled
4645: differently. Strings and two types of lists.</p>
1.41 asau 4646: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4647: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4648: characters. Nevertheless, you should restrict yourself to only
4649: using printable characters. Examples are
4650: <code class="varname">PREFIX</code> and
4651: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4652: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4653: are never exported to any shell command. Their elements are
4654: separated by whitespace. Therefore, the elements themselves cannot
4655: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4656: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4657: Examples are <code class="varname">DEPENDS</code> and
4658: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4659: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4660: may be exported to a shell command. Their elements can contain any
4661: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4662: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4663: <code class="varname">DISTFILES</code> and
4664: <code class="varname">MASTER_SITES</code>.</p></li>
4665: </ul></div>
1.41 asau 4666: <div class="sect2">
1.1 dsieger 4667: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4668: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4669: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4670: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4671: are reserved for use by the pkgsrc infrastructure. They shall
4672: not be used by package
4673: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4674: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4675: lowercase variable names for the iteration
4676: variables.</p></li>
1.23 wiz 4677: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4678: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4679: <code class="varname">DISTFILES</code>.</p></li>
4680: </ul></div>
4681: </div>
4682: </div>
1.41 asau 4683: <div class="sect1">
1.1 dsieger 4684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4685: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 4686: <p>This section presents you with some code snippets you should
4687: use in your own code. If you don't find anything appropriate here,
4688: you should test your code and add it here.</p>
1.41 asau 4689: <div class="sect2">
1.1 dsieger 4690: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4691: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 4692: <pre class="programlisting">
4693: STRING= foo * bar `date`
4694: INT_LIST= # empty
4695: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4696: EXT_LIST= # empty
4697: ANOTHER_EXT_LIST= a=b c=d
4698:
4699: INT_LIST+= ${STRING} # 1
4700: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4701: EXT_LIST+= ${STRING:Q} # 3
4702: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
4703: </pre>
4704: <p>When you add a string to an external list (example 3), it
4705: must be quoted. In all other cases, you must not add a quoting
4706: level. You must not merge internal and external lists, unless you
4707: are sure that all entries are correctly interpreted in both
4708: lists.</p>
4709: </div>
1.41 asau 4710: <div class="sect2">
1.1 dsieger 4711: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4712: <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 4713: <pre class="programlisting">
4714: EXT_LIST= # empty
4715: .for i in ${INT_LIST}
4716: EXT_LIST+= ${i:Q}""
4717: .endfor
4718: </pre>
4719: <p>This code converts the internal list
4720: <code class="varname">INT_LIST</code> into the external list
4721: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4722: are unquoted they must be quoted here. The reason for appending
4723: <code class="varname">""</code> is explained below.</p>
4724: </div>
1.41 asau 4725: <div class="sect2">
1.1 dsieger 4726: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4727: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 4728: <p>Sometimes you may want to print an arbitrary string. There
4729: are many ways to get it wrong and only few that can handle every
4730: nastiness.</p>
4731: <pre class="programlisting">
4732: STRING= foo bar < > * `date` $$HOME ' "
4733: EXT_LIST= string=${STRING:Q} x=second\ item
4734:
4735: all:
4736: echo ${STRING} # 1
4737: echo "${STRING}" # 2
4738: echo "${STRING:Q}" # 3
4739: echo ${STRING:Q} # 4
4740: echo x${STRING:Q} | sed 1s,.,, # 5
4741: printf "%s\\n" ${STRING:Q}"" # 6
4742: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
4743: </pre>
4744: <p>Example 1 leads to a syntax error in the shell, as the
4745: characters are just copied.</p>
4746: <p>Example 2 leads to a syntax error too, and if you leave out
4747: the last " character from <code class="varname">${STRING}</code>,
1.29 dholland 4748: <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 4749: variable would be evaluated, too.</p>
4750: <p>Example 3 outputs each space character preceded by a
4751: backslash (or not), depending on the implementation of the
1.29 dholland 4752: <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 4753: <p>Example 4 handles correctly every string that does not start
4754: with a dash. In that case, the result depends on the
1.29 dholland 4755: 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 4756: guarantee that your input does not start with a dash, this form is
4757: appropriate.</p>
4758: <p>Example 5 handles even the case of a leading dash
4759: correctly.</p>
4760: <p>Example 6 also works with every string and is the
4761: light-weight solution, since it does not involve a pipe, which has
4762: its own problems.</p>
4763: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4764: because the quoting has already been done when adding elements to
4765: the list.</p>
4766: <p>As internal lists shall not be passed to the shell, there is
4767: no example for it.</p>
4768: </div>
1.41 asau 4769: <div class="sect2">
1.1 dsieger 4770: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4771: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 4772: <p>There are many possible sources of wrongly quoted variables.
4773: This section lists some of the commonly known ones.</p>
1.41 asau 4774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4775: <li class="listitem">
1.1 dsieger 4776: <p>Whenever you use the value of a list, think
4777: about what happens to leading or trailing whitespace. If the
4778: list is a well-formed shell expression, you can apply the
4779: <code class="varname">:M*</code> modifier to strip leading and trailing
4780: whitespace from each word. The <code class="varname">:M</code> operator
4781: first splits its argument according to the rules of the shell,
4782: and then creates a new list consisting of all words that match
4783: the shell glob expression <code class="varname">*</code>, that is: all.
4784: One class of situations where this is needed is when adding a
4785: variable like <code class="varname">CPPFLAGS</code> to
4786: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4787: invokes other configure scripts, it strips the leading and
4788: trailing whitespace from the variable and then passes it to the
4789: other configure scripts. But these configure scripts expect the
4790: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4791: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4792: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4793: here is how we do it:</p>
4794: <pre class="programlisting">
4795: CPPFLAGS= # empty
4796: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4797: CPPFLAGS+= ${MY_CPPFLAGS}
4798:
4799: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4800:
4801: all:
4802: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4803: echo x${CONFIGURE_ARGS}x # properly trimmed
4804: </pre>
4805: </li>
1.23 wiz 4806: <li class="listitem"><p>The example above contains one bug: The
1.1 dsieger 4807: <code class="varname">${PREFIX}</code> is a properly quoted shell
4808: expression, but there is the C compiler after it, which also
4809: expects a properly quoted string (this time in C syntax). The
4810: version above is therefore only correct if
4811: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4812: or double quotes. If you want to allow these, you have to add
4813: another layer of quoting to each variable that is used as a C
4814: string literal. You cannot use the <code class="varname">:Q</code>
4815: operator for it, as this operator only works for the
4816: shell.</p></li>
1.23 wiz 4817: <li class="listitem">
1.1 dsieger 4818: <p>Whenever a variable can be empty, the
4819: <code class="varname">:Q</code> operator can have surprising results. Here
4820: are two completely different cases which can be solved with the
4821: same trick.</p>
4822: <pre class="programlisting">
4823: EMPTY= # empty
4824: empty_test:
4825: for i in a ${EMPTY:Q} c; do \
4826: echo "$$i"; \
4827: done
4828:
4829: for_test:
4830: .for i in a:\ a:\test.txt
4831: echo ${i:Q}
4832: echo "foo"
4833: .endfor
4834: </pre>
4835: <p>The first example will only print two of the three lines
4836: we might have expected. This is because
4837: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4838: the shell cannot see. The workaround is to write
4839: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4840: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4841: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4842: <p>The second example will only print three lines instead of
4843: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4844: This is because the backslash of the value
4845: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.29 dholland 4846: <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
4847: <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 4848: <code class="varname">${i:Q}""</code>.</p>
4849: </li>
4850: </ul></div>
4851: </div>
1.41 asau 4852: <div class="sect2">
1.1 dsieger 4853: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4854: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 4855: <p>The pkgsrc bmake program does not handle the following
4856: assignment correctly. In case <code class="varname">_othervar_</code>
4857: contains a ``-'' character, one of the closing braces is included
4858: in <code class="varname">${VAR}</code> after this code executes.</p>
4859: <pre class="programlisting">
4860: VAR:= ${VAR:N${_othervar_:C/-//}}
4861: </pre>
4862: <p>For a more complex code snippet and a workaround, see the
4863: 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
4864: <code class="varname">bug1</code>.</p>
4865: </div>
4866: </div>
4867: </div>
1.41 asau 4868: <div class="chapter">
1.1 dsieger 4869: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4870: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 4871: <div class="toc">
4872: <p><b>Table of Contents</b></p>
4873: <dl>
1.6 rillig 4874: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 4875: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4876: <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 4877: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4878: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 4879: <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 4880: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
4881: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1 dsieger 4882: </dl>
4883: </div>
4884: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4885: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4886: the package (relative to the <code class="filename">${PREFIX}</code>
4887: directory it's been installed in) plus some additional statements
1.29 dholland 4888: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 4889: This chapter addresses some issues that need attention when
4890: dealing with the <code class="filename">PLIST</code> file (or files, see
4891: below!).</p>
1.41 asau 4892: <div class="sect1">
1.1 dsieger 4893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4894: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 4895: <p>Be sure to add a RCS ID line as the first thing in any
4896: <code class="filename">PLIST</code> file you write:</p>
4897: <pre class="programlisting">
4898: @comment $NetBSD$
4899: </pre>
4900: </div>
1.41 asau 4901: <div class="sect1">
1.1 dsieger 4902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4903: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4904: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4905: to output a PLIST that matches any new files since the package
1.10 hubertf 4906: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.1 dsieger 4907: more information on this target.</p>
4908: </div>
1.41 asau 4909: <div class="sect1">
1.1 dsieger 4910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 4911: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4912: </h2></div></div></div>
4913: <p>If you have used any of the *-dirs packages, as explained in
1.10 hubertf 4914: <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
4915: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1 dsieger 4916: <code class="varname">@comment</code>s instead of real
4917: <code class="varname">@dirrm</code> lines. You can also do this for
4918: specific directories and files, so that the results of that
4919: command are very close to reality. This helps <span class="emphasis"><em>a
4920: lot</em></span> during the update of packages.</p>
4921: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4922: of AWK patterns and actions that are used to filter the output of
4923: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4924: scripting you like to it, but be careful with quoting.</p>
4925: <p>For example, to get all files inside the
4926: <code class="filename">libdata/foo</code> directory removed from the
4927: resulting PLIST:</p>
4928: <pre class="programlisting">
4929: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
4930: </pre>
4931: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4932: to a specific (shared) directory converted to
4933: <code class="varname">@comment</code>s:</p>
4934: <pre class="programlisting">
4935: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
4936: </pre>
4937: </div>
1.41 asau 4938: <div class="sect1">
1.1 dsieger 4939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4940: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4941: <p>A number of variables are substituted automatically in
4942: PLISTs when a package is installed on a system. This includes the
4943: following variables:</p>
1.41 asau 4944: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4945: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4946: <dd>
4947: <p>Some packages like emacs and perl embed information
4948: about which architecture they were built on into the
4949: pathnames where they install their files. To handle this
4950: case, PLIST will be preprocessed before actually used, and
4951: the symbol
1.23 wiz 4952: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4953: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4954: same is done if the string
4955: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4956: PLIST somewhere - use this on packages that have GNU
4957: autoconf-created configure scripts.</p>
1.41 asau 4958: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4959: <h3 class="title">Legacy note</h3>
4960: <p>There used to be a symbol
1.23 wiz 4961: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4962: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4963: -m</strong></span>, but that's no longer supported and has
4964: been removed.</p>
4965: </div>
4966: </dd>
4967: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4968: <dd>
4969: <p>Some packages want to embed the OS name and version
4970: into some paths. To do this, use these variables in the
4971: <code class="filename">PLIST</code>:
4972: </p>
1.41 asau 4973: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4974: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">“<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</span></p></li>
4975: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">“<span class="quote">solaris</span>”</span>)</p></li>
4976: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.1 dsieger 4977: </ul></div>
4978: </dd>
4979: </dl></div>
4980: <p>For a complete list of values which are replaced by
4981: default, please look in <code class="filename">bsd.pkg.mk</code> (and
4982: search for <code class="varname">PLIST_SUBST</code>).</p>
4983: <p>If you want to change other variables not listed above, you
4984: can add variables and their expansions to this variable in the
1.10 hubertf 4985: 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 4986: <pre class="programlisting">
4987: PLIST_SUBST+= SOMEVAR="somevalue"
4988: </pre>
1.23 wiz 4989: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4990: in the <code class="filename">PLIST</code> with
1.23 wiz 4991: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4992: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4993: the common case of conditionally including some
4994: <code class="filename">PLIST</code> entries. It can be done by adding
4995: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4996: setting the corresponding <code class="varname">PLIST.foo</code> variable
4997: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4998: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4999: in the <code class="filename">PLIST</code> with either
1.23 wiz 5000: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5001: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 5002: For example, in <code class="filename">Makefile</code>:</p>
5003: <pre class="programlisting">
5004: PLIST_VARS+= foo
5005: .if <em class="replaceable"><code>condition</code></em>
5006: PLIST.foo= yes
5007: .else
5008: </pre>
5009: <p>And then in <code class="filename">PLIST</code>:</p>
5010: <pre class="programlisting">
5011: @comment $NetBSD$
5012: bin/bar
5013: man/man1/bar.1
5014: ${PLIST.foo}bin/foo
5015: ${PLIST.foo}man/man1/foo.1
5016: ${PLIST.foo}share/bar/foo.data
5017: ${PLIST.foo}@dirrm share/bar
5018: </pre>
1.1 dsieger 5019: </div>
1.41 asau 5020: <div class="sect1">
1.1 dsieger 5021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5022: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5023: <p>Man pages should be installed in compressed form if
5024: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5025: and uncompressed otherwise. To handle this in the
1.23 wiz 5026: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 5027: appended/removed automatically for man pages according to
5028: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5029: or not, see above for details. This modification of the
5030: <code class="filename">PLIST</code> file is done on a copy of it, not
5031: <code class="filename">PLIST</code> itself.</p>
5032: </div>
1.41 asau 5033: <div class="sect1">
1.1 dsieger 5034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5035: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5036: </h2></div></div></div>
5037: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5038: in generating the binary package, set the variable
5039: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.29 dholland 5040: 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 5041: important. The default for <code class="varname">PLIST_SRC</code> is
5042: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5043: </div>
1.41 asau 5044: <div class="sect1">
1.1 dsieger 5045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5046: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5047: <p>Some packages decide to install a different set of files based on
5048: the operating system being used. These differences can be
5049: automatically handled by using the following files:</p>
1.41 asau 5050: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5051: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5052: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5053: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5054: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5055: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 5056: </ul></div>
5057: </div>
1.41 asau 5058: <div class="sect1">
1.1 dsieger 5059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5060: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.23 wiz 5061: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 5062: multiple (and unrelated) packages install files. These
1.22 jakllsch 5063: directories were problematic because you had to add special
5064: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 5065: centralized package handle them.</p>
1.22 jakllsch 5066: <p>In pkgsrc, it is now easy: Each package should create
5067: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5068: will remove any directories left empty after uninstalling a
5069: package.</p>
5070: <p>If a package needs an empty directory to work, create
5071: the directory during installation as usual, and also add an
5072: entry to the PLIST:
5073: </p>
1.1 dsieger 5074: <pre class="programlisting">
1.22 jakllsch 5075: @pkgdir path/to/empty/directory
1.1 dsieger 5076: </pre>
1.22 jakllsch 5077: <p>
5078: </p>
1.1 dsieger 5079: </div>
5080: </div>
1.41 asau 5081: <div class="chapter">
1.1 dsieger 5082: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5083: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5084: <div class="toc">
5085: <p><b>Table of Contents</b></p>
5086: <dl>
1.6 rillig 5087: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 5088: <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 5089: <dd><dl>
1.6 rillig 5090: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 5091: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5092: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5093: and
5094: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5095: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5096: </dl></dd>
1.23 wiz 5097: <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 5098: <dd><dl>
1.23 wiz 5099: <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 5100: <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 5101: </dl></dd>
5102: </dl>
5103: </div>
5104: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5105: are seen by a package's configure and build processes. This is implemented
5106: in a two step process:</p>
1.23 wiz 5107: <div class="orderedlist"><ol class="orderedlist" type="1">
5108: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 5109: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5110: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 5111: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 5112: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5113: <code class="option">-L${LOCALBASE}/lib</code> into references to
5114: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5115: native compiler on some operating systems look like GCC, so that
5116: packages that expect GCC won't require modifications to build with
5117: those native compilers.</p></li>
5118: </ol></div>
5119: <p>This normalizes the environment in which a package is built so that the
5120: package may be built consistently despite what other software may be
5121: installed. Please note that the normal system header and library paths,
5122: e.g. <code class="filename">/usr/include</code>,
5123: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5124: designed to insulate the package build from non-system-supplied
5125: software.</p>
1.41 asau 5126: <div class="sect1">
1.1 dsieger 5127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5128: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5129: <p>The process of converting packages to use the buildlink3
1.23 wiz 5130: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 5131: The things to keep in mind are:</p>
1.23 wiz 5132: <div class="orderedlist"><ol class="orderedlist" type="1">
5133: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 5134: instead of the actual toolchain. Some packages are tricky,
5135: and the only way to know for sure is the check
5136: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5137: wrappers are being invoked.</p></li>
1.23 wiz 5138: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 5139: the package Makefile, e.g. Java VMs, standalone shells,
5140: etc., because the code to symlink files into
5141: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 5142: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 5143: </p></li>
1.23 wiz 5144: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 5145: <code class="filename">buildlink3.mk</code> files that you list in a
5146: package's Makefile are added as dependencies for that package.
5147: </p></li>
5148: </ol></div>
5149: <p>If a dependency on a particular package is required for its libraries and
5150: headers, then we replace:</p>
5151: <pre class="programlisting">
5152: DEPENDS+= foo>=1.1.0:../../category/foo
5153: </pre>
5154: <p>with</p>
5155: <pre class="programlisting">
5156: .include "../../category/foo/buildlink3.mk"
5157: </pre>
5158: <p>The buildlink3.mk files usually define the required dependencies.
5159: If you need a newer version of the dependency when using buildlink3.mk
5160: files, then you can define it in your Makefile; for example:</p>
5161: <pre class="programlisting">
5162: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5163: .include "../../category/foo/buildlink3.mk"
5164: </pre>
5165: <p>There are several <code class="filename">buildlink3.mk</code>
5166: files in <code class="filename">pkgsrc/mk</code>
5167: that handle special package issues:</p>
1.41 asau 5168: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5169: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 5170: the native or a pkgsrc Berkeley DB implementation based on
5171: the values of <code class="varname">BDB_ACCEPTED</code> and
5172: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 5173: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 5174: comes with neither Curses nor NCurses, this will take care
5175: 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 5176: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 5177: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5178: adding a dependency on Heimdal or MIT-krb5 for packages that
5179: require a Kerberos 5 implementation.</p></li>
1.23 wiz 5180: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 5181: system-provided Motif installation or adds a dependency on
1.45 obache 5182: <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 5183: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 5184: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5185: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 5186: which Motif version will be used.</p></li>
1.55 ryoon 5187: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 5188: system-provided GNU readline or editline (libedit) installation,
1.55 ryoon 5189: 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>,
5190: <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
5191: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5192: If your package really needs GNU readline library, its Makefile
5193: should include <code class="filename">devel/readline/buildlink3.mk</code>
5194: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 5195: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 5196: variables that may be used by packages that use the
5197: Open Sound System (OSS) API.</p></li>
1.23 wiz 5198: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 5199: any of the Postgres versions in the variable
5200: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5201: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 5202: the file for more information.</p></li>
1.23 wiz 5203: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 5204: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5205: 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 5206: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 5207: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5208: library.</p></li>
5209: </ul></div>
5210: <p>The comments in those <code class="filename">buildlink3.mk</code>
5211: files provide a more complete
5212: description of how to use them properly.</p>
5213: </div>
1.41 asau 5214: <div class="sect1">
1.1 dsieger 5215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5216: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5217: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5218: included by Makefiles to indicate the need to compile and link
5219: against header files and libraries provided by the package. A
5220: <code class="filename">buildlink3.mk</code> file should always provide
5221: enough information to add the correct type of dependency
5222: relationship and include any other
5223: <code class="filename">buildlink3.mk</code> files that it needs to find
5224: headers and libraries that it needs in turn.</p>
5225: <p>To generate an initial <code class="filename">buildlink3.mk</code>
5226: 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>
5227: package is highly recommended. For most packages, the following
5228: command will generate a good starting point for
5229: <code class="filename">buildlink3.mk</code> files:</p>
5230: <pre class="screen">
5231: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5232: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5233: </pre>
1.41 asau 5234: <div class="sect2">
1.1 dsieger 5235: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5236: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5237: <p>The following real-life example
5238: <code class="filename">buildlink3.mk</code> is taken
5239: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5240: <pre class="programlisting">
1.18 snj 5241: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5242:
1.18 snj 5243: BUILDLINK_TREE+= tiff
1.1 dsieger 5244:
1.18 snj 5245: .if !defined(TIFF_BUILDLINK3_MK)
5246: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5247:
1.18 snj 5248: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5249: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5250: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5251:
5252: .include "../../devel/zlib/buildlink3.mk"
5253: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 5254: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5255:
1.18 snj 5256: BUILDLINK_TREE+= -tiff
1.1 dsieger 5257: </pre>
5258: <p>The header and footer manipulate
1.18 snj 5259: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 5260: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 5261: the dependency tree.</p>
5262: <p>The main section is protected from multiple inclusion
1.1 dsieger 5263: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5264: added. Several important variables are set in the section:</p>
1.41 asau 5265: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5266: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5267: is the actual dependency recorded in the installed
5268: package; this should always be set using
1.10 hubertf 5269: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5270: we're appending to any pre-existing list of values. This
5271: variable should be set to the first version of the
1.26 wiz 5272: package that had an backwards-incompatible API change.
1.1 dsieger 5273: </p></li>
1.23 wiz 5274: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5275: is the location of the <em class="replaceable"><code>pkg</code></em>
5276: pkgsrc directory.</p></li>
1.23 wiz 5277: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5278: (not shown above) controls whether we use
5279: <code class="varname">BUILD_DEPENDS</code> or
5280: <code class="varname">DEPENDS</code> to add the dependency on
5281: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5282: selected by setting
5283: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5284: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 5285: used.</p></li>
1.23 wiz 5286: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5287: and
5288: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5289: (not shown above) are lists of subdirectories of
5290: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5291: to add to the header and library search paths. These
1.23 wiz 5292: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 5293: respectively.</p></li>
1.23 wiz 5294: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5295: (not shown above) is the list of preprocessor flags to add
5296: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 5297: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 5298: should be avoided and instead be handled using
5299: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5300: above.</p></li>
5301: </ul></div>
5302: <p>The following variables are all optionally defined within
5303: this second section (protected against multiple inclusion) and
5304: control which package files are symlinked into
5305: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5306: transformed during the symlinking:</p>
1.41 asau 5307: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5308: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5309: (not shown above) is a shell glob pattern relative to
5310: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5311: to be symlinked into
5312: <code class="filename">${BUILDLINK_DIR}</code>,
5313: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 5314: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5315: (not shown above) is a shell pipeline that
5316: outputs to stdout a list of files relative to
5317: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5318: The resulting files are to be symlinked
5319: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5320: this takes the <code class="filename">+CONTENTS</code> of a
5321: <em class="replaceable"><code>pkg</code></em> and filters it through
5322: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 5323: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5324: (not shown above) is a filter command that filters
5325: <code class="filename">+CONTENTS</code> input into a list of files
5326: relative to
5327: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5328: on stdout. By default for overwrite packages,
5329: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5330: outputs the contents of the <code class="filename">include</code>
5331: and <code class="filename">lib</code> directories in the package
5332: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5333: it outputs any libtool archives in
5334: <code class="filename">lib</code> directories.</p></li>
1.23 wiz 5335: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5336: (not shown above) is a list of sed arguments used to
5337: transform the name of the source filename into a
1.10 hubertf 5338: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5339: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5340: </ul></div>
1.18 snj 5341: <p>This section can additionally include any
1.1 dsieger 5342: <code class="filename">buildlink3.mk</code> needed for
5343: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5344: Including these <code class="filename">buildlink3.mk</code> files
5345: means that the headers and libraries for these
5346: dependencies are also symlinked into
5347: <code class="filename">${BUILDLINK_DIR}</code>
5348: whenever the <em class="replaceable"><code>pkg</code></em>
5349: <code class="filename">buildlink3.mk</code>
1.18 snj 5350: file is included. Dependencies are only added for directly
5351: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 5352: <p>When providing a <code class="filename">buildlink3.mk</code> and
5353: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 5354: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 5355: header files are automatically exposed when the package is
5356: use.</p>
5357: <p>In particular, if only an executable
5358: (<code class="filename">bin/foo</code>) is linked against a library, that
5359: library does not need to be propagated in the
5360: <code class="filename">buildlink3.mk</code> file.</p>
5361: <p>The following steps should help you decide if a
5362: <code class="filename">buildlink3.mk</code> file needs to be included:
5363: </p>
5364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5365: <li class="listitem"><p>Look at the installed header files: What
5366: headers do they include? The packages providing these files
5367: must be buildlinked.</p></li>
1.49 wiz 5368: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5369: libraries and look against what other libraries they link.
5370: Some of the packages providing these probably need to be
5371: buildlinked; however, it's not automatic, since e.g. GTK on
5372: some systems pulls in the X libraries, so they will show up in
5373: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 5374: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 5375: used as a hint.</p></li>
1.47 wiz 5376: </ul></div>
5377: <p>
5378: </p>
1.1 dsieger 5379: </div>
1.41 asau 5380: <div class="sect2">
1.1 dsieger 5381: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 5382: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 5383: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5384: and
5385: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5386: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5387: <p>These two variables differ in that one describes source
5388: compatibility (API) and the other binary compatibility (ABI).
5389: The difference is that a change in the API breaks compilation of
5390: programs while changes in the ABI stop compiled programs from
5391: running.</p>
5392: <p>Changes to the
1.27 wiz 5393: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5394: variable in a <code class="filename">buildlink3.mk</code> file happen
5395: very rarely. One possible reason is that all packages depending
5396: on this already need a newer version. In case it is bumped see
5397: the description below.</p>
5398: <p>The most common example of an ABI change is that the major
5399: version of a shared library is increased. In this case,
5400: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5401: should be adjusted to require at least the new package version.
5402: Then the packages that depend on this package need their
5403: <code class="varname">PKGREVISION</code>s increased and, if they have
5404: <code class="filename">buildlink3.mk</code> files, their
5405: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5406: adjusted, too. This is needed so pkgsrc will require the correct
5407: package dependency and not settle for an older one when building
5408: the source.</p>
1.10 hubertf 5409: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.26 wiz 5410: more information about dependencies on other packages,
5411: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 5412: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5413: <p>Please take careful consideration before adjusting
5414: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5415: or
5416: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5417: as we don't want to cause unneeded package deletions and
5418: rebuilds. In many cases, new versions of packages work just
5419: fine with older dependencies.</p>
5420: <p>Also it is not needed to set
1.26 wiz 5421: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5422: when it is identical to
1.1 dsieger 5423: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5424: </div>
5425: </div>
1.41 asau 5426: <div class="sect1">
1.1 dsieger 5427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5428: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5429: <p>Some packages in pkgsrc install headers and libraries that
5430: coincide with headers and libraries present in the base system.
5431: Aside from a <code class="filename">buildlink3.mk</code> file, these
5432: packages should also include a <code class="filename">builtin.mk</code>
5433: file that includes the necessary checks to decide whether using
5434: the built-in software or the pkgsrc software is
5435: appropriate.</p>
5436: <p>The only requirements of a builtin.mk file for
5437: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 5438: <div class="orderedlist"><ol class="orderedlist" type="1">
5439: <li class="listitem"><p>It should set
1.1 dsieger 5440: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5441: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 5442: after it is included.</p></li>
1.23 wiz 5443: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 5444: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5445: which is already set before the
5446: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 5447: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 5448: is <span class="emphasis"><em>very</em></span> important and takes careful
5449: attention to <code class="filename">Makefile</code> coding.</p></li>
5450: </ol></div>
1.41 asau 5451: <div class="sect2">
1.1 dsieger 5452: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5453: <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 5454: <p>The following is the recommended template for builtin.mk
5455: files:</p>
5456: <pre class="programlisting">
5457: .if !defined(IS_BUILTIN.foo)
5458: #
5459: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5460: # genuinely exists in the system or not.
5461: #
5462: IS_BUILTIN.foo?= no
5463:
5464: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5465: # version can be determined.
5466: #
5467: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5468: BUILTIN_PKG.foo?= foo-1.0
5469: . endif
5470: .endif # IS_BUILTIN.foo
5471:
5472: .if !defined(USE_BUILTIN.foo)
5473: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5474: . if defined(BUILTIN_PKG.foo)
5475: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5476: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5477: USE_BUILTIN.foo!= \
5478: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5479: && ${ECHO} "yes" || ${ECHO} "no"
5480: . endif
5481: . endfor
5482: . endif
5483: .endif # USE_BUILTIN.foo
5484:
5485: CHECK_BUILTIN.foo?= no
5486: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5487: #
5488: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5489: # "yes" or "no".
5490: #
5491: .endif # CHECK_BUILTIN.foo
5492: </pre>
5493: <p>The first section sets
5494: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5495: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5496: in the base system. This should not be a base system software
5497: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5498: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5499: included as part of the base system. This variable is only
5500: used internally within the <code class="filename">builtin.mk</code>
5501: file.</p>
5502: <p>The second section sets
5503: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5504: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5505: system if it exists (if
5506: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5507: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5508: within the <code class="filename">builtin.mk</code> file.</p>
5509: <p>The third section sets
5510: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5511: and is <span class="emphasis"><em>required</em></span> in all
5512: <code class="filename">builtin.mk</code> files. The code in this
5513: section must make the determination whether the built-in
5514: software is adequate to satisfy the dependencies listed in
5515: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5516: This is typically done by comparing
5517: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5518: against each of the dependencies in
5519: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5520: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5521: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5522: end of the <code class="filename">builtin.mk</code> file. Note that
5523: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5524: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5525: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5526: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5527: that the built-in version of the software is similar enough to
5528: be used as a replacement.</p>
5529: <p>The last section is guarded by
5530: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5531: and includes code that uses the value of
5532: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5533: set in the previous section. This typically includes, e.g.,
5534: adding additional dependency restrictions and listing additional
5535: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5536: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5537: </div>
1.41 asau 5538: <div class="sect2">
1.1 dsieger 5539: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5540: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5541: <p>When building packages, it's possible to choose whether to set
5542: a global preference for using either the built-in (native)
5543: version or the pkgsrc version of software to satisfy a
5544: dependency. This is controlled by setting
5545: <code class="varname">PREFER_PKGSRC</code> and
5546: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5547: 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 5548: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5549: use the pkgsrc versions of software, while
5550: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5551: built-in versions. Preferences are determined by the most
5552: specific instance of the package in either
5553: <code class="varname">PREFER_PKGSRC</code> or
5554: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5555: in neither or in both variables, then
5556: <code class="varname">PREFER_PKGSRC</code> has precedence over
5557: <code class="varname">PREFER_NATIVE</code>. For example, to require
5558: using pkgsrc versions of software for all but the most basic
5559: bits on a NetBSD system, you can set:</p>
5560: <pre class="programlisting">
5561: PREFER_PKGSRC= yes
5562: PREFER_NATIVE= getopt skey tcp_wrappers
5563: </pre>
5564: <p>A package <span class="emphasis"><em>must</em></span> have a
5565: <code class="filename">builtin.mk</code>
5566: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5567: otherwise it is simply ignored in that list.</p>
5568: </div>
5569: </div>
5570: </div>
1.41 asau 5571: <div class="chapter">
1.1 dsieger 5572: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5573: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5574: <div class="toc">
5575: <p><b>Table of Contents</b></p>
5576: <dl>
1.6 rillig 5577: <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 5578: <dd><dl>
1.6 rillig 5579: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5580: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5581: </dl></dd>
1.6 rillig 5582: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5583: <dd><dl>
1.23 wiz 5584: <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 5585: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5586: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5587: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5588: </dl></dd>
5589: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5590: <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>
5591: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5592: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5593: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5594: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5595: <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 5596: </dl>
5597: </div>
5598: <p>This chapter describes the framework known as
5599: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5600: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5601: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5602: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5603: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5604: provided that packages are correctly designed.</p></li>
1.23 wiz 5605: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5606: <li class="listitem"><p>Registration of system users and groups.</p></li>
5607: <li class="listitem"><p>Registration of system shells.</p></li>
5608: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5609: </ul></div>
5610: <p>The following sections inspect each of the above points in detail.</p>
5611: <p>You may be thinking that many of the things described here could be
5612: easily done with simple code in the package's post-installation target
5613: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5614: as the code in them is only executed when building from source. Machines
5615: using binary packages could not benefit from it at all (as the code itself
5616: could be unavailable). Therefore, the only way to achieve any of the items
5617: described above is by means of the installation scripts, which are
5618: automatically generated by pkginstall.</p>
1.41 asau 5619: <div class="sect1">
1.1 dsieger 5620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5621: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5622: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5623: of files and directories that belong to a package. The names used in it
5624: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5625: which means that it cannot register files outside this directory (absolute
5626: path names are not allowed). Despite this restriction, some packages need
5627: to install files outside this location; e.g., under
5628: <code class="filename">${VARBASE}</code> or
5629: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5630: is to create such files during installation time by using
5631: installation scripts.</p>
5632: <p>The generic installation scripts are shell scripts that can
5633: contain arbitrary code. The list of scripts to execute is taken from
5634: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5635: <code class="filename">INSTALL</code>. A similar variable exists for package
5636: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5637: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5638: commands, so they have the potential to create and manage files
5639: anywhere in the file system.</p>
5640: <p>Using these general installation files is not recommended, but
5641: may be needed in some special cases. One reason for avoiding them is
5642: that the user has to trust the packager that there is no unwanted or
5643: simply erroneous code included in the installation script. Also,
5644: previously there were many similar scripts for the same functionality,
5645: and fixing a common error involved finding and changing all of
5646: them.</p>
5647: <p>The pkginstall framework offers another, standardized way. It
5648: provides generic scripts to abstract the manipulation of such files
5649: and directories based on variables set in the package's
5650: <code class="filename">Makefile</code>. The rest of this section describes
5651: these variables.</p>
1.41 asau 5652: <div class="sect2">
1.1 dsieger 5653: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5654: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5655: <p>The following variables can be set to request the creation of
5656: directories anywhere in the file system:</p>
1.41 asau 5657: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5658: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5659: contain a list of directories that should be created and should attempt
5660: to be destroyed by the installation scripts. The difference between
5661: the two is that the latter prompts the administrator to remove any
5662: directories that may be left after deinstallation (because they were
5663: not empty), while the former does not.</p></li>
1.23 wiz 5664: <li class="listitem">
1.1 dsieger 5665: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5666: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5667: which directories should be created and should attempt to be destroyed
5668: by the installation scripts. Each tuple holds the following values,
5669: separated by spaces: the directory name, its owner, its group and its
5670: numerical mode. For example:</p>
5671: <pre class="programlisting">
5672: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5673: </pre>
5674: <p>The difference between the two is exactly the same as their
5675: non-<code class="varname">PERMS</code> counterparts.</p>
5676: </li>
5677: </ul></div>
5678: </div>
1.41 asau 5679: <div class="sect2">
1.1 dsieger 5680: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5681: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5682: <p>Creating non-empty files outside the installation prefix is tricky
5683: because the <code class="filename">PLIST</code> forces all files to be inside it.
5684: To overcome this problem, the only solution is to extract the file in the
5685: known place (i.e., inside the installation prefix) and copy it to the
5686: appropriate location during installation (done by the installation scripts
5687: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5688: file</em></span> in the following paragraphs, which describe the variables
5689: that can be used to automatically and consistently handle files outside the
5690: installation prefix:</p>
1.41 asau 5691: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5692: <li class="listitem">
1.1 dsieger 5693: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5694: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5695: During installation time, the master file is copied to the target one
5696: if and only if the latter does not exist. Upon deinstallation, the
5697: target file is removed provided that it was not modified by the
5698: installation.</p>
5699: <p>The difference between the two is that the latter prompts the
5700: administrator to remove any files that may be left after
5701: deinstallation (because they were not empty), while the former does
5702: not.</p>
5703: </li>
1.23 wiz 5704: <li class="listitem">
1.1 dsieger 5705: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5706: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5707: files as well as their target locations. For each of them, it also
5708: specifies their owner, their group and their numeric permissions, in
5709: this order. For example:</p>
5710: <pre class="programlisting">
1.30 wiz 5711: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 dsieger 5712: </pre>
5713: <p>The difference between the two is exactly the same as their
5714: non-<code class="varname">PERMS</code> counterparts.</p>
5715: </li>
5716: </ul></div>
5717: </div>
5718: </div>
1.41 asau 5719: <div class="sect1">
1.1 dsieger 5720: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5721: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5722: <p>Configuration files are special in the sense that they are installed
5723: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5724: need special treatment during installation (most of which is automated by
5725: pkginstall). The main concept you must bear in mind is that files marked
5726: as configuration files are automatically copied to the right place (somewhere
5727: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5728: and only if</em></span> they didn't exist before. Similarly, they will not
5729: be removed if they have local modifications. This ensures that
5730: administrators never lose any custom changes they may have made.</p>
1.41 asau 5731: <div class="sect2">
1.1 dsieger 5732: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5733: <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 5734: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5735: specifies where configuration files shall be installed. Its contents are
5736: set based upon the following variables:</p>
1.41 asau 5737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5738: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5739: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5740: be overridden by the user to point to his preferred location (e.g.,
5741: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5742: Packages must not use it directly.</p></li>
1.23 wiz 5743: <li class="listitem">
1.1 dsieger 5744: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5745: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5746: for the package being built shall be installed. The definition of this
5747: variable only makes sense in the package's
5748: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5749: <p>As an example, consider the Apache package,
1.68 asau 5750: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.1 dsieger 5751: configuration files under the
5752: <code class="filename">httpd/</code> subdirectory of
5753: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5754: Makefile.</p>
5755: </li>
1.23 wiz 5756: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5757: variable that holds this package's configuration directory (if
5758: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5759: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5760: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5761: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5762: directory where the configuration files for the package identified by
5763: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5764: </ul></div>
5765: <p>Based on the above variables, pkginstall determines the value of
5766: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5767: variable that can be used within a package to refer to its configuration
5768: directory. The algorithm used to set its value is basically the
5769: following:</p>
1.23 wiz 5770: <div class="orderedlist"><ol class="orderedlist" type="1">
5771: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5772: its value is used.</p></li>
1.23 wiz 5773: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5774: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5775: <code class="filename">Makefile</code>, the resulting value is
5776: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5777: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5778: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5779: </ol></div>
5780: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 5781: 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
5782: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5783: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5784: </div>
1.41 asau 5785: <div class="sect2">
1.1 dsieger 5786: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5787: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5788: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5789: known place, you need to teach each package where it shall install its
5790: files. In some cases you will have to patch the package Makefiles to
5791: achieve it. If you are lucky, though, it may be as easy as passing an
5792: extra flag to the configuration script; this is the case of GNU Autoconf-
5793: generated files:</p>
5794: <pre class="programlisting">
5795: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5796: </pre>
5797: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5798: for</em></span> its configuration files, not where they will be originally
5799: installed (although the difference is never explicit,
5800: unfortunately).</p>
5801: </div>
1.41 asau 5802: <div class="sect2">
1.1 dsieger 5803: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5804: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5805: <p>As said before, pkginstall automatically handles configuration files.
5806: This means that <span class="strong"><strong>the packages themselves must not
5807: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5808: directly</strong></span>. Bad news is that many software installation scripts
5809: will, out of the box, mess with the contents of that directory. So what is
5810: the correct procedure to fix this issue?</p>
5811: <p>You must teach the package (usually by manually patching it) to
5812: install any configuration files under the examples hierarchy,
5813: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5814: <code class="filename">PLIST</code> registers them and the administrator always
5815: has the original copies available.</p>
5816: <p>Once the required configuration files are in place (i.e., under the
5817: examples hierarchy), the pkginstall framework can use them as master copies
5818: during the package installation to update what is in
5819: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5820: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5821: 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 5822: about their syntax and their purpose. Here is an example, taken from the
5823: <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>
5824: <pre class="programlisting">
5825: EGDIR= ${PREFIX}/share/doc/mutt/samples
5826: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5827: </pre>
5828: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5829: package and has no meaning outside it.</p>
5830: </div>
1.41 asau 5831: <div class="sect2">
1.1 dsieger 5832: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5833: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5834: <p>The automatic copying of config files can be toggled by setting the
5835: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5836: installation.</p>
5837: </div>
5838: </div>
1.41 asau 5839: <div class="sect1">
1.1 dsieger 5840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5841: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5842: <p>System startup scripts are special files because they must be
5843: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5844: 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 5845: can be used. However, pkginstall provides a special mechanism to handle
5846: these files.</p>
5847: <p>In order to provide system startup scripts, the package has
5848: to:</p>
1.23 wiz 5849: <div class="orderedlist"><ol class="orderedlist" type="1">
5850: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5851: the <code class="literal">.sh</code> suffix appended. Considering the
5852: <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
5853: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5854: <li class="listitem">
1.1 dsieger 5855: <p>Tell pkginstall to handle it, appending the name of the script,
5856: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5857: Continuing the previous example:</p>
5858: <pre class="programlisting">
5859: RCD_SCRIPTS+= cupsd
5860: </pre>
5861: </li>
5862: </ol></div>
5863: <p>Once this is done, pkginstall will do the following steps for each
5864: script in an automated fashion:</p>
1.23 wiz 5865: <div class="orderedlist"><ol class="orderedlist" type="1">
5866: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5867: substitutions described in the <code class="filename">FILES_SUBST</code>
5868: variable.</p></li>
1.23 wiz 5869: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5870: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5871: that this master file must be explicitly registered in the
5872: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5873: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5874: from the examples hierarchy into the system-wide startup scripts
5875: directory.</p></li>
5876: </ol></div>
1.41 asau 5877: <div class="sect2">
1.1 dsieger 5878: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5879: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5880: <p>The automatic copying of config files can be toggled by setting the
5881: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5882: installation. Note that the scripts will be always copied inside the
5883: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5884: matter what the value of this variable is.</p>
5885: </div>
5886: </div>
1.41 asau 5887: <div class="sect1">
1.1 dsieger 5888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5889: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 5890: <p>If a package needs to create special users and/or groups during
5891: installation, it can do so by using the pkginstall framework.</p>
5892: <p>Users can be created by adding entries to the
5893: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5894: syntax:</p>
5895: <pre class="programlisting">
5896: user:group
5897: </pre>
5898: <p>Further specification of user details may be done by setting
5899: per-user variables.
5900: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5901: numeric UID for the user.
5902: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5903: user's description or comment.
5904: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5905: user's home directory, and defaults to
5906: <code class="filename">/nonexistent</code> if not specified.
5907: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5908: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5909: not specified.</p>
5910: <p>Similarly, groups can be created by adding entries to the
5911: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5912: <pre class="programlisting">
5913: group
5914: </pre>
5915: <p>The numeric GID of the group may be set by defining
5916: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5917: <p>If a package needs to create the users and groups at an earlier
5918: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5919: either <code class="literal">configure</code> or <code class="literal">build</code> to
5920: indicate the phase before which the users and groups are created. In
5921: this case, the numeric UIDs and GIDs of the created users and groups
5922: are automatically hardcoded into the final installation scripts.</p>
5923: </div>
1.41 asau 5924: <div class="sect1">
1.1 dsieger 5925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5926: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 5927: <p>Packages that install system shells should register them in the shell
5928: database, <code class="filename">/etc/shells</code>, to make things easier to the
5929: administrator. This must be done from the installation scripts to keep
5930: binary packages working on any system. pkginstall provides an easy way to
5931: accomplish this task.</p>
5932: <p>When a package provides a shell interpreter, it has to set the
5933: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5934: add some hooks to the installation scripts to handle it. Consider the
5935: 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>
5936: <pre class="programlisting">
5937: PKG_SHELL= ${PREFIX}/bin/zsh
5938: </pre>
1.41 asau 5939: <div class="sect2">
1.1 dsieger 5940: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5941: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5942: <p>The automatic registration of shell interpreters can be disabled by
5943: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5944: environment variable to <code class="literal">NO</code>.</p>
5945: </div>
5946: </div>
1.41 asau 5947: <div class="sect1">
1.1 dsieger 5948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5949: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 5950: <p>Packages that install X11 fonts should update the database files
5951: that index the fonts within each fonts directory. This can easily be
5952: accomplished within the pkginstall framework.</p>
5953: <p>When a package installs X11 fonts, it must list the directories in
5954: which fonts are installed in the
5955: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5956: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5957: <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 5958: installation scripts to run the appropriate commands to update the fonts
5959: database files within each of those directories. For convenience, if the
5960: directory path is relative, it is taken to be relative to the package's
5961: 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>
5962: <pre class="programlisting">
1.67 wiz 5963: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5964: </pre>
1.41 asau 5965: <div class="sect2">
1.1 dsieger 5966: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5967: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5968: <p>The automatic update of fonts databases can be disabled by
5969: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5970: environment variable to <code class="literal">NO</code>.</p>
5971: </div>
5972: </div>
5973: </div>
1.41 asau 5974: <div class="chapter">
1.1 dsieger 5975: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5976: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 5977: <div class="toc">
5978: <p><b>Table of Contents</b></p>
5979: <dl>
1.6 rillig 5980: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 5981: <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 5982: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 5983: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5984: </dl>
5985: </div>
5986: <p>Many packages have the ability to be built to support different
5987: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5988: in pkgsrc that provides generic handling of those options that
5989: determine different ways in which the packages can be built. It's
5990: possible for the user to specify exactly which sets of options will be
5991: built into a package or to allow a set of global default options
5992: apply.</p>
1.7 rillig 5993: <p>There are two broad classes of behaviors that one might want to
5994: control via options. One is whether some particular feature is
5995: enabled in a program that will be built anyway, often by including or
5996: not including a dependency on some other package. The other is
5997: whether or not an additional program will be built as part of the
5998: package. Generally, it is better to make a split package for such
5999: additional programs instead of using options, because it enables
6000: binary packages to be built which can then be added separately. For
6001: example, the foo package might have minimal dependencies (those
6002: packages without which foo doesn't make sense), and then the foo-gfoo
6003: package might include the GTK frontend program gfoo. This is better
6004: than including a gtk option to foo that adds gfoo, because either that
6005: option is default, in which case binary users can't get foo without
6006: gfoo, or not default, in which case they can't get gfoo. With split
6007: packages, they can install foo without having GTK, and later decide to
6008: install gfoo (pulling in GTK at that time). This is an advantage to
6009: source users too, avoiding the need for rebuilds.</p>
6010: <p>Plugins with widely varying dependencies should usually be split
6011: instead of options.</p>
6012: <p>It is often more work to maintain split packages, especially if
6013: the upstream package does not support this. The decision of split
6014: vs. option should be made based on the likelihood that users will want
6015: or object to the various pieces, the size of the dependencies that are
6016: included, and the amount of work.</p>
6017: <p>A further consideration is licensing. Non-free parts, or parts
6018: that depend on non-free dependencies (especially plugins) should
6019: almost always be split if feasible.</p>
1.41 asau 6020: <div class="sect1">
1.1 dsieger 6021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6022: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6023: <p>Global default options are listed in
6024: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6025: that should be built into every package if that option is supported.
1.10 hubertf 6026: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6027: </div>
1.41 asau 6028: <div class="sect1">
1.1 dsieger 6029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6030: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6031: </h2></div></div></div>
6032: <p>The following example shows how
6033: <code class="filename">bsd.options.mk</code> should be used
6034: by the hypothetical ``wibble'' package, either in the package
6035: <code class="filename">Makefile</code>, or in a file,
6036: e.g. <code class="filename">options.mk</code>, that is included by the
6037: main package <code class="filename">Makefile</code>.</p>
6038: <pre class="programlisting">
6039: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6040: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6041: PKG_OPTIONS_OPTIONAL_GROUPS= database
6042: PKG_OPTIONS_GROUP.database= mysql pgsql
6043: PKG_SUGGESTED_OPTIONS= wibble-foo
6044: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6045: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6046:
6047: .include "../../mk/bsd.prefs.mk"
6048:
6049: # this package was previously named wibble2
6050: .if defined(PKG_OPTIONS.wibble2)
6051: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6052: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6053: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6054: .endif
6055:
6056: .include "../../mk/bsd.options.mk"
6057:
6058: # Package-specific option-handling
6059:
6060: ###
6061: ### FOO support
6062: ###
6063: .if !empty(PKG_OPTIONS:Mwibble-foo)
6064: CONFIGURE_ARGS+= --enable-foo
6065: .endif
6066:
6067: ###
6068: ### LDAP support
6069: ###
6070: .if !empty(PKG_OPTIONS:Mldap)
6071: . include "../../databases/openldap-client/buildlink3.mk"
6072: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6073: .endif
6074:
6075: ###
6076: ### database support
6077: ###
6078: .if !empty(PKG_OPTIONS:Mmysql)
6079: . include "../../mk/mysql.buildlink3.mk"
6080: .endif
6081: .if !empty(PKG_OPTIONS:Mpgsql)
6082: . include "../../mk/pgsql.buildlink3.mk"
6083: .endif
6084: </pre>
6085: <p>The first section contains the information about which build
6086: options are supported by the package, and any default options settings
6087: if needed.</p>
1.23 wiz 6088: <div class="orderedlist"><ol class="orderedlist" type="1">
6089: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.29 dholland 6090: <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 6091: options. It should be set to
6092: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6093: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6094: at the point where the options are processed.</p></li>
1.23 wiz 6095: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 6096: build options supported by the package.</p></li>
1.23 wiz 6097: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 6098: list of names of groups of mutually exclusive options. The options in
6099: each group are listed in
6100: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6101: The most specific setting of any option from the group takes
6102: precedence over all other options in the group. Options from the
6103: groups will be automatically added to
6104: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 6105: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 6106: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6107: packages will fail if no option from the group is
6108: selected.</p></li>
1.23 wiz 6109: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 6110: of names of sets of options. At least one option from each set must
6111: be selected. The options in each set are listed in
6112: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6113: Options from the sets will be automatically added to
6114: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6115: fail if no option from the set is selected.</p></li>
1.23 wiz 6116: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 6117: build options which are enabled by default.</p></li>
1.23 wiz 6118: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 6119: of
1.23 wiz 6120: <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 6121: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6122: their option counterparts. Pairs should be added with
1.23 wiz 6123: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 6124: warning will be issued if the user uses a legacy
6125: variable.</p></li>
1.23 wiz 6126: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 6127: of
1.23 wiz 6128: <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 6129: pairs that map options that have been renamed to their new
1.23 wiz 6130: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 6131: the listing of global legacy options. A warning will be issued if
6132: the user uses a legacy option.</p></li>
1.23 wiz 6133: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 6134: options implied by deprecated variables used. This can be used for
6135: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6136: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6137: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 6138: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 6139: a list of warnings about deprecated variables or options used, and
6140: what to use instead.</p></li>
6141: </ol></div>
6142: <p>A package should never modify
6143: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6144: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6145: To suggest a default set of options, use
6146: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6147: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6148: including <code class="filename">bsd.options.mk</code>. If none of
6149: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6150: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6151: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6152: happen with platform-specific options if none of them is supported on
6153: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6154: empty list and the package is otherwise treated as not using the
6155: options framework.</p>
6156: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6157: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6158: build options, properly filtered to remove unsupported and duplicate
6159: options.</p>
6160: <p>The remaining sections contain the logic that is specific to
6161: each option. The correct way to check for an option is to check
6162: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6163: <pre class="programlisting">
6164: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6165: </pre>
6166: </div>
1.41 asau 6167: <div class="sect1">
1.1 dsieger 6168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6169: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6170: <p>Options that enable similar features in different packages (like
6171: optional support for a library) should use a common name in all
6172: packages that support it (like the name of the library). If another
6173: package already has an option with the same meaning, use the same
6174: name.</p>
6175: <p>Options that enable features specific to one package, where it's
6176: unlikely that another (unrelated) package has the same (or a similar)
6177: optional feature, should use a name prefixed with
6178: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6179: <p>If a group of related packages share an optional feature
6180: specific to that group, prefix it with the name of the
1.23 wiz 6181: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 6182: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6183: <p>For new options, add a line to
6184: <code class="filename">mk/defaults/options.description</code>. Lines have two
6185: fields, separated by tab. The first field is the option name, the
6186: second its description. The description should be a whole sentence
6187: (starting with an uppercase letter and ending with a period) that
1.23 wiz 6188: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6189: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 6190: </div>
1.41 asau 6191: <div class="sect1">
1.7 rillig 6192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6193: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 6194: <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 6195: different dependencies based on the options with which the package was
6196: built. For querying these options, the file
6197: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6198: typical example looks like this:</p>
6199: <pre class="programlisting">
6200: pkgbase := libpurple
6201: .include "../../mk/pkg-build-options.mk"
6202:
6203: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6204: ...
6205: .endif
6206: </pre>
6207: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6208: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6209: options of the libpurple package, which can then be queried like
6210: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6211: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6212: details.</p>
6213: </div>
1.1 dsieger 6214: </div>
1.41 asau 6215: <div class="chapter">
1.1 dsieger 6216: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6217: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6218: <div class="toc">
6219: <p><b>Table of Contents</b></p>
6220: <dl>
1.6 rillig 6221: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6222: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6223: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6224: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 6225: <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 6226: <dd><dl>
6227: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6228: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6229: </dl></dd>
1.23 wiz 6230: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6231: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6232: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6233: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6234: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6235: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6236: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6237: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6238: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6239: <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 6240: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6241: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6242: </dl>
6243: </div>
1.41 asau 6244: <div class="sect1">
1.1 dsieger 6245: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6246: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6247: <p>This chapter gives a detailed description on how a package is
6248: built. Building a package is separated into different
6249: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6250: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 6251: described in the following sections. Each phase is split into
1.1 dsieger 6252: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6253: containing phase, prefixed by one of <code class="varname">pre-</code>,
6254: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6255: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6256: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6257: <p>Never override the regular targets (like
6258: <code class="varname">fetch</code>), if you have to, override the
6259: <code class="varname">do-*</code> ones instead.</p>
6260: <p>The basic steps for building a program are always the same. First
6261: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6262: the local system and then extracted. After any pkgsrc-specific patches
6263: to compile properly are applied, the software can be configured, then
6264: built (usually by compiling), and finally the generated binaries, etc.
6265: can be put into place on the system.</p>
6266: <p>To get more details about what is happening at each step,
6267: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6268: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6269: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6270: </div>
1.41 asau 6271: <div class="sect1">
1.1 dsieger 6272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6273: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6274: <p>Before outlining the process performed by the NetBSD package system in
6275: the next section, here's a brief discussion on where programs are
6276: installed, and which variables influence this.</p>
6277: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6278: where all files of the final program shall be installed. It is
6279: usually set to <code class="varname">LOCALBASE</code>
6280: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6281: for pkgs in the <code class="filename">cross</code> category. The value of
6282: <code class="varname">PREFIX</code> needs to be put
6283: into the various places in the program's source where paths to
1.10 hubertf 6284: 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 6285: <p>When choosing which of these variables to use,
6286: follow the following rules:</p>
1.41 asau 6287: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6288: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 6289: where the current pkg will be installed. When referring to a
6290: pkg's own installation path, use
1.23 wiz 6291: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6292: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 6293: are installed. If you need to construct a -I or -L argument
6294: to the compiler to find includes and libraries installed by
1.23 wiz 6295: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 6296: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6297: installed all packages in <code class="filename">/usr/local</code>. As
6298: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6299: administrator, this variable is a misnomer.</p></li>
1.23 wiz 6300: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 6301: distribution (from xsrc, etc.) is installed. When looking for
6302: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 6303: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6304: <li class="listitem">
1.1 dsieger 6305: <p>X11-based packages are special in that they may be
6306: installed in either <code class="varname">X11BASE</code> or
6307: <code class="varname">LOCALBASE</code>.</p>
6308: <p>Usually, X11 packages should be installed under
6309: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6310: will need to include
6311: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6312: request the presence of X11 and to get the right compilation
6313: flags.</p>
6314: <p>Even though, there are some packages that cannot be installed
6315: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6316: files. These packages are special and they must be placed under
6317: <code class="varname">X11BASE</code>. To accomplish this, set either
6318: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6319: your package.</p>
6320: <p>Some notes: If you need
6321: to find includes or libraries installed by a pkg that has
6322: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6323: its pkg <code class="filename">Makefile</code>, you need to look in
6324: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6325: <code class="filename">${LOCALBASE}</code>. To force installation of
6326: all X11 packages in <code class="varname">LOCALBASE</code>, the
6327: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6328: is enabled by default.</p>
6329: </li>
1.23 wiz 6330: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1 dsieger 6331: the installed location of an X11
6332: package. <code class="varname">X11PREFIX</code> will be set to
6333: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6334: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6335: installed.</p></li>
1.23 wiz 6336: <li class="listitem">
1.1 dsieger 6337: <p>If xpkgwedge is installed, it is possible to have some
6338: packages installed in <code class="varname">X11BASE</code> and some in
6339: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6340: installed package, the <code class="varname">EVAL_PREFIX</code>
6341: definition can be used. It takes pairs in the format
1.29 dholland 6342: <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 6343: variable <code class="varname">DIRNAME</code> will be set to the prefix
6344: of the installed package <package>, or
1.23 wiz 6345: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.1 dsieger 6346: installed.</p>
6347: <p>This is best illustrated by example.</p>
6348: <p>The following lines are taken from
6349: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6350: <pre class="programlisting">
6351: EVAL_PREFIX+= GTKDIR=gtk+
6352: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6353: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6354: CONFIGURE_ARGS+= --enable-multibyte
6355: </pre>
6356: <p>Specific defaults can be defined for the packages
6357: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6358: definition of the form:</p>
6359: <pre class="programlisting">
6360: GTKDIR_DEFAULT= ${LOCALBASE}
6361: </pre>
6362: <p>where <code class="varname">GTKDIR</code> corresponds
6363: to the first definition in
6364: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6365: </li>
1.23 wiz 6366: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.29 dholland 6367: 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 6368: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6369: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6370: </ul></div>
6371: </div>
1.41 asau 6372: <div class="sect1">
1.1 dsieger 6373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6374: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 6375: <p>When building a package, various directories are used to store
1.1 dsieger 6376: source files, temporary files, pkgsrc-internal files, and so on. These
6377: directories are explained here.</p>
6378: <p>Some of the directory variables contain relative pathnames. There
6379: are two common base directories for these relative directories:
6380: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6381: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6382: inside the package itself.</p>
1.41 asau 6383: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6384: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6385: <dd><p>This is an absolute pathname that points to the pkgsrc
6386: root directory. Generally, you don't need
6387: it.</p></dd>
6388: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6389: <dd><p>This is an absolute pathname that points to the
6390: current package.</p></dd>
6391: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6392: <dd><p>This is a pathname relative to
6393: <code class="varname">PKGSRCDIR</code> that points to the current
6394: package.</p></dd>
6395: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6396: <dd><p>This is an absolute pathname pointing to the directory
6397: where all work takes place. The distfiles are extracted to this
6398: directory. It also contains temporary directories and log files used by
6399: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6400: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6401: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6402: <dd><p>This is an absolute pathname pointing to the directory
6403: where the distfiles are extracted. It is usually a direct subdirectory
6404: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6405: that isn't hidden. This variable may be changed by a package
6406: <code class="filename">Makefile</code>.</p></dd>
6407: </dl></div>
1.14 jmcneill 6408: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6409: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 6410: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 6411: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6412: If users would like to have their pkgsrc trees behave in a
6413: read-only manner, then the value of
6414: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6415: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 6416: </div>
1.41 asau 6417: <div class="sect1">
1.1 dsieger 6418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6419: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 6420: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6421: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6422: phase. This will automatically run all phases that are required for this
6423: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6424: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6425: the package will be built, but not installed.</p>
6426: </div>
1.41 asau 6427: <div class="sect1">
1.1 dsieger 6428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6429: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6430: <p>The first step in building a package is to fetch the
6431: distribution files (distfiles) from the sites that are providing
6432: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6433: phase.</p>
1.41 asau 6434: <div class="sect2">
1.1 dsieger 6435: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6436: <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 6437: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6438: defines all URLs from where the distfile, whose name is
6439: derived from the <code class="varname">DISTNAME</code> variable, is
6440: fetched. The more complicated cases are described
6441: below.</p>
6442: <p>The variable <code class="varname">DISTFILES</code> specifies
6443: the list of distfiles that have to be fetched. Its value
1.66 asau 6444: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6445: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 6446: so that most packages don't need to define it at all.
6447: <code class="varname">EXTRACT_SUFX</code> is
6448: <code class="literal">.tar.gz</code> by default, but can be changed
6449: freely. Note that if your package requires additional
6450: distfiles to the default one, you cannot just append the
6451: additional filenames using the <code class="literal">+=</code>
6452: operator, but you have write for example:</p>
6453: <pre class="programlisting">
1.66 asau 6454: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 6455: </pre>
6456: <p>Each distfile is fetched from a list of sites, usually
6457: <code class="varname">MASTER_SITES</code>. If the package has multiple
6458: <code class="varname">DISTFILES</code> or multiple
6459: <code class="varname">PATCHFILES</code> from different sites, you can
6460: set
6461: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6462: to the list of URLs where the file
6463: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6464: (including the suffix) can be found.</p>
6465: <pre class="programlisting">
6466: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6467: DISTFILES+= foo-file.tar.gz
6468: SITES.foo-file.tar.gz= \
6469: http://www.somewhere.com/somehow/ \
6470: http://www.somewhereelse.com/mirror/somehow/
6471: </pre>
6472: <p>When actually fetching the distfiles, each item from
6473: <code class="varname">MASTER_SITES</code> or
6474: <code class="varname">SITES.*</code> gets the name of each distfile
6475: appended to it, without an intermediate slash. Therefore,
6476: all site values have to end with a slash or other separator
6477: character. This allows for example to set
6478: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6479: that gets the name of the distfile as a parameter. In this
6480: case, the definition would look like:</p>
6481: <pre class="programlisting">
6482: MASTER_SITES= http://www.example.com/download.cgi?file=
6483: </pre>
1.22 jakllsch 6484: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 6485: In that case the URL is taken as is, fetched and the result
6486: stored under the name of the distfile. You can use this style
6487: for the case when the download URL style does not match the
6488: above common case. For example, if permanent download URL is a
6489: redirector to the real download URL, or the download file name
6490: is offered by an HTTP Content-Disposition header. In the
6491: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6492: created instead of the default
6493: <code class="filename">v1.0.0.tar.gz</code>.</p>
6494: <pre class="programlisting">
6495: DISTNAME= foo-1.0.0
6496: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6497: </pre>
1.1 dsieger 6498: <p>There are some predefined values for
6499: <code class="varname">MASTER_SITES</code>, which can be used in
6500: packages. The names of the variables should speak for
6501: themselves.</p>
6502: <pre class="programlisting">
6503: ${MASTER_SITE_APACHE}
6504: ${MASTER_SITE_BACKUP}
6505: ${MASTER_SITE_CYGWIN}
6506: ${MASTER_SITE_DEBIAN}
6507: ${MASTER_SITE_FREEBSD}
6508: ${MASTER_SITE_FREEBSD_LOCAL}
6509: ${MASTER_SITE_GENTOO}
6510: ${MASTER_SITE_GNOME}
6511: ${MASTER_SITE_GNU}
6512: ${MASTER_SITE_GNUSTEP}
1.66 asau 6513: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 6514: ${MASTER_SITE_IFARCHIVE}
6515: ${MASTER_SITE_KDE}
6516: ${MASTER_SITE_MOZILLA}
1.66 asau 6517: ${MASTER_SITE_MOZILLA_ALL}
6518: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 6519: ${MASTER_SITE_MYSQL}
1.66 asau 6520: ${MASTER_SITE_NETLIB}
1.1 dsieger 6521: ${MASTER_SITE_OPENOFFICE}
6522: ${MASTER_SITE_PERL_CPAN}
6523: ${MASTER_SITE_PGSQL}
1.66 asau 6524: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 6525: ${MASTER_SITE_R_CRAN}
6526: ${MASTER_SITE_SOURCEFORGE}
6527: ${MASTER_SITE_SOURCEFORGE_JP}
6528: ${MASTER_SITE_SUNSITE}
6529: ${MASTER_SITE_SUSE}
6530: ${MASTER_SITE_TEX_CTAN}
6531: ${MASTER_SITE_XCONTRIB}
6532: ${MASTER_SITE_XEMACS}
1.66 asau 6533: ${MASTER_SITE_XORG}
1.1 dsieger 6534: </pre>
6535: <p>Some explanations for the less self-explaining ones:
6536: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6537: 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 6538: 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 6539: <p>If you choose one of these predefined sites, you may
6540: want to specify a subdirectory of that site. Since these
6541: macros may expand to more than one actual site, you
6542: <span class="emphasis"><em>must</em></span> use the following construct to
6543: specify a subdirectory:</p>
6544: <pre class="programlisting">
6545: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6546: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6547: </pre>
6548: <p>Note the trailing slash after the subdirectory
6549: name.</p>
6550: </div>
1.41 asau 6551: <div class="sect2">
1.1 dsieger 6552: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6553: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6554: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6555: all the distfiles exist in a local directory
6556: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6557: user). If the files do not exist, they are fetched using
6558: commands of the form</p>
6559: <pre class="programlisting">
6560: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6561: </pre>
6562: <p>where <code class="literal">${site}</code> varies through
6563: several possibilities in turn: first,
6564: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6565: sites specified in either <code class="varname">SITES.file</code> if
6566: defined, else <code class="varname">MASTER_SITES</code> or
6567: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6568: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6569: all except the first and the last can be optionally sorted
6570: by the user, via setting either
6571: <code class="varname">MASTER_SORT_RANDOM</code>, and
6572: <code class="varname">MASTER_SORT_AWK</code> or
6573: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6574: <p> The specific command and arguments used depend on the
6575: <code class="varname">FETCH_USING</code> parameter. The example above is
6576: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6577: <p>The distfiles mirror run by the NetBSD Foundation uses the
6578: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6579: distfiles, if they are freely distributable. Packages setting
6580: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6581: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6582: mirrored.</p>
6583: </div>
6584: </div>
1.41 asau 6585: <div class="sect1">
1.1 dsieger 6586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6587: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6588: <p>After the distfile(s) are fetched, their checksum is
6589: generated and compared with the checksums stored in the
6590: distinfo file. If the checksums don't match, the build is
6591: aborted. This is to ensure the same distfile is used for
6592: building, and that the distfile wasn't changed, e.g. by some
6593: malign force, deliberately changed distfiles on the master
6594: distribution site or network lossage.</p>
6595: </div>
1.41 asau 6596: <div class="sect1">
1.1 dsieger 6597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6598: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6599: <p>When the distfiles are present on the local system, they
6600: need to be extracted, as they usually come in the form of some
6601: compressed archive format.</p>
6602: <p>By default, all <code class="varname">DISTFILES</code> are
6603: extracted. If you only need some of them, you can set the
6604: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6605: files.</p>
6606: <p>Extracting the files is usually done by a little
6607: program, <code class="filename">mk/extract/extract</code>, which
6608: already knows how to extract various archive formats, so most
6609: likely you will not need to change anything here. But if you
6610: need, the following variables may help you:</p>
1.41 asau 6611: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6612: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6613: <dd><p>Use these variables to override the default
6614: options for an extract command, which are defined in
6615: <code class="filename">mk/extract/extract</code>.</p></dd>
6616: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6617: <dd><p>This variable can be set to
1.14 jmcneill 6618: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6619: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6620: absolute pathname pointing to the command with which tar
1.14 jmcneill 6621: archives should be extracted. It is preferred to choose bsdtar over gtar
6622: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6623: </dl></div>
6624: <p>If the <code class="filename">extract</code> program doesn't
6625: serve your needs, you can also override the
6626: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6627: command used for extracting the files. This command is
6628: executed in the <code class="filename">${WRKSRC}</code>
6629: directory. During execution of this command, the shell
6630: variable <code class="varname">extract_file</code> holds the absolute
6631: pathname of the file that is going to be extracted.</p>
6632: <p>And if that still does not suffice, you can override the
6633: <code class="varname">do-extract</code> target in the package
6634: Makefile.</p>
6635: </div>
1.41 asau 6636: <div class="sect1">
1.1 dsieger 6637: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6638: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6639: <p>After extraction, all the patches named by the
6640: <code class="varname">PATCHFILES</code>, those present in the patches
6641: subdirectory of the package as well as in
6642: $LOCALPATCHES/$PKGPATH (e.g.
6643: <code class="filename">/usr/local/patches/graphics/png</code>) are
6644: applied. Patchfiles ending in <code class="filename">.Z</code> or
6645: <code class="filename">.gz</code> are uncompressed before they are
6646: applied, files ending in <code class="filename">.orig</code> or
6647: <code class="filename">.rej</code> are ignored. Any special options to
1.29 dholland 6648: <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 6649: <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 6650: <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 6651: it fail if the patches apply with some lines of fuzz. Please
6652: fix (regen) the patches so that they apply cleanly. The
6653: rationale behind this is that patches that don't apply cleanly
6654: may end up being applied in the wrong place, and cause severe
6655: harm there.</p>
6656: </div>
1.41 asau 6657: <div class="sect1">
1.1 dsieger 6658: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6659: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6660: <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 6661: </p>
6662: </div>
1.41 asau 6663: <div class="sect1">
1.1 dsieger 6664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6665: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6666: <p>This phase creates wrapper programs for the compilers and
6667: linkers. The following variables can be used to tweak the
6668: wrappers.</p>
1.41 asau 6669: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6670: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6671: <dd><p>The command used to print progress
6672: messages. Does nothing by default. Set to
6673: <code class="literal">${ECHO}</code> to see the progress
6674: messages.</p></dd>
6675: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6676: <dd><p>This variable can be set to
6677: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6678: depending on whether you want additional information in the
6679: wrapper log file.</p></dd>
6680: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6681: <dd><p>This variable can be set to
6682: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6683: on whether the wrapper should use its cache, which will
6684: improve the speed. The default value is
6685: <code class="literal">yes</code>, but is forced to
6686: <code class="literal">no</code> if the platform does not support
6687: it.</p></dd>
6688: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6689: <dd><p>A list of reordering commands. A reordering
6690: command has the form
6691: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6692: It ensures that that
6693: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6694: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6695: </p></dd>
6696: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6697: <dd><p>A list of transformation commands. [TODO:
6698: investigate further]</p></dd>
6699: </dl></div>
6700: </div>
1.41 asau 6701: <div class="sect1">
1.1 dsieger 6702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6703: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6704: <p>Most pieces of software need information on the header
6705: files, system calls, and library routines which are available
6706: on the platform they run on. The process of determining this
6707: information is known as configuration, and is usually
6708: automated. In most cases, a script is supplied with the
6709: distfiles, and its invocation results in generation of header
6710: files, Makefiles, etc.</p>
6711: <p>If the package contains a configure script, this can be
6712: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6713: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6714: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6715: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6716: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6717: <pre class="programlisting">
6718: .for d in ${CONFIGURE_DIRS}
6719: cd ${WRKSRC} \
6720: && cd ${d} \
6721: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6722: .endfor
6723: </pre>
6724: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6725: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6726: <code class="varname">WRKSRC</code>. In each of these directories, the
6727: configure script is run with the environment
6728: <code class="varname">CONFIGURE_ENV</code> and arguments
6729: <code class="varname">CONFIGURE_ARGS</code>. The variables
6730: <code class="varname">CONFIGURE_ENV</code>,
6731: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6732: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6733: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6734: package.</p>
1.37 wiz 6735: <p>If the program uses the Perl way of configuration (mainly Perl
6736: modules, but not only), i.e. a file called
6737: <code class="filename">Makefile.PL</code>, it should include
6738: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6739: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6740: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6741: <p>If the program uses an <code class="filename">Imakefile</code>
6742: for configuration, the appropriate steps can be invoked by
6743: setting <code class="varname">USE_IMAKE</code> to
1.23 wiz 6744: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.1 dsieger 6745: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6746: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6747: xmkmf's environment by adding them to the
6748: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6749: <p>If the program uses <code class="filename">cmake</code>
6750: for configuration, the appropriate steps can be invoked by
1.23 wiz 6751: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6752: You can add variables to cmake's environment by adding them to the
6753: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6754: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6755: The top directory argument is given by the
6756: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6757: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6758: <p>If there is no configure step at all, set
1.23 wiz 6759: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6760: </div>
1.41 asau 6761: <div class="sect1">
1.1 dsieger 6762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6763: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6764: <p>For building a package, a rough equivalent of the
6765: following code is executed.</p>
6766: <pre class="programlisting">
6767: .for d in ${BUILD_DIRS}
6768: cd ${WRKSRC} \
6769: && cd ${d} \
6770: && env ${MAKE_ENV} \
6771: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6772: -f ${MAKE_FILE} \
6773: ${BUILD_TARGET}
6774: .endfor
6775: </pre>
6776: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6777: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6778: <code class="varname">WRKSRC</code>. In each of these directories,
6779: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6780: <code class="varname">MAKE_ENV</code> and arguments
6781: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6782: <code class="varname">MAKE_ENV</code>,
6783: <code class="varname">BUILD_MAKE_FLAGS</code>,
6784: <code class="varname">MAKE_FILE</code> and
6785: <code class="varname">BUILD_TARGET</code> may all be changed by the
6786: package.</p>
6787: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6788: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6789: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6790: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6791: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6792: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6793: <p>If there is no build step at all, set
1.23 wiz 6794: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6795: </div>
1.41 asau 6796: <div class="sect1">
1.1 dsieger 6797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6798: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6799: <p>[TODO]</p>
6800: </div>
1.41 asau 6801: <div class="sect1">
1.1 dsieger 6802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6803: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6804: <p>Once the build stage has completed, the final step is to
6805: install the software in public directories, so users can
6806: access the programs and files.</p>
6807: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6808: equivalent of the following code is executed. Additionally,
6809: before and after this code, much magic is performed to do
6810: consistency checks, registering the package, and so on.</p>
6811: <pre class="programlisting">
6812: .for d in ${INSTALL_DIRS}
6813: cd ${WRKSRC} \
6814: && cd ${d} \
6815: && env ${MAKE_ENV} \
6816: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6817: -f ${MAKE_FILE} \
6818: ${INSTALL_TARGET}
6819: .endfor
6820: </pre>
6821: <p>The variable's meanings are analogous to the ones in the
6822: <span class="emphasis"><em>build</em></span> phase.
6823: <code class="varname">INSTALL_DIRS</code> defaults to
6824: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6825: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6826: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6827: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6828: defined.</p>
6829: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6830: variables are useful. They are all variations of the
1.29 dholland 6831: <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 6832: permissions preset. <code class="varname">INSTALL</code> is the plain
6833: install command. The specialized variants, together with their
6834: intended use, are:</p>
1.41 asau 6835: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6836: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6837: <dd><p>directories that contain
6838: binaries</p></dd>
6839: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6840: <dd><p>directories that contain
6841: scripts</p></dd>
6842: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6843: <dd><p>directories that contain shared and static
6844: libraries</p></dd>
6845: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6846: <dd><p>directories that contain data
6847: files</p></dd>
6848: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6849: <dd><p>directories that contain man
6850: pages</p></dd>
6851: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6852: <dd><p>binaries that can be stripped from debugging
6853: symbols</p></dd>
6854: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6855: <dd><p>binaries that cannot be
6856: stripped</p></dd>
6857: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6858: <dd><p>game
6859: binaries</p></dd>
6860: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6861: <dd><p>shared and static
6862: libraries</p></dd>
6863: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6864: <dd><p>data files</p></dd>
6865: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6866: <dd><p>data files for
6867: games</p></dd>
6868: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6869: <dd><p>man pages</p></dd>
6870: </dl></div>
6871: <p>Some other variables are:</p>
1.41 asau 6872: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6873: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6874: <dd><p>A list of directories relative to
6875: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6876: beginning of the <span class="emphasis"><em>install</em></span> phase.
6877: The package is supposed to create all needed directories itself
6878: before installing files to it and list all other directories here.
6879: </p></dd>
6880: </dl></div>
6881: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6882: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6883: mostly relevant for packages in the <code class="filename">regress</code>
6884: category.</p>
6885: </div>
1.41 asau 6886: <div class="sect1">
1.1 dsieger 6887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6888: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6889: <p>Once the install stage has completed, a binary package of
6890: the installed files can be built. These binary packages can be
6891: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6892: the <span class="command"><strong>make bin-install</strong></span> or by using
6893: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6894: <p>By default, the binary packages are created in
6895: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6896: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6897: one for each category in the <code class="varname">CATEGORIES</code>
6898: variable. <code class="varname">PACKAGES</code> defaults to
6899: <code class="filename">pkgsrc/packages</code>.</p>
6900: </div>
1.41 asau 6901: <div class="sect1">
1.1 dsieger 6902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6903: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6904: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6905: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6906: to clean the work directories of all dependencies too, use
1.10 hubertf 6907: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6908: </div>
1.41 asau 6909: <div class="sect1">
1.1 dsieger 6910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6911: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 6912: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6913: <dt><span class="term">pre/post-*</span></dt>
6914: <dd><p>For any of the main targets described in the
6915: previous section, two auxiliary targets exist with
1.23 wiz 6916: <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 6917: prefix for the main target's name. These targets are
6918: invoked before and after the main target is called,
6919: allowing extra configuration or installation steps be
6920: performed from a package's Makefile, for example, which
6921: a program's configure script or install target
6922: omitted.</p></dd>
6923: <dt><span class="term">do-*</span></dt>
6924: <dd><p>Should one of the main targets do the wrong thing,
6925: and should there be no variable to fix this, you can
6926: redefine it with the do-* target. (Note that redefining
6927: the target itself instead of the do-* target is a bad
6928: idea, as the pre-* and post-* targets won't be called
6929: anymore, etc.) You will not usually need to do
6930: this.</p></dd>
6931: <dt><span class="term">reinstall</span></dt>
6932: <dd>
1.10 hubertf 6933: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6934: you noticed some file was not installed properly, you
6935: can repeat the installation with this target, which will
1.23 wiz 6936: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6937: <p>This is the default value of
6938: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6939: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6940: package</strong></span>, where the defaults are
1.23 wiz 6941: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6942: respectively.</p>
6943: </dd>
6944: <dt><span class="term">deinstall</span></dt>
6945: <dd>
1.29 dholland 6946: <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 6947: current directory, effectively de-installing the
6948: package. The following variables can be used to tune the
6949: behaviour:</p>
1.41 asau 6950: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6951: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.29 dholland 6952: <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 6953: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6954: <dd><p>Remove all packages that require (depend on)
6955: the given package. This can be used to remove any
6956: packages that may have been pulled in by a given
1.10 hubertf 6957: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6958: DEINSTALLDEPENDS=1</strong></span> is done in
6959: <code class="filename">pkgsrc/x11/kde</code>, this is
6960: likely to remove whole KDE. Works by adding
1.29 dholland 6961: <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 6962: command line.</p></dd>
6963: </dl></div>
6964: </dd>
6965: <dt><span class="term">bin-install</span></dt>
6966: <dd><p>Install a binary package from local disk and via FTP
6967: from a list of sites (see the
6968: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6969: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6970: available anywhere. The arguments given to
1.10 hubertf 6971: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6972: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6973: operation, etc.</p></dd>
6974: <dt><span class="term">update</span></dt>
6975: <dd>
6976: <p>This target causes the current package to be
6977: updated to the latest version. The package and all
6978: depending packages first get de-installed, then current
6979: versions of the corresponding packages get compiled and
6980: installed. This is similar to manually noting which
6981: packages are currently installed, then performing a
1.10 hubertf 6982: series of <span class="command"><strong>make deinstall</strong></span> and
6983: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6984: <code class="varname">UPDATE_TARGET</code> is set to) for these
6985: packages.</p>
1.23 wiz 6986: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6987: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6988: update</strong></span> was interrupted for some reason.
6989: However, in this case, make sure you don't call
1.10 hubertf 6990: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6991: list of dependent packages in <code class="varname">WRKDIR</code>.
6992: Otherwise, you lose the ability to automatically update
6993: the current package along with the dependent packages
6994: you have installed.</p>
1.10 hubertf 6995: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6996: update</strong></span> will only work as long as the package
6997: tree remains unchanged. If the source code for one of
6998: the packages to be updated has been changed, resuming
1.10 hubertf 6999: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 7000: fail!</p>
7001: <p>The following variables can be used either on the
1.10 hubertf 7002: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7003: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 7004: update</strong></span>:</p>
1.41 asau 7005: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7006: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7007: <dd><p>Install target to recursively use for the
7008: updated package and the dependent packages.
7009: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 7010: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 7011: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 7012: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7013: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7014: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 7015: endless loop!</p></dd>
7016: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7017: <dd><p>Don't clean up after updating. Useful if
7018: you want to leave the work sources of the updated
7019: packages around for inspection or other purposes.
7020: Be sure you eventually clean up the source tree
1.23 wiz 7021: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 7022: or you may run into troubles with old source code
7023: still lying around on your next
1.10 hubertf 7024: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 7025: update</strong></span>.</p></dd>
7026: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7027: <dd><p>Deinstall each package before installing
7028: (making <code class="varname">DEPENDS_TARGET</code>). This
7029: may be necessary if the
1.23 wiz 7030: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 7031: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 7032: update</strong></span>.</p></dd>
7033: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7034: <dd><p>Allows you to disable recursion and hardcode
7035: the target for packages. The default is
1.23 wiz 7036: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 7037: facilitating a recursive update of prerequisite
7038: packages. Only set
7039: <code class="varname">DEPENDS_TARGET</code> if you want to
7040: disable recursive updates. Use
7041: <code class="varname">UPDATE_TARGET</code> instead to just
7042: set a specific target for each package to be
1.10 hubertf 7043: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 7044: (see above).</p></dd>
7045: </dl></div>
7046: </dd>
7047: <dt><span class="term">clean-update</span></dt>
7048: <dd>
7049: <p>Clean the source tree for all packages that would
1.10 hubertf 7050: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 7051: from the current directory. This target should not be
7052: used if the current package (or any of its depending
7053: packages) have already been de-installed (e.g., after
1.10 hubertf 7054: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 7055: some packages you intended to update. As a rule of
7056: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 7057: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 7058: and only if you have a dirty package tree (e.g., if you
7059: used <code class="varname">NOCLEAN</code>).</p>
7060: <p>If you are unsure about whether your tree is
1.10 hubertf 7061: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 7062: clean</strong></span> at the top of the tree, or use the
7063: following sequence of commands from the directory of the
7064: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 7065: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 7066: time, otherwise you lose all the packages you wanted to
7067: update!):</p>
7068: <pre class="screen">
7069: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7070: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7071: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7072: </pre>
7073: <p>The following variables can be used either on the
1.10 hubertf 7074: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7075: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 7076: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7077: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 7078: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 7079: reconstruct the list of directories to update for
1.10 hubertf 7080: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 7081: update</strong></span> successfully installed all
7082: packages you wanted to update. Normally, this is
1.10 hubertf 7083: done automatically on <span class="command"><strong>make
1.1 dsieger 7084: update</strong></span>, but may have been suppressed by
7085: the <code class="varname">NOCLEAN</code> variable (see
7086: above).</p></dd>
7087: </dl></div>
7088: </dd>
7089: <dt><span class="term">replace</span></dt>
7090: <dd>
7091: <p>Update the installation of the current package. This
7092: differs from update in that it does not replace dependent
7093: 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
7094: target to work.</p>
7095: <p><span class="emphasis"><em>Be careful when using this
7096: target!</em></span> There are no guarantees that dependent
7097: packages will still work, in particular they will most
1.10 hubertf 7098: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 7099: library package whose shared library major version changed
7100: between your installed version and the new one. For this
7101: reason, this target is not officially supported and only
7102: recommended for advanced users.</p>
7103: </dd>
7104: <dt><span class="term">info</span></dt>
1.29 dholland 7105: <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 7106: package. You can use this to check which version of a
7107: package is installed.</p></dd>
7108: <dt><span class="term">index</span></dt>
7109: <dd>
7110: <p>This is a top-level command, i.e. it should be used in
7111: the <code class="filename">pkgsrc</code> directory. It creates a
7112: database of all packages in the local pkgsrc tree, including
7113: dependencies, comment, maintainer, and some other useful
7114: information. Individual entries are created by running
1.10 hubertf 7115: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 7116: directories. This index file is saved as
7117: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 7118: verbose format by running <span class="command"><strong>make
1.1 dsieger 7119: print-index</strong></span>. You can search in it with
1.10 hubertf 7120: <span class="command"><strong>make search
1.1 dsieger 7121: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7122: extract a list of all packages that depend on a particular
1.10 hubertf 7123: one by running <span class="command"><strong>make show-deps
1.1 dsieger 7124: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7125: <p>Running this command takes a very long time, some
7126: hours even on fast machines!</p>
7127: </dd>
7128: <dt><span class="term">readme</span></dt>
7129: <dd>
7130: <p>This target generates a
7131: <code class="filename">README.html</code> file, which can be
7132: 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
7133: contain references to any packages which are in the
7134: <code class="varname">PACKAGES</code> directory on the local
7135: host. The generated files can be made to refer to URLs
7136: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7137: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7138: wanted to generate <code class="filename">README.html</code>
7139: files which pointed to binary packages on the local
7140: machine, in the directory
7141: <code class="filename">/usr/packages</code>, set
7142: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7143: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7144: <code class="varname">${PACKAGES}</code> directory and its
7145: subdirectories will be searched for all the binary
7146: packages.</p>
7147: <p>The target can be run at the toplevel or in category
7148: directories, in which case it descends recursively.</p>
7149: </dd>
7150: <dt><span class="term">readme-all</span></dt>
7151: <dd><p>This is a top-level command, run it in
7152: <code class="filename">pkgsrc</code>. Use this target to create a
7153: file <code class="filename">README-all.html</code> which contains a
7154: list of all packages currently available in the NetBSD
7155: Packages Collection, together with the category they belong
7156: to and a short description. This file is compiled from the
7157: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 7158: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 7159: readme</strong></span>.</p></dd>
7160: <dt><span class="term">cdrom-readme</span></dt>
7161: <dd><p>This is very much the same as the
1.23 wiz 7162: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 7163: used when generating a pkgsrc tree to be written to a
7164: CD-ROM. This target also produces
7165: <code class="filename">README.html</code> files, and can be made
7166: to refer to URLs based on
7167: <code class="varname">CDROM_PKG_URL_HOST</code> and
7168: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7169: <dt><span class="term">show-distfiles</span></dt>
7170: <dd><p>This target shows which distfiles and patchfiles
7171: are needed to build the package
7172: (<code class="varname">ALLFILES</code>, which contains all
7173: <code class="varname">DISTFILES</code> and
7174: <code class="varname">PATCHFILES</code>, but not
7175: <code class="filename">patches/*</code>).</p></dd>
7176: <dt><span class="term">show-downlevel</span></dt>
7177: <dd><p>This target shows nothing if the package is not
7178: installed. If a version of this package is installed,
7179: but is not the version provided in this version of
7180: pkgsrc, then a warning message is displayed. This target
7181: can be used to show which of your installed packages are
7182: downlevel, and so the old versions can be deleted, and
7183: the current ones added.</p></dd>
7184: <dt><span class="term">show-pkgsrc-dir</span></dt>
7185: <dd><p>This target shows the directory in the pkgsrc
7186: hierarchy from which the package can be built and
7187: installed. This may not be the same directory as the one
7188: from which the package was installed. This target is
7189: intended to be used by people who may wish to upgrade
7190: many packages on a single host, and can be invoked from
7191: the top-level pkgsrc Makefile by using the
1.23 wiz 7192: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 7193: <dt><span class="term">show-installed-depends</span></dt>
7194: <dd><p>This target shows which installed packages match
7195: the current package's <code class="varname">DEPENDS</code>. Useful
7196: if out of date dependencies are causing build
7197: problems.</p></dd>
7198: <dt><span class="term">check-shlibs</span></dt>
7199: <dd><p>After a package is installed, check all its
7200: binaries and (on ELF platforms) shared libraries to see
7201: if they find the shared libs they need. Run by default
1.10 hubertf 7202: 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 7203: <dt><span class="term">print-PLIST</span></dt>
7204: <dd>
1.23 wiz 7205: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 7206: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 7207: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 7208: -newer work/.extract_done</strong></span>. An attempt is made
7209: to care for shared libs etc., but it is
7210: <span class="emphasis"><em>strongly</em></span> recommended to review the
7211: result before putting it into
7212: <code class="filename">PLIST</code>. On upgrades, it's useful to
7213: diff the output of this command against an already
7214: existing <code class="filename">PLIST</code> file.</p>
1.29 dholland 7215: <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 7216: other methods that don't update file access times, be
7217: sure to add these files manually to your
1.23 wiz 7218: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7219: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 7220: them!</p>
1.23 wiz 7221: <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 7222: information on this target.</p>
7223: </dd>
7224: <dt><span class="term">bulk-package</span></dt>
7225: <dd>
7226: <p>Used to do bulk builds. If an appropriate binary
7227: package already exists, no action is taken. If not, this
7228: target will compile, install and package it (and its
7229: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66 asau 7230: 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
7231: builds)</i></a>).
1.1 dsieger 7232: After creating the binary package, the sources, the
7233: just-installed package and its required packages are
7234: removed, preserving free disk space.</p>
7235: <p><span class="emphasis"><em>Beware that this target may deinstall
7236: all packages installed on a system!</em></span></p>
7237: </dd>
7238: <dt><span class="term">bulk-install</span></dt>
7239: <dd>
7240: <p>Used during bulk-installs to install required
7241: packages. If an up-to-date binary package is available,
1.29 dholland 7242: 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 7243: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 7244: but the installed binary won't be removed.</p>
7245: <p>A binary package is considered
1.23 wiz 7246: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.29 dholland 7247: <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 7248: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7249: <li class="listitem"><p>None of the package's files
1.1 dsieger 7250: (<code class="filename">Makefile</code>, ...) were modified
7251: since it was built.</p></li>
1.23 wiz 7252: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 7253: packages were modified since it was built.</p></li>
7254: </ul></div>
7255: <p><span class="emphasis"><em>Beware that this target may deinstall
7256: all packages installed on a system!</em></span></p>
7257: </dd>
7258: </dl></div>
7259: </div>
7260: </div>
1.41 asau 7261: <div class="chapter">
1.1 dsieger 7262: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7263: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7264: <div class="toc">
7265: <p><b>Table of Contents</b></p>
7266: <dl>
1.6 rillig 7267: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7268: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7269: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7270: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7271: </dl>
7272: </div>
7273: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7274: by pkgsrc and also for individual packages to define what commands
7275: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7276: or for later run-time of an installed packaged (such as
7277: <code class="varname">DEPENDS</code>).
7278: If the native system provides an adequate tool, then in many cases, a pkgsrc
7279: package will not be used.</p>
7280: <p>When building a package, the replacement tools are
7281: made available in a directory (as symlinks or wrapper scripts)
7282: that is early in the executable search path. Just like the buildlink
7283: system, this helps with consistent builds.</p>
7284: <p>A tool may be needed to help build a specific package. For example,
7285: perl, GNU make (gmake) or yacc may be needed.</p>
7286: <p>Also a tool may be needed, for example, because the native system's supplied
7287: tool may be inefficient for building a package with pkgsrc.
7288: For example, a package may need GNU awk, bison (instead of
7289: yacc) or a better sed.</p>
7290: <p>The tools used by a package can be listed by running
1.10 hubertf 7291: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 7292: <div class="sect1">
1.1 dsieger 7293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7294: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7295: <p>The default set of tools used by pkgsrc is defined in
7296: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7297: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7298: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7299: These can be seen by running:
1.10 hubertf 7300: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7301: <p>If a package needs a specific program to build
7302: then the <code class="varname">USE_TOOLS</code> variable can be used
7303: to define the tools needed.</p>
7304: </div>
1.41 asau 7305: <div class="sect1">
1.1 dsieger 7306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7307: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 7308: <p>In the following examples, the :run means that it is needed at
7309: run-time (and becomes a DEPENDS).
1.1 dsieger 7310: The default is a build dependency which can be set with
7311: :build. (So in this example, it is the same as gmake:build
7312: and pkg-config:build.)</p>
7313: <pre class="programlisting">
7314: USE_TOOLS+= gmake perl:run pkg-config
7315: </pre>
7316: <p>When using the tools framework, a
7317: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7318: which contains the full path to the appropriate tool. For example,
1.23 wiz 7319: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 7320: on Linux systems.</p>
7321: <p>If you always need a pkgsrc version of the
7322: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7323: </p>
7324: </div>
1.41 asau 7325: <div class="sect1">
1.1 dsieger 7326: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7327: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7328: <p>When improving or porting pkgsrc to a new platform, have a look
7329: at (or create) the corresponding platform specific make file fragment under
7330: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7331: the name of the common tools. For example:</p>
7332: <pre class="programlisting">
7333: .if exists(/usr/bin/bzcat)
7334: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7335: .elif exists(/usr/bin/bzip2)
7336: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7337: .endif
7338:
7339: TOOLS_PLATFORM.true?= true # shell builtin
7340: </pre>
7341: </div>
1.41 asau 7342: <div class="sect1">
1.1 dsieger 7343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7344: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.41 asau 7345: <div class="qandaset">
1.77 ! wiz 7346: <a name="idm73247248"></a><dl>
1.6 rillig 7347: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7348: </dt>
1.6 rillig 7349: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7350: tools?</a>
7351: </dt>
1.6 rillig 7352: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7353: package is using while being built? I want to know whether it
7354: uses sed or not.</a>
7355: </dt>
7356: </dl>
1.41 asau 7357: <table border="0" style="width: 100%;">
7358: <colgroup>
1.1 dsieger 7359: <col align="left" width="1%">
1.23 wiz 7360: <col>
1.41 asau 7361: </colgroup>
1.1 dsieger 7362: <tbody>
1.41 asau 7363: <tr class="question">
1.1 dsieger 7364: <td align="left" valign="top">
1.77 ! wiz 7365: <a name="tools.new"></a><a name="idm73246864"></a><p><b>18.4.1.</b></p>
1.1 dsieger 7366: </td>
7367: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7368: </tr>
7369: <tr class="answer">
7370: <td align="left" valign="top"></td>
7371: <td align="left" valign="top"><p>TODO</p></td>
7372: </tr>
1.41 asau 7373: <tr class="question">
1.1 dsieger 7374: <td align="left" valign="top">
1.77 ! wiz 7375: <a name="tools.listall"></a><a name="idm73245840"></a><p><b>18.4.2.</b></p>
1.1 dsieger 7376: </td>
7377: <td align="left" valign="top"><p>How do I get a list of all available
7378: tools?</p></td>
7379: </tr>
7380: <tr class="answer">
7381: <td align="left" valign="top"></td>
7382: <td align="left" valign="top"><p>TODO</p></td>
7383: </tr>
1.41 asau 7384: <tr class="question">
1.1 dsieger 7385: <td align="left" valign="top">
1.77 ! wiz 7386: <a name="tools.used"></a><a name="idm73244816"></a><p><b>18.4.3.</b></p>
1.1 dsieger 7387: </td>
7388: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7389: package is using while being built? I want to know whether it
7390: uses sed or not.</p></td>
7391: </tr>
7392: <tr class="answer">
7393: <td align="left" valign="top"></td>
7394: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7395: to do it.)</p></td>
7396: </tr>
7397: </tbody>
7398: </table>
7399: </div>
7400: </div>
7401: </div>
1.41 asau 7402: <div class="chapter">
1.1 dsieger 7403: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7404: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7405: <div class="toc">
7406: <p><b>Table of Contents</b></p>
7407: <dl>
1.6 rillig 7408: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7409: <dd><dl>
1.6 rillig 7410: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 7411: <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 7412: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7413: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7414: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7415: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7416: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7417: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7418: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7419: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7420: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7421: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7422: </dl></dd>
1.23 wiz 7423: <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 7424: <dd><dl>
7425: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7426: <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>
7427: </dl></dd>
1.23 wiz 7428: <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 7429: <dd><dl>
7430: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7431: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7432: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7433: </dl></dd>
7434: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7435: <dd><dl>
7436: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7437: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7438: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 7439: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7440: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 7441: </dl></dd>
1.23 wiz 7442: <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 7443: <dd><dl>
7444: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7445: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 7446: <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 7447: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7448: </dl></dd>
1.23 wiz 7449: <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 7450: <dd><dl>
7451: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7452: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7453: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7454: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7455: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7456: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7457: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7458: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7459: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 7460: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 7461: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7462: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7463: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7464: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7465: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7466: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7467: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7468: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7469: emulation</a></span></dt>
1.6 rillig 7470: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7471: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7472: </dl></dd>
1.6 rillig 7473: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7474: </dl>
7475: </div>
1.41 asau 7476: <div class="sect1">
1.1 dsieger 7477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7478: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.41 asau 7479: <div class="sect2">
1.1 dsieger 7480: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7481: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7482: <p>One appealing feature of pkgsrc is that it runs on many
7483: different platforms. As a result, it is important to ensure,
7484: where possible, that packages in pkgsrc are portable. This
7485: chapter mentions some particular details you should pay
7486: attention to while working on pkgsrc.</p>
7487: </div>
1.41 asau 7488: <div class="sect2">
1.1 dsieger 7489: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 7490: <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 7491: </h3></div></div></div>
7492: <p>The pkgsrc user can configure pkgsrc by overriding several
7493: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7494: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7495: want to use those variables in the preprocessor directives of
1.29 dholland 7496: <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 7497: <code class="literal">.for</code>), you need to include the file
7498: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7499: loads the user preferences.</p>
7500: <p>But note that some variables may not be completely defined
7501: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7502: included, as they may contain references to variables that are
7503: not yet defined. In shell commands this is no problem, since
7504: variables are actually macros, which are only expanded when they
7505: are used. But in the preprocessor directives mentioned above and
7506: in dependency lines (of the form <code class="literal">target:
7507: dependencies</code>) the variables are expanded at load
7508: time.</p>
1.41 asau 7509: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7510: <h3 class="title">Note</h3>
7511: <p>Currently there is no exhaustive list of all
7512: variables that tells you whether they can be used at load time
7513: or only at run time, but it is in preparation.</p>
7514: </div>
7515: </div>
1.41 asau 7516: <div class="sect2">
1.1 dsieger 7517: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7518: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7519: <p>Occasionally, packages require interaction from the user,
7520: and this can be in a number of ways:</p>
1.41 asau 7521: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7522: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7523: interaction such as entering username/password or accepting a
7524: license on a web page.</p></li>
1.23 wiz 7525: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7526: passwords.</p></li>
1.23 wiz 7527: <li class="listitem"><p>help to configure the package before it is built</p></li>
7528: <li class="listitem"><p>help during the build process</p></li>
7529: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7530: </ul></div>
7531: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7532: provided to notify the pkgsrc mechanism of an interactive stage
7533: which will be needed, and this should be set in the package's
7534: <code class="filename">Makefile</code>, e.g.:</p>
7535: <pre class="programlisting">
7536: INTERACTIVE_STAGE= build
7537: </pre>
7538: <p>Multiple interactive stages can be specified:</p>
7539: <pre class="programlisting">
7540: INTERACTIVE_STAGE= configure install
7541: </pre>
7542: <p>The user can then decide to skip this package by setting the
7543: <code class="varname">BATCH</code> variable.</p>
7544: </div>
1.41 asau 7545: <div class="sect2">
1.1 dsieger 7546: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7547: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7548: <p>Authors of software can choose the licence under which
7549: software can be copied. This is due to copyright law, and reasons
7550: for license choices are outside the scope of pkgsrc. The pkgsrc
7551: system recognizes that there are a number of licenses which some
7552: users may find objectionable or difficult or impossible to comply
7553: with. The Free Software Foundation has declared some licenses
7554: "Free", and the Open Source Initiative has a definition of "Open
7555: Source". The pkgsrc system, as a policy choice, does not label
7556: packages which have licenses that are Free or Open Source.
7557: However, packages without a license meeting either of those tests
7558: are labeled with a license tag denoting the license. Note that a
7559: package with no license to copy trivially does not meet either the
7560: Free or Open Source test.</p>
7561: <p>For packages which are not Free or Open Source, pkgsrc will
7562: not build the package unless the user has indicated to pkgsrc that
7563: packages with that particular license may be built. Note that
7564: this documentation avoids the term "accepted the license". The
7565: pkgsrc system is merely providing a mechanism to avoid
7566: accidentally building a package with a non-free license;
7567: judgement and responsibility remain with the user. (Installation
7568: of binary packages are not currently subject to this mechanism;
7569: this is a bug.)</p>
7570: <p>One might want to only install packages with a BSD license,
1.19 jnemeth 7571: or the GPL, and not the other. The free licenses are added to the
7572: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7573: user can override the default by setting the
7574: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7575: of "+=". The licenses accepted by default are:
7576: </p>
7577: <pre class="programlisting">
1.48 rodent 7578: apache-1.1 apache-2.0
7579: arphic-public
7580: artistic artistic-2.0
7581: boost-license
7582: cc-by-sa-v3.0
1.55 ryoon 7583: cc0-1.0-universal
1.48 rodent 7584: cddl-1.0
7585: cpl-1.0
7586: epl-v1.0
7587: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7588: gnu-gpl-v1
7589: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7590: gnu-gpl-v3 gnu-lgpl-v3
7591: ibm-public-license-1.0
7592: ipafont
7593: isc
7594: lppl-1.3c
7595: lucent
7596: miros
7597: mit
7598: mpl-1.0 mpl-1.1 mpl-2.0
7599: mplusfont
7600: ofl-v1.0 ofl-v1.1
7601: original-bsd modified-bsd 2-clause-bsd
7602: php
7603: png-license
7604: postgresql-license
7605: public-domain
7606: python-software-foundation
7607: qpl-v1.0
1.52 rodent 7608: sgi-free-software-b-v2.0
1.48 rodent 7609: sleepycat-public
7610: unlicense
7611: x11
7612: zlib
7613: zpl
1.19 jnemeth 7614: </pre>
7615: <p>
7616: </p>
1.1 dsieger 7617: <p>The license tag mechanism is intended to address
7618: copyright-related issues surrounding building, installing and
7619: using a package, and not to address redistribution issues (see
7620: <code class="varname">RESTRICTED</code> and
1.19 jnemeth 7621: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7622: Packages with redistribution restrictions should set these
7623: tags.</p>
1.1 dsieger 7624: <p>Denoting that a package may be copied according to a
7625: particular license is done by placing the license in
7626: <code class="filename">pkgsrc/licenses</code> and setting the
7627: <code class="varname">LICENSE</code> variable to a string identifying the
7628: 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>
7629: <pre class="programlisting">
7630: LICENSE= xv-license
7631: </pre>
7632: <p>When trying to build, the user will get a notice that the
7633: package is covered by a license which has not been placed in the
7634: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7635: <pre class="programlisting">
7636: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7637: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7638: ===> To view the license, enter "/usr/bin/make show-license".
7639: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7640: ===> ACCEPTABLE_LICENSES+=xv-license
7641: *** Error code 1
7642: </pre>
1.10 hubertf 7643: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7644: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7645: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7646: convey to pkgsrc that it should not in the future fail because of
7647: that license:</p>
7648: <pre class="programlisting">
7649: ACCEPTABLE_LICENSES+=xv-license
7650: </pre>
1.48 rodent 7651: <p>When adding a package with a new license, the following steps
7652: are required:</p>
7653: <div class="orderedlist"><ol class="orderedlist" type="1">
7654: <li class="listitem">
7655: <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>
7656: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7657: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7658: <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 7659: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.48 rodent 7660: </ul></div>
7661: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7662: </li>
7663: <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>
7664: </ol></div>
1.1 dsieger 7665: <p>When the license changes (in a way other than formatting),
7666: please make sure that the new license has a different name (e.g.,
7667: append the version number if it exists, or the date). Just
7668: because a user told pkgsrc to build programs under a previous
7669: version of a license does not mean that pkgsrc should build
7670: programs under the new licenses. The higher-level point is that
7671: pkgsrc does not evaluate licenses for reasonableness; the only
7672: test is a mechanistic test of whether a particular text has been
7673: approved by either of two bodies.</p>
7674: <p>The use of <code class="varname">LICENSE=shareware</code>,
7675: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7676: is deprecated because it does not crisply refer to a particular
7677: license text. Another problem with such usage is that it does not
7678: enable a user to tell pkgsrc to proceed for a single package
7679: without also telling pkgsrc to proceed for all packages with that
7680: tag.</p>
7681: </div>
1.41 asau 7682: <div class="sect2">
1.1 dsieger 7683: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7684: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7685: <p>Some licenses restrict how software may be re-distributed.
7686: Because a license tag is required unless the package is Free or
7687: Open Source, all packages with restrictions should have license
7688: tags. By declaring the restrictions, package tools can
7689: automatically refrain from e.g. placing binary packages on FTP
7690: sites.</p>
7691: <p>There are four restrictions that may be encoded, which are
7692: the cross product of sources (distfiles) and binaries not being
7693: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7694: language in any license, and because non-Free licenses tend to be
7695: different from each other, pkgsrc adopts a definition of FTP and
7696: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7697: should not be made available over the Internet at no charge.
7698: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7699: made available on some kind of media, together with other source
7700: and binary packages, and which is sold for a distribution charge.
7701: </p>
7702: <p>In order to encode these restrictions, the package system
7703: defines five make variables that can be set to note these
7704: restrictions:</p>
1.41 asau 7705: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7706: <li class="listitem">
1.1 dsieger 7707: <p><code class="varname">RESTRICTED</code></p>
7708: <p>This variable should be set whenever a restriction
7709: exists (regardless of its kind). Set this variable to a
7710: string containing the reason for the restriction. It should
7711: be understood that those wanting to understand the restriction
7712: will have to read the license, and perhaps seek advice of
7713: counsel.</p>
7714: </li>
1.23 wiz 7715: <li class="listitem">
1.1 dsieger 7716: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7717: <p>Binaries may not be placed on CD-ROM containing other
7718: binary packages, for which a distribution charge may be made.
7719: In this case, set this variable to
7720: <code class="varname">${RESTRICTED}</code>.</p>
7721: </li>
1.23 wiz 7722: <li class="listitem">
1.1 dsieger 7723: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7724: <p>Binaries may not made available on the Internet without
7725: charge. In this case, set this variable to
7726: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7727: binary packages will not be included on ftp.NetBSD.org.</p>
7728: </li>
1.23 wiz 7729: <li class="listitem">
1.1 dsieger 7730: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7731: <p>Distfiles may not be placed on CD-ROM, together with
7732: other distfiles, for which a fee may be charged. In this
7733: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7734: </p>
7735: </li>
1.23 wiz 7736: <li class="listitem">
1.1 dsieger 7737: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7738: <p>Distfiles may not made available via FTP at no charge.
7739: In this case, set this variable to
7740: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7741: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7742: </li>
7743: </ul></div>
1.32 wiz 7744: <p>Please note that packages will to be removed from pkgsrc
7745: when the distfiles are not distributable and cannot be obtained
7746: for a period of one full quarter branch. Packages with manual /
7747: interactive fetch must have a maintainer and it is his/her
7748: responsibility to ensure this.</p>
1.1 dsieger 7749: </div>
1.41 asau 7750: <div class="sect2">
1.1 dsieger 7751: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7752: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7753: <p>Your package may depend on some other package being present
7754: - and there are various ways of expressing this dependency.
7755: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7756: <code class="varname">DEPENDS</code> definitions, the
7757: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7758: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7759: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7760: 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 7761: <p>The basic difference between the two variables is as
7762: follows: The <code class="varname">DEPENDS</code> definition registers
7763: that pre-requisite in the binary package so it will be pulled in
7764: when the binary package is later installed, whilst the
7765: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7766: dependency that is only needed for building the package.</p>
7767: <p>This means that if you only need a package present whilst
7768: you are building, it should be noted as a
7769: <code class="varname">BUILD_DEPENDS</code>.</p>
7770: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7771: <code class="varname">DEPENDS</code> definition is:</p>
7772: <pre class="programlisting">
7773: <pre-req-package-name>:../../<category>/<pre-req-package>
7774: </pre>
1.23 wiz 7775: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7776: may include any of the wildcard version numbers recognized by
1.29 dholland 7777: <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 7778: <div class="orderedlist"><ol class="orderedlist" type="1">
7779: <li class="listitem">
1.1 dsieger 7780: <p>If your package needs another package's binaries or
1.54 wiz 7781: libraries to build and run, and if that package has a
1.1 dsieger 7782: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7783: <pre class="programlisting">
7784: .include "../../graphics/jpeg/buildlink3.mk"
7785: </pre>
7786: </li>
1.23 wiz 7787: <li class="listitem">
1.54 wiz 7788: <p>If your package needs another package's binaries or
7789: libraries only for building, and if that package has a
7790: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7791: <pre class="programlisting">
7792: .include "../../graphics/jpeg/buildlink3.mk"
7793: </pre>
7794: <p>but set
7795: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7796: to make it a build dependency only. This case is rather
7797: rare.</p>
7798: </li>
7799: <li class="listitem">
1.25 spz 7800: <p>If your package needs binaries from another package to build,
7801: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 7802: <pre class="programlisting">
1.25 spz 7803: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1 dsieger 7804: </pre>
7805: </li>
1.25 spz 7806: <li class="listitem"><p>If your package needs a library with which to link and
7807: there is no <code class="filename">buildlink3.mk</code> file
7808: available, create one. Using
7809: <code class="varname">DEPENDS</code> won't be sufficient because the
7810: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7811: <li class="listitem">
1.25 spz 7812: <p>If your package needs some executable to be able to run
7813: correctly and if there's no
7814: <code class="filename">buildlink3.mk</code> file, this is specified
7815: using the <code class="varname">DEPENDS</code> variable. The
7816: <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
7817: be able to execute the latex binary from the teTeX package
7818: when it runs, and that is specified:</p>
1.1 dsieger 7819: <pre class="programlisting">
1.25 spz 7820: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.1 dsieger 7821: </pre>
1.25 spz 7822: </li>
7823: <li class="listitem">
7824: <p>You can use wildcards in package dependencies. Note that
7825: such wildcard dependencies are retained when creating binary
7826: packages. The dependency is checked when installing the binary
7827: package and any package which matches the pattern will be
7828: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7829: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7830: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7831: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7832: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7833: <p>Wildcards can also be used to specify that a package
7834: will only build against a certain minimum version of a
7835: pre-requisite:</p>
7836: <pre class="programlisting">
1.25 spz 7837: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 7838: </pre>
1.25 spz 7839: <p>This means that the package will build using version 6.0
7840: of ImageMagick or newer. Such a dependency may be warranted
7841: if, for example, the command line options of an executable
7842: have changed.</p>
7843: <p>If you need to depend on minimum versions of libraries,
7844: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7845: <p>For security fixes, please update the package
1.10 hubertf 7846: 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 7847: information.</p>
7848: </li>
1.59 jnemeth 7849: <li class="listitem">
7850: <p>If the package depends on either one of two (or more)
7851: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7852: comma-separated list between curly braces.</p>
7853: <p>As an example, take a package that depends on the Perl
7854: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7855: itself since version 5.10.0. This either/or dependency is
7856: expressed as:</p>
7857: <pre class="programlisting">
7858: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7859: </pre>
7860: </li>
1.1 dsieger 7861: </ol></div>
7862: <p>If your package needs files from another package to build,
7863: add the relevant distribution files to
7864: <code class="varname">DISTFILES</code>, so they will be extracted
7865: 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.
7866: (It relies on the jpeg sources being present in source form
7867: during the build.)</p>
7868: </div>
1.41 asau 7869: <div class="sect2">
1.1 dsieger 7870: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7871: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7872: <p>Your package may conflict with other packages a user might
7873: already have installed on his system, e.g. if your package
7874: installs the same set of files as another package in the pkgsrc
7875: tree.</p>
7876: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
7877: space-separated list of packages (including version string) your
7878: package conflicts with.</p>
7879: <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>
7880: 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>
7881: install the same shared library, thus you set in
7882: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7883: <pre class="programlisting">
7884: CONFLICTS= Xaw-Xpm-[0-9]*
7885: </pre>
7886: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7887: <pre class="programlisting">
7888: CONFLICTS= Xaw3d-[0-9]*
7889: </pre>
7890: <p>Packages will automatically conflict with other packages
7891: with the name prefix and a different version
1.23 wiz 7892: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
7893: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.1 dsieger 7894: </div>
1.41 asau 7895: <div class="sect2">
1.1 dsieger 7896: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7897: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7898: <p>There are several reasons why a package might be
7899: instructed to not build under certain circumstances. If the
7900: package builds and runs on most platforms, the exceptions
7901: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7902: the package builds and runs on a small handful of platforms,
7903: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7904: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7905: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7906: (OS-version-platform) that can use glob-style
7907: wildcards.</p>
7908: <p>Some packages are tightly bound to a specific version of an
7909: 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
7910: backwards compatible with other versions of the OS, and should be
7911: uploaded to a version specific directory on the FTP server. Mark
7912: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7913: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7914: the package system internals, but may be used in the
7915: future.</p>
7916: <p>If the package should be skipped (for example, because it
7917: provides functionality already provided by the system), set
7918: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7919: the package should fail because some preconditions are not met,
7920: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7921: message.</p>
7922: </div>
1.41 asau 7923: <div class="sect2">
1.1 dsieger 7924: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7925: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7926: <p>To ensure that a package may not be deleted, once it has been
7927: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7928: be set in the package Makefile. This will be carried into any
7929: binary package that is made from this pkgsrc entry. A
1.23 wiz 7930: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.29 dholland 7931: 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 7932: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7933: </div>
1.41 asau 7934: <div class="sect2">
1.1 dsieger 7935: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7936: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7937: <p>When a vulnerability is found, this should be noted in
7938: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7939: and after committing that file, ask pkgsrc-security@NetBSD.org to
7940: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7941: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7942: <code class="varname">PKGREVISION</code> should be increased (this is of
7943: course not necessary if the problem is fixed by using a newer
7944: release of the software), and the pattern in the
7945: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7946: <p>Also, if the fix should be applied to the stable pkgsrc
7947: branch, be sure to submit a pullup request!</p>
7948: <p>Binary packages already on ftp.NetBSD.org will be handled
7949: semi-automatically by a weekly cron job.</p>
7950: </div>
1.41 asau 7951: <div class="sect2">
1.1 dsieger 7952: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7953: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 7954: <p>When making fixes to an existing package it can be useful
7955: to change the version number in <code class="varname">PKGNAME</code>. To
7956: avoid conflicting with future versions by the original author, a
1.23 wiz 7957: <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 7958: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7959: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7960: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7961: <pre class="programlisting">
7962: DISTNAME= foo-17.42
7963: PKGREVISION= 9
7964: </pre>
7965: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7966: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7967: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7968: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7969: <code class="varname">PKGNAME_NOREV</code>.</p>
7970: <p>When a new release of the package is released, the
7971: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7972: minor release of the above package, things should be like:</p>
7973: <pre class="programlisting">
7974: DISTNAME= foo-17.43
7975: </pre>
7976: <p><code class="varname">PKGREVISION</code> should be incremented for any
7977: non-trivial change in the resulting binary package. Without a
7978: <code class="varname">PKGREVISION</code> bump, someone with the previous
7979: version installed has no way of knowing that their package is out
7980: of date. Thus, changes without increasing
7981: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7982: trivial that no reasonable person would want to upgrade", and this
7983: is the rough test for when increasing
7984: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7985: changes that do not merit increasing
7986: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7987: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7988: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7989: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7990: or comments in Makefile.</p></li>
1.23 wiz 7991: <li class="listitem"><p>
1.1 dsieger 7992: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7993: <li class="listitem"><p>
1.1 dsieger 7994: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7995: <li class="listitem"><p>
1.1 dsieger 7996: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7997: </ul></div>
7998: <p>Examples of changes that do merit an increase to
7999: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8001: <li class="listitem"><p>
1.1 dsieger 8002: Security fixes</p></li>
1.23 wiz 8003: <li class="listitem"><p>
1.1 dsieger 8004: Changes or additions to a patch file</p></li>
1.23 wiz 8005: <li class="listitem"><p>
1.1 dsieger 8006: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 8007: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 8008: </ul></div>
8009: <p>PKGREVISION must also be incremented when dependencies have ABI
8010: changes.</p>
8011: </div>
1.41 asau 8012: <div class="sect2">
1.1 dsieger 8013: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8014: <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 8015: <p>When you want to replace the same text in multiple files
8016: or when the replacement text varies, patches alone cannot help.
8017: This is where the SUBST framework comes in. It provides an
8018: easy-to-use interface for replacing text in files.
8019: Example:</p>
8020: <pre class="programlisting">
8021: SUBST_CLASSES+= fix-paths
8022: SUBST_STAGE.fix-paths= pre-configure
8023: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8024: SUBST_FILES.fix-paths= src/*.c
8025: SUBST_FILES.fix-paths+= scripts/*.sh
8026: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8027: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8028: </pre>
8029: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8030: that are used to identify the different SUBST blocks that are
8031: defined. The SUBST framework is heavily used by pkgsrc, so it is
8032: important to always use the <code class="literal">+=</code> operator with
8033: this variable. Otherwise some substitutions may be
8034: skipped.</p>
8035: <p>The remaining variables of each SUBST block are
8036: parameterized with the identifier from the first line
8037: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8038: parameters to a function call.</p>
8039: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8040: which the replacement will take place. All combinations of
8041: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8042: <code class="literal">post-</code> together with a phase name are
8043: possible, though only few are actually used. Most commonly used
8044: are <code class="literal">post-patch</code> and
8045: <code class="literal">pre-configure</code>. Of these two,
8046: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 8047: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 8048: have the state after applying the patches but before making any
8049: other changes. This is especially useful when you are debugging
8050: a package in order to create new patches for it. Similarly,
8051: <code class="literal">post-build</code> is preferred over
8052: <code class="literal">pre-install</code>, because the install phase should
8053: generally be kept as simple as possible. When you use
8054: <code class="literal">post-build</code>, you have the same files in the
8055: working directory that will be installed later, so you can check
8056: if the substitution has succeeded.</p>
8057: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8058: that is printed just before the substitution is done.</p>
8059: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8060: globbing patterns that specifies the files in which the
8061: substitution will take place. The patterns are interpreted
8062: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8063: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.29 dholland 8064: <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 8065: command should be prefixed with <code class="literal">-e</code>, so that
8066: all SUBST blocks look uniform.</p>
8067: <p>There are some more variables, but they are so seldomly
8068: used that they are only documented in the
8069: <code class="filename">mk/subst.mk</code> file.</p>
8070: </div>
8071: </div>
1.41 asau 8072: <div class="sect1">
1.1 dsieger 8073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8074: <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 8075: <div class="sect2">
1.1 dsieger 8076: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8077: <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 8078: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8079: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8080: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8081: with the name of each file to download as an argument, expecting
8082: it to output the URL of the directory from which to download
8083: 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
8084: example of this usage.</p>
8085: <p>If the download can't be automated, because the user must
8086: submit personal information to apply for a password, or must pay
8087: for the source, or whatever, you can set
8088: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8089: displayed to the user before aborting the build. Example:</p>
8090: <pre class="programlisting">
8091: FETCH_MESSAGE= "Please download the files"
8092: FETCH_MESSAGE+= " "${DISTFILES:Q}
8093: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8094: </pre>
8095: </div>
1.41 asau 8096: <div class="sect2">
1.1 dsieger 8097: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8098: <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 8099: <p>Sometimes authors of a software package make some
8100: modifications after the software was released, and they put up a
8101: new distfile without changing the package's version number. If a
8102: package is already in pkgsrc at that time, the checksum will
8103: no longer match. The contents of the new distfile should be
8104: compared against the old one before changing anything, to make
8105: sure the distfile was really updated on purpose, and that
8106: no trojan horse or so crept in.
8107: Please mention that the distfiles were compared and what was found
1.53 rodent 8108: in your commit message.</p>
8109: <p>Then, the correct way to work around this is to
1.1 dsieger 8110: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8111: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8112: <code class="varname">DISTFILES</code> and
8113: <code class="varname">PATCHFILES</code> for this package will be put in that
8114: subdirectory of the local distfiles directory.
1.10 hubertf 8115: (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 8116: In case this
8117: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8118: including the <code class="filename">nbX</code> suffix) or a date stamp
1.53 rodent 8119: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8120: <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>
8121: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8122: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8123: path in the filenames.
1.53 rodent 8124: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8125: Furthermore, a mail to the package's authors seems appropriate
8126: telling them that changing distfiles after releases without
8127: changing the file names is not good practice.</p>
8128: </div>
8129: </div>
1.41 asau 8130: <div class="sect1">
1.1 dsieger 8131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8132: <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 8133: <div class="sect2">
1.1 dsieger 8134: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8135: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8136: <p>pkgsrc supports many different machines, with different
8137: object formats like a.out and ELF, and varying abilities to do
8138: shared library and dynamic loading at all. To accompany this,
8139: varying commands and options have to be passed to the
8140: compiler, linker, etc. to get the Right Thing, which can be
8141: pretty annoying especially if you don't have all the machines
8142: at your hand to test things. The
8143: <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 8144: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8145: both static and dynamic libraries from a set of source files,
8146: thus being platform-independent.</p>
8147: <p>Here's how to use libtool in a package in seven simple
8148: steps:</p>
1.23 wiz 8149: <div class="orderedlist"><ol class="orderedlist" type="1">
8150: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8151: Makefile.</p></li>
1.23 wiz 8152: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8153: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8154: add it to the definition of <code class="varname">CC</code>, if only
8155: libraries are being built in a given Makefile. This one command
8156: will build both PIC and non-PIC library objects, so you need not
8157: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8158: <li class="listitem">
1.1 dsieger 8159: <p>For the linking of the library, remove any
1.23 wiz 8160: <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
8161: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8162: <pre class="programlisting">
8163: ${LIBTOOL} --mode=link \
8164: ${CC} -o ${.TARGET:.a=.la} \
8165: ${OBJS:.o=.lo} \
8166: -rpath ${PREFIX}/lib \
8167: -version-info major:minor
8168: </pre>
8169: <p>Note that the library is changed to have a
8170: <code class="filename">.la</code> extension, and the objects are
8171: changed to have a <code class="filename">.lo</code>
8172: extension. Change <code class="varname">OBJS</code> as
8173: necessary. This automatically creates all of the
8174: <code class="filename">.a</code>,
8175: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8176: necessary) in the build directory. Be sure to include
1.23 wiz 8177: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8178: minor are zero, as libtool will otherwise strip off the
8179: shared library version.</p>
8180: <p>From the libtool manual:</p>
8181: <pre class="programlisting">
8182: So, libtool library versions are described by three integers:
8183:
8184: CURRENT
8185: The most recent interface number that this library implements.
8186:
8187: REVISION
8188: The implementation number of the CURRENT interface.
8189:
8190: AGE
8191: The difference between the newest and oldest interfaces that
8192: this library implements. In other words, the library implements
8193: all the interface numbers in the range from number `CURRENT -
8194: AGE' to `CURRENT'.
8195:
8196: If two libraries have identical CURRENT and AGE numbers, then the
8197: dynamic linker chooses the library with the greater REVISION number.
8198: </pre>
1.23 wiz 8199: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8200: different results for a.out and ELF (excluding symlinks)
8201: in only one case. An ELF library of the form
1.23 wiz 8202: <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 8203: will have a symlink of
1.23 wiz 8204: <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 8205: on an a.out platform. This is handled
8206: automatically.</p>
1.23 wiz 8207: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8208: directory of the library being built.</p>
8209: <p>In the <code class="filename">PLIST</code>, include only the
8210: <code class="filename">.la</code> file, the other files will be
8211: added automatically.</p>
8212: </li>
1.23 wiz 8213: <li class="listitem">
1.1 dsieger 8214: <p>When linking shared object (<code class="filename">.so</code>)
1.29 dholland 8215: 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 8216: shared libraries, use <span class="quote">“<span class="quote">-module
8217: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8218: tacked on.</p>
8219: <p>The <code class="filename">PLIST</code> file gets the
8220: <code class="filename">foo.so</code> entry.</p>
8221: </li>
1.23 wiz 8222: <li class="listitem">
1.1 dsieger 8223: <p>When linking programs that depend on these libraries
8224: <span class="emphasis"><em>before</em></span> they are installed, preface
1.29 dholland 8225: 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 8226: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8227: libraries (static or shared), but please be aware that
8228: libtool will not allow you to specify a relative path in
1.23 wiz 8229: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8230: expects you to change that argument to be the
8231: <code class="filename">.la</code> file. e.g.</p>
8232: <pre class="programlisting">
8233: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8234: </pre>
8235: <p>should be changed to:</p>
8236: <pre class="programlisting">
8237: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8238: </pre>
8239: <p>and it will do the right thing with the libraries.</p>
8240: </li>
1.23 wiz 8241: <li class="listitem">
1.29 dholland 8242: <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>
8243: 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 8244: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8245: <code class="filename">.la</code>. e.g.</p>
8246: <pre class="programlisting">
1.22 jakllsch 8247: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 8248: </pre>
8249: <p>This will install the static <code class="filename">.a</code>,
8250: shared library, any needed symlinks, and run
1.29 dholland 8251: <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 8252: </li>
1.23 wiz 8253: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8254: the <code class="filename">.la</code>
8255: file (this is a change from previous behaviour).</p></li>
8256: </ol></div>
8257: </div>
1.41 asau 8258: <div class="sect2">
1.1 dsieger 8259: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8260: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8261: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8262: package Makefile. This will override the package's own libtool
8263: in most cases. For older libtool using packages, libtool is
8264: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8265: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8266: configure; find work*/ -name libtool</strong></span>.</p>
8267: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8268: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8269: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8270: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8271: package's libtool script(s), set it as appropriate.</p>
8272: <p>If you do not need <code class="filename">*.a</code> static
8273: libraries built and installed, then use
8274: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8275: <p>If your package makes use of the platform-independent library
8276: for loading dynamic shared objects, that comes with libtool
8277: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8278: <p>Some packages use libtool incorrectly so that the package
8279: may not work or build in some circumstances. Some of the more
8280: common errors are:</p>
1.41 asau 8281: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8282: <li class="listitem">
1.1 dsieger 8283: <p>The inclusion of a shared object (-module) as a dependent library in an
8284: executable or library. This in itself isn't a problem if one of two things
8285: has been done:</p>
1.23 wiz 8286: <div class="orderedlist"><ol class="orderedlist" type="1">
8287: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8288: <code class="filename">libfoo.la</code>, not
8289: <code class="filename">foo.la</code></p></li>
1.23 wiz 8290: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8291: </ol></div>
8292: </li>
1.23 wiz 8293: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8294: The function lt_dlinit() should be called and the macro
8295: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8296: executables.</p></li>
8297: </ul></div>
8298: </div>
1.41 asau 8299: <div class="sect2">
1.1 dsieger 8300: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8301: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8302: <p>If a package needs GNU autoconf or automake to be executed
8303: to regenerate the configure script and Makefile.in makefile
8304: templates, then they should be executed in a pre-configure
8305: target.</p>
8306: <p>For packages that need only autoconf:</p>
8307: <pre class="programlisting">
8308: AUTOCONF_REQD= 2.50 # if default version is not good enough
8309: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8310: ...
8311:
8312: pre-configure:
8313: cd ${WRKSRC} && autoconf
8314:
8315: ...
8316: </pre>
8317: <p>and for packages that need automake and autoconf:</p>
8318: <pre class="programlisting">
8319: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8320: USE_TOOLS+= automake # use "automake14" for automake-1.4
8321: ...
8322:
8323: pre-configure:
8324: set -e; cd ${WRKSRC}; \
8325: aclocal; autoheader; automake -a --foreign -i; autoconf
8326:
8327: ...
8328: </pre>
8329: <p>Packages which use GNU Automake will almost certainly
8330: require GNU Make.</p>
8331: <p>There are times when the configure process makes
8332: additional changes to the generated files, which then causes
8333: the build process to try to re-execute the automake sequence.
8334: This is prevented by touching various files in the configure
8335: stage. If this causes problems with your package you can set
8336: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8337: Makefile.</p>
8338: </div>
8339: </div>
1.41 asau 8340: <div class="sect1">
1.1 dsieger 8341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8342: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 8343: <div class="sect2">
1.1 dsieger 8344: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8345: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8346: <p>Compilers for the C, C++, and Fortran languages comes with
8347: the NetBSD base system. By default, pkgsrc assumes that a package
8348: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 8349: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8350: <p>To declare which language's compiler a package needs, set
8351: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8352: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8353: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8354: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8355: written in C++, usually need a C compiler for the configure
8356: phase.</p>
8357: </div>
1.41 asau 8358: <div class="sect2">
1.1 dsieger 8359: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8360: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8361: <p>If a program is written in Java, use the Java framework in
8362: pkgsrc. The package must include
8363: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8364: provides the following variables:</p>
1.41 asau 8365: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8366: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8367: dependency on the JDK is added. If
1.23 wiz 8368: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8369: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8370: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8371: JDK.</p></li>
1.23 wiz 8372: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8373: a package needs a Java2 implementation. The supported values
1.23 wiz 8374: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8375: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8376: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8377: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8378: above. This variable is not set by default.</p></li>
1.24 wiz 8379: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8380: automatically set to the runtime location of the used Java
8381: implementation dependency. It may be used to set
8382: <code class="varname">JAVA_HOME</code> to a good value if the program
8383: needs this variable to be defined.
8384: </p></li>
1.1 dsieger 8385: </ul></div>
8386: </div>
1.41 asau 8387: <div class="sect2">
1.1 dsieger 8388: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8389: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8390: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8391: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8392: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8393: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8394: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8395: that you want adjusted. Every occurrence of
8396: <code class="filename">*/bin/perl</code> in a she-bang line will be
8397: replaced with the full path to the perl executable.</p>
1.1 dsieger 8398: <p>If a particular version of perl is needed, set the
8399: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8400: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 8401: <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 8402: about handling perl modules.</p>
8403: </div>
1.41 asau 8404: <div class="sect2">
1.1 dsieger 8405: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 8406: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8407: <p><code class="varname">REPLACE_SH</code>,
8408: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8409: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8410: hash bangs in files. Please use the appropriate one, prefering
8411: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 8412: Each should contain a list of scripts, relative to
8413: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8414: occurrence of the matching shell in a she-bang line will be
8415: replaced with the full path to the shell executable.
1.40 wiz 8416: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8417: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8418: </div>
1.41 asau 8419: <div class="sect2">
1.40 wiz 8420: <div class="titlepage"><div><div><h3 class="title">
8421: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8422: <p>Currently, there is no special handling for other languages
8423: in pkgsrc. If a compiler package provides a
8424: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8425: just add a (build) dependency on the appropriate compiler
8426: package.</p>
8427: </div>
8428: </div>
1.41 asau 8429: <div class="sect1">
1.1 dsieger 8430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8431: <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 8432: <p>The most common failures when building a package are that
8433: some platforms do not provide certain header files, functions or
8434: libraries, or they provide the functions in a library that the
8435: original package author didn't know. To work around this, you
8436: can rewrite the source code in most cases so that it does not
8437: use the missing functions or provides a replacement function.</p>
1.41 asau 8438: <div class="sect2">
1.1 dsieger 8439: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8440: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8441: <p>If a package already comes with a GNU configure script, the
8442: preferred way to fix the build failure is to change the
8443: configure script, not the code. In the other cases, you can
8444: utilize the C preprocessor, which defines certain macros
8445: depending on the operating system and hardware architecture it
8446: compiles for. These macros can be queried using for example
8447: <code class="varname">#if defined(__i386)</code>. Almost every operating
8448: system, hardware architecture and compiler has its own macro.
8449: For example, if the macros <code class="varname">__GNUC__</code>,
8450: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8451: are all defined, you know that you are using NetBSD on an i386
8452: compatible CPU, and your compiler is GCC.</p>
8453: <p>The list of the following macros for hardware and
8454: operating system depends on the compiler that is used. For
8455: example, if you want to conditionally compile code on Solaris,
8456: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8457: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8458: <div class="sect3">
1.1 dsieger 8459: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8460: <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 8461: <p>To distinguish between 4.4 BSD-derived systems and the
8462: rest of the world, you should use the following code.</p>
8463: <pre class="programlisting">
8464: #include <sys/param.h>
8465: #if (defined(BSD) && BSD >= 199306)
8466: /* BSD-specific code goes here */
8467: #else
8468: /* non-BSD-specific code goes here */
8469: #endif
8470: </pre>
8471: <p>If this distinction is not fine enough, you can also test
8472: for the following macros.</p>
8473: <pre class="programlisting">
1.45 obache 8474: Cygwin __CYGWIN__
8475: DragonFly __DragonFly__
1.1 dsieger 8476: FreeBSD __FreeBSD__
1.45 obache 8477: Haiku __HAIKU__
1.1 dsieger 8478: Interix __INTERIX
8479: IRIX __sgi (TODO: get a definite source for this)
8480: Linux linux, __linux, __linux__
1.45 obache 8481: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8482: Minix3 __minix
1.1 dsieger 8483: NetBSD __NetBSD__
8484: OpenBSD __OpenBSD__
8485: Solaris sun, __sun
8486: </pre>
8487: </div>
1.41 asau 8488: <div class="sect3">
1.1 dsieger 8489: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8490: <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 8491: <pre class="programlisting">
8492: i386 i386, __i386, __i386__
8493: MIPS __mips
8494: SPARC sparc, __sparc
8495: </pre>
8496: </div>
1.41 asau 8497: <div class="sect3">
1.1 dsieger 8498: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8499: <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 8500: <pre class="programlisting">
8501: GCC __GNUC__ (major version), __GNUC_MINOR__
8502: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8503: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8504: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8505: </pre>
8506: </div>
8507: </div>
1.41 asau 8508: <div class="sect2">
1.1 dsieger 8509: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8510: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8511: <p>Some source files trigger bugs in the compiler, based on
8512: combinations of compiler version and architecture and almost
8513: always relation to optimisation being enabled. Common symptoms
8514: are gcc internal errors or never finishing compiling a
8515: file.</p>
8516: <p>Typically, a workaround involves testing the
8517: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8518: optimisation for that combination of file,
8519: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8520: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8521: number of examples.</p>
8522: </div>
1.41 asau 8523: <div class="sect2">
1.1 dsieger 8524: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 8525: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8526: </h3></div></div></div>
1.1 dsieger 8527: <p>This error message often means that a package did not
8528: link to a shared library it needs. The following functions are
8529: known to cause this error message over and over.</p>
8530: <div class="informaltable">
8531: <a name="undefined-reference-functions"></a><table border="1">
8532: <colgroup>
8533: <col>
8534: <col>
8535: <col>
8536: </colgroup>
8537: <thead><tr>
8538: <th>Function</th>
8539: <th>Library</th>
8540: <th>Affected platforms</th>
8541: </tr></thead>
8542: <tbody>
8543: <tr>
8544: <td>accept, bind, connect</td>
8545: <td>-lsocket</td>
8546: <td>Solaris</td>
8547: </tr>
8548: <tr>
8549: <td>crypt</td>
8550: <td>-lcrypt</td>
8551: <td>DragonFly, NetBSD</td>
8552: </tr>
8553: <tr>
8554: <td>dlopen, dlsym</td>
8555: <td>-ldl</td>
8556: <td>Linux</td>
8557: </tr>
8558: <tr>
8559: <td>gethost*</td>
8560: <td>-lnsl</td>
8561: <td>Solaris</td>
8562: </tr>
8563: <tr>
8564: <td>inet_aton</td>
8565: <td>-lresolv</td>
8566: <td>Solaris</td>
8567: </tr>
8568: <tr>
8569: <td>nanosleep, sem_*, timer_*</td>
8570: <td>-lrt</td>
8571: <td>Solaris</td>
8572: </tr>
8573: <tr>
8574: <td>openpty</td>
8575: <td>-lutil</td>
8576: <td>Linux</td>
8577: </tr>
8578: </tbody>
8579: </table>
8580: </div>
8581: <p>To fix these linker errors, it is often sufficient to say
8582: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8583: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8584: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8585: bmake</strong></span>.</p>
1.41 asau 8586: <div class="sect3">
1.1 dsieger 8587: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8588: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8589: <p>When you are using the SunPro compiler, there is another
8590: possibility. That compiler cannot handle the following code:</p>
8591: <pre class="programlisting">
8592: extern int extern_func(int);
8593:
8594: static inline int
8595: inline_func(int x)
8596: {
8597: return extern_func(x);
8598: }
8599:
8600: int main(void)
8601: {
8602: return 0;
8603: }
8604: </pre>
8605: <p>It generates the code for <code class="function">inline_func</code> even if
8606: that function is never used. This code then refers to
8607: <code class="function">extern_func</code>, which can usually not be resolved. To
8608: solve this problem you can try to tell the package to disable inlining
8609: of functions.</p>
8610: </div>
8611: </div>
1.41 asau 8612: <div class="sect2">
1.1 dsieger 8613: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8614: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8615: <p>Sometimes packages fail to build because the compiler runs
8616: into an operating system specific soft limit. With the
8617: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8618: to unlimit the resources. Currently, the allowed values are
1.23 wiz 8619: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.1 dsieger 8620: Setting this variable is similar to running the shell builtin
1.10 hubertf 8621: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8622: segment size or maximum stack size of a process, respectively, to
8623: their hard limits.</p>
8624: </div>
8625: </div>
1.41 asau 8626: <div class="sect1">
1.1 dsieger 8627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8628: <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 8629: <div class="sect2">
1.1 dsieger 8630: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8631: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8632: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8633: with some operating systems cannot create more than one
8634: directory at a time. As such, you should call
8635: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8636: <pre class="programlisting">
8637: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8638: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8639: </pre>
1.23 wiz 8640: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8641: dir2</code></span>”</span> to the
1.1 dsieger 8642: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8643: automatically do the right thing.</p>
8644: </div>
1.41 asau 8645: <div class="sect2">
1.1 dsieger 8646: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8647: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8648: <p>In general, documentation should be installed into
8649: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8650: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8651: includes the version number of the package).</p>
8652: <p>Many modern packages using GNU autoconf allow to set the
8653: directory where HTML documentation is installed with the
1.23 wiz 8654: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8655: is needed because otherwise the documentation ends up in
8656: <code class="filename">${PREFIX}/share/doc/html</code> or other
8657: places.</p>
8658: <p>An exception to the above is that library API documentation
8659: 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
8660: browsers (devhelp) should be left at their default location, which
8661: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8662: documentation can be recognized from files ending in
8663: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8664: (It is also acceptable to install such files in
8665: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8666: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8667: <code class="filename">.devhelp*</code> file must be directly in that
8668: directory then, no additional subdirectory level is allowed in
8669: this case. This is usually achieved by using
1.23 wiz 8670: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8671: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8672: though.)</p>
8673: </div>
1.41 asau 8674: <div class="sect2">
1.1 dsieger 8675: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8676: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8677: <p>Certain packages, most of them in the games category, install
8678: a score file that allows all users on the system to record their
8679: highscores. In order for this to work, the binaries need to be
8680: installed setgid and the score files owned by the appropriate
1.35 wiz 8681: group and/or owner (traditionally the "games" user/group). Set
8682: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8683: following variables, documented in more detail in
8684: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8685: behaviour: <code class="varname">GAMEDATAMODE</code>,
8686: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8687: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.14 jmcneill 8688: <p>A package should therefore never hard code file ownership or
1.1 dsieger 8689: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8690: <code class="varname">INSTALL_GAME_DATA</code> to set these
8691: correctly.</p>
8692: </div>
1.41 asau 8693: <div class="sect2">
1.1 dsieger 8694: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8695: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8696: <p><code class="varname">DESTDIR</code> support means that a package
8697: installs into a staging directory, not the final location of the
8698: files. Then a binary package is created which can be used for
8699: installation as usual. There are two ways: Either the package must
1.23 wiz 8700: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8701: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8702: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8703: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 8704: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8705: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8706: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8707: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8708: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8709: the inclusion.</p></li>
1.23 wiz 8710: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8711: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8712: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8713: automatically. Many manual rules and pre/post-install often are
8714: incorrect; fix them.</p></li>
1.23 wiz 8715: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8716: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8717: <li class="listitem"><p>In general, packages should support
1.4 rillig 8718: <code class="varname">UNPRIVILEGED</code> to be able to use
8719: DESTDIR.</p></li>
8720: </ul></div>
8721: </div>
1.41 asau 8722: <div class="sect2">
1.4 rillig 8723: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8724: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8725: <p>Your package may also contain scripts with hardcoded paths to
8726: other interpreters besides (or as well as) perl. To correct the
8727: full pathname to the script interpreter, you need to set the
8728: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8729: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8730: <pre class="programlisting">
8731: REPLACE_INTERPRETER+= tcl
8732: REPLACE.tcl.old= .*/bin/tclsh
8733: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8734: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8735: # relative to ${WRKSRC}, just as in REPLACE_PERL
8736: </pre>
1.41 asau 8737: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8738: <h3 class="title">Note</h3>
8739: <p>Before March 2006, these variables were called
8740: <code class="varname">_REPLACE.*</code> and
8741: <code class="varname">_REPLACE_FILES.*</code>.</p>
8742: </div>
8743: </div>
1.41 asau 8744: <div class="sect2">
1.1 dsieger 8745: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8746: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8747: <p>Makefiles of packages providing perl5 modules should include
8748: the Makefile fragment
8749: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8750: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8751: configuration for such modules as well as various hooks to tune
8752: this configuration. See comments in this file for
8753: details.</p>
8754: <p>Perl5 modules will install into different places depending
8755: on the version of perl used during the build process. To
8756: address this, pkgsrc will append lines to the
8757: <code class="filename">PLIST</code> corresponding to the files listed in
8758: the installed <code class="filename">.packlist</code> file generated by
8759: most perl5 modules. This is invoked by defining
8760: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8761: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8762: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8763: e.g.:</p>
1.1 dsieger 8764: <pre class="programlisting">
1.47 wiz 8765: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 8766: </pre>
1.47 wiz 8767: <p>The perl5 config variables
8768: <code class="varname">installarchlib</code>,
8769: <code class="varname">installscript</code>,
8770: <code class="varname">installvendorbin</code>,
8771: <code class="varname">installvendorscript</code>,
8772: <code class="varname">installvendorarch</code>,
8773: <code class="varname">installvendorlib</code>,
8774: <code class="varname">installvendorman1dir</code>, and
8775: <code class="varname">installvendorman3dir</code> represent those
8776: locations in which components of perl5 modules may be installed,
8777: provided as variable with uppercase and prefixed with
8778: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8779: and may be used by perl5 packages that don't have a packlist.
8780: These variables are also substituted for in the
8781: <code class="filename">PLIST</code> as uppercase prefixed with
8782: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8783: </div>
1.41 asau 8784: <div class="sect2">
1.1 dsieger 8785: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8786: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8787: <p>Some packages install info files or use the
1.23 wiz 8788: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8789: commands. <code class="varname">INFO_FILES</code> should be defined in
8790: the package Makefile so that <code class="filename">INSTALL</code> and
8791: <code class="filename">DEINSTALL</code> scripts will be generated to
8792: handle registration of the info files in the Info directory
1.23 wiz 8793: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8794: files registration is either provided by the system, or by a
8795: special purpose package automatically added as dependency if
8796: needed.</p>
8797: <p><code class="varname">PKGINFODIR</code> is the directory under
8798: <code class="filename">${PREFIX}</code> where info files are primarily
8799: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8800: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8801: <p>The info files for the package should be listed in the
8802: package <code class="filename">PLIST</code>; however any split info files
8803: need not be listed.</p>
1.23 wiz 8804: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8805: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8806: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8807: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8808: should be noted with the <code class="varname">TEXINFO_REQD</code>
8809: variable in the package <code class="filename">Makefile</code>. By
8810: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8811: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8812: does not match the required minimum, a build dependency on the
8813: <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
8814: be added automatically.</p>
8815: <p>The build and installation process of the software provided
8816: by the package should not use the
1.10 hubertf 8817: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8818: info files is the task of the package
8819: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8820: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8821: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8822: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8823: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8824: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8825: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8826: no effect except the logging of a message. The script overriding
1.10 hubertf 8827: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8828: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8829: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8830: </div>
1.41 asau 8831: <div class="sect2">
1.1 dsieger 8832: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8833: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8834: <p>All packages that install manual pages should install them
8835: into the same directory, so that there is one common place to look
8836: for them. In pkgsrc, this place is
8837: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8838: should be used in packages. The default for
8839: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8840: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8841: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8842: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8843: <h3 class="title">Note</h3>
8844: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8845: is far from complete.</p>
8846: </div>
8847: <p>The <code class="filename">PLIST</code> files can just use
8848: <code class="filename">man/</code> as the top level directory for the man
8849: page file entries, and the pkgsrc framework will convert as
8850: needed. In all other places, the correct
8851: <code class="varname">PKGMANDIR</code> must be used.</p>
8852: <p>Packages that are
8853: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8854: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8855: <code class="filename">./configure</code>
8856: --mandir switch to set where the man pages should be installed.
8857: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8858: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8859: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8860: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8861: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8862: Or if the <code class="filename">./configure</code> script uses
8863: a non-standard use of --mandir, you can set
8864: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8865: <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 8866: information on installation of compressed manual pages.</p>
8867: </div>
1.41 asau 8868: <div class="sect2">
1.1 dsieger 8869: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8870: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8871: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8872: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8873: you need to take some extra steps to make sure they get registered
8874: in the database:</p>
1.23 wiz 8875: <div class="orderedlist"><ol class="orderedlist" type="1">
8876: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8877: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8878: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8879: deinstallation time, and tells the package where to install
1.7 rillig 8880: GConf data files using some standard configure arguments. It
1.1 dsieger 8881: also disallows any access to the database directly from the
8882: package.</p></li>
1.23 wiz 8883: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8884: <code class="filename">.schemas</code> files under
8885: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8886: installed under <code class="filename">${PREFIX}/etc</code>, you will
8887: need to manually patch the package.</p></li>
1.23 wiz 8888: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8889: directory, as they will be handled automatically. See
1.65 wiz 8890: <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 8891: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8892: your <code class="filename">Makefile</code> with a list of all
8893: <code class="filename">.schemas</code> files installed by the package, if
8894: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8895: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8896: your <code class="filename">Makefile</code> with a
8897: list of all <code class="filename">.entries</code> files installed by the
8898: package, if any. Names must not contain any directories in
8899: them.</p></li>
8900: </ol></div>
8901: </div>
1.41 asau 8902: <div class="sect2">
1.1 dsieger 8903: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 8904: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8905: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8906: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8907: get registered in the database:</p>
1.23 wiz 8908: <div class="orderedlist"><ol class="orderedlist" type="1">
8909: <li class="listitem"><p>Include
1.18 snj 8910: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8911: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8912: takes care of rebuilding the scrollkeeper database at
8913: installation and deinstallation time, and disallows any access
8914: to it directly from the package.</p></li>
1.23 wiz 8915: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8916: <code class="filename">libdata/scrollkeeper</code> directory, as they
8917: will be handled automatically.</p></li>
1.23 wiz 8918: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8919: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8920: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8921: </ol></div>
8922: </div>
1.41 asau 8923: <div class="sect2">
1.1 dsieger 8924: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8925: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8926: <p>If a package installs font files, you will need to rebuild
8927: the fonts database in the directory where they get installed at
8928: installation and deinstallation time. This can be automatically
8929: done by using the pkginstall framework.</p>
8930: <p>You can list the directories where fonts are installed in the
8931: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8932: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8933: <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 8934: Also make sure that the database file
8935: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8936: <p>Note that you should not create new directories for fonts;
8937: instead use the standard ones to avoid that the user needs to
8938: manually configure his X server to find them.</p>
8939: </div>
1.41 asau 8940: <div class="sect2">
1.1 dsieger 8941: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8942: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8943: <p>If a package installs GTK2 immodules or loaders, you need to
8944: take some extra steps to get them registered in the GTK2 database
8945: properly:</p>
1.23 wiz 8946: <div class="orderedlist"><ol class="orderedlist" type="1">
8947: <li class="listitem"><p>Include
1.1 dsieger 8948: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8949: <code class="filename">buildlink3.mk</code> file. This takes care of
8950: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8951: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8952: your package installs GTK2 immodules.</p></li>
1.23 wiz 8953: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8954: GTK2 loaders.</p></li>
1.23 wiz 8955: <li class="listitem">
1.1 dsieger 8956: <p>Patch the package to not touch any of the GTK2
8957: databases directly. These are:</p>
1.41 asau 8958: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8959: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8960: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8961: </ul></div>
8962: </li>
1.23 wiz 8963: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8964: any entries under the <code class="filename">libdata/gtk-2.0</code>
8965: directory, as they will be handled automatically.</p></li>
8966: </ol></div>
8967: </div>
1.41 asau 8968: <div class="sect2">
1.1 dsieger 8969: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8970: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8971: <p>If a package installs SGML or XML data files that need to be
8972: registered in system-wide catalogs (like DTDs, sub-catalogs,
8973: etc.), you need to take some extra steps:</p>
1.23 wiz 8974: <div class="orderedlist"><ol class="orderedlist" type="1">
8975: <li class="listitem"><p>Include
1.1 dsieger 8976: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8977: your <code class="filename">Makefile</code>, which takes care of
8978: registering those files in system-wide catalogs at
8979: installation and deinstallation time.</p></li>
1.23 wiz 8980: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8981: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8982: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8983: any XML catalogs installed by the package.</p></li>
1.23 wiz 8984: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8985: to be added to the SGML catalog. These come in groups of
8986: three strings; see xmlcatmgr(1) for more information
8987: (specifically, arguments recognized by the 'add' action).
8988: Note that you will normally not use this variable.</p></li>
1.23 wiz 8989: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8990: to be added to the XML catalog. These come in groups of three
8991: strings; see xmlcatmgr(1) for more information (specifically,
8992: arguments recognized by the 'add' action). Note that you will
8993: normally not use this variable.</p></li>
8994: </ol></div>
8995: </div>
1.41 asau 8996: <div class="sect2">
1.1 dsieger 8997: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8998: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8999: <p>If a package provides extensions to the MIME database by
9000: installing <code class="filename">.xml</code> files inside
9001: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9002: need to take some extra steps to ensure that the database is kept
9003: consistent with respect to these new files:</p>
1.23 wiz 9004: <div class="orderedlist"><ol class="orderedlist" type="1">
9005: <li class="listitem"><p>Include
1.1 dsieger 9006: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9007: (avoid using the <code class="filename">buildlink3.mk</code> file from
9008: this same directory, which is reserved for inclusion from
9009: other <code class="filename">buildlink3.mk</code> files). It takes
9010: care of rebuilding the MIME database at installation and
9011: deinstallation time, and disallows any access to it directly
9012: from the package.</p></li>
1.23 wiz 9013: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9014: <code class="filename">share/mime</code> directory,
9015: <span class="emphasis"><em>except</em></span> for files saved under
9016: <code class="filename">share/mime/packages</code>. The former are
9017: handled automatically by
9018: the update-mime-database program, but the latter are
9019: package-dependent and must be removed by the package that
9020: installed them in the first place.</p></li>
1.23 wiz 9021: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9022: from the PLIST. They will be handled by the shared-mime-info
9023: package.</p></li>
9024: </ol></div>
9025: </div>
1.41 asau 9026: <div class="sect2">
1.1 dsieger 9027: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9028: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9029: <p>If a package uses intltool during its build, add
9030: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9031: which forces it to use the intltool package provided by pkgsrc,
9032: instead of the one bundled with the distribution file.</p>
9033: <p>This tracks intltool's build-time dependencies and uses the
9034: latest available version; this way, the package benefits of any
9035: bug fixes that may have appeared since it was released.</p>
9036: </div>
1.41 asau 9037: <div class="sect2">
1.1 dsieger 9038: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9039: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9040: <p>If a package contains a rc.d script, it won't be copied into
9041: the startup directory by default, but you can enable it, by adding
9042: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9043: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9044: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9045: it will automatically remove the scripts when the package is
9046: deinstalled.</p>
9047: </div>
1.41 asau 9048: <div class="sect2">
1.1 dsieger 9049: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9050: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9051: <p>If a package installs TeX packages into the texmf tree,
9052: the <code class="filename">ls-R</code> database of the tree needs to be
9053: updated.</p>
1.41 asau 9054: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9055: <h3 class="title">Note</h3>
1.22 jakllsch 9056: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9057: packages should install files
1.22 jakllsch 9058: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9059: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9060: </div>
1.23 wiz 9061: <div class="orderedlist"><ol class="orderedlist" type="1">
9062: <li class="listitem"><p>Include
1.22 jakllsch 9063: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9064: takes care of rebuilding the <code class="filename">ls-R</code>
9065: database at installation and deinstallation time.</p></li>
1.23 wiz 9066: <li class="listitem">
1.1 dsieger 9067: <p>If your package installs files into a texmf
9068: tree other than the one
1.22 jakllsch 9069: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9070: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9071: trees that need database update.</p>
9072: <p>If your package also installs font map files that need
1.10 hubertf 9073: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9074: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9075: set <code class="varname">TEX_MAP_FILES</code> and/or
9076: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9077: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9078: be run automatically at installation/deinstallation to
9079: enable/disable font map files for TeX output
9080: drivers.</p>
9081: </li>
1.23 wiz 9082: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9083: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9084: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9085: </ol></div>
9086: </div>
1.41 asau 9087: <div class="sect2">
1.1 dsieger 9088: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9089: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9090: emulation</h3></div></div></div>
9091: <p>There are some packages that provide libraries and
9092: executables for running binaries from a one operating system
9093: on a different one (if the latter supports it). One example
9094: is running Linux binaries on NetBSD.</p>
9095: <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>
9096: helps in extracting and packaging Linux rpm packages.</p>
9097: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9098: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9099: if all libraries for each installed executable can be found by
9100: the dynamic linker. Since the standard dynamic linker is run,
9101: this fails for emulation packages, because the libraries used
9102: by the emulation are not in the standard directories.</p>
9103: </div>
1.41 asau 9104: <div class="sect2">
1.1 dsieger 9105: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9106: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9107: <p>If a package installs images under the
9108: <code class="filename">share/icons/hicolor</code> and/or updates the
9109: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9110: database, you need to take some extra steps to make sure that the
9111: shared theme directory is handled appropriately and that the cache
9112: database is rebuilt:</p>
1.23 wiz 9113: <div class="orderedlist"><ol class="orderedlist" type="1">
9114: <li class="listitem"><p>Include
1.1 dsieger 9115: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 9116: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 9117: entry that refers to the theme cache.</p></li>
1.23 wiz 9118: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 9119: directories from the <code class="filename">share/icons/hicolor</code>
9120: hierarchy because they will be handled automatically.</p></li>
9121: </ol></div>
9122: <p>The best way to verify that the PLIST is correct with
9123: respect to the last two points is to regenerate it using
1.10 hubertf 9124: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9125: </div>
1.41 asau 9126: <div class="sect2">
1.1 dsieger 9127: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9128: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9129: <p>If a package installs <code class="filename">.desktop</code> files
9130: under <code class="filename">share/applications</code> and these include
1.53 rodent 9131: MIME information (MimeType key), you need to take extra steps to
9132: ensure that they are registered into the MIME database:</p>
1.23 wiz 9133: <div class="orderedlist"><ol class="orderedlist" type="1">
9134: <li class="listitem"><p>Include
1.1 dsieger 9135: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 9136: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 9137: <code class="filename">share/applications/mimeinfo.cache</code> file.
9138: It will be handled automatically.</p></li>
9139: </ol></div>
9140: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9141: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9142: print-PLIST</strong></span>.</p>
9143: </div>
9144: </div>
1.41 asau 9145: <div class="sect1">
1.1 dsieger 9146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9147: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9148: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 9149: immediately. In this case, one can plainly mark a package as broken. For
9150: this, one just sets the variable <code class="varname">BROKEN</code> to the
9151: reason why the package is broken (similar to the
9152: <code class="varname">RESTRICTED</code> variable). A user trying to build
9153: the package will immediately be shown this message, and the build
9154: will not be even tried.</p>
9155: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 9156: intervals.</p>
9157: </div>
9158: </div>
1.41 asau 9159: <div class="chapter">
1.1 dsieger 9160: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9161: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9162: <p>To check out all the gotchas when building a package, here are
9163: the steps that I do in order to get a package working. Please note
9164: this is basically the same as what was explained in the previous
9165: sections, only with some debugging aids.</p>
1.41 asau 9166: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9167: <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>
9168: <li class="listitem">
1.1 dsieger 9169: <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>,
9170: create a directory for a new package, change into it, then run
1.10 hubertf 9171: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9172: <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>
9173: <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>
9174: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9175: </li>
1.23 wiz 9176: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9177: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9178: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9179: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 9180: configure step to the package's
9181: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 9182: <li class="listitem">
1.1 dsieger 9183: <p>Make the package compile, doing multiple rounds of</p>
9184: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9185: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9186: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9187: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9188: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9189: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9190: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9191: <p>Doing this step as non-root user will ensure that no files
9192: are modified that shouldn't be, especially during the build
1.10 hubertf 9193: phase. <span class="command"><strong>mkpatches</strong></span>,
9194: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1 dsieger 9195: 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>
9196: package.</p>
9197: </li>
1.23 wiz 9198: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9199: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9200: <li class="listitem">
1.1 dsieger 9201: <p>Generate a <code class="filename">PLIST</code>:</p>
9202: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9203: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9204: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9205: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9206: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9207: <p>You usually need to be <code class="username">root</code> to do
9208: this. Look if there are any files left:</p>
9209: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9210: <p>If this reveals any files that are missing in
9211: <code class="filename">PLIST</code>, add them.</p>
9212: </li>
1.23 wiz 9213: <li class="listitem">
1.1 dsieger 9214: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9215: package again and make a binary package:</p>
9216: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9217: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9218: </li>
1.23 wiz 9219: <li class="listitem">
1.1 dsieger 9220: <p>Delete the installed package:</p>
9221: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9222: </li>
1.23 wiz 9223: <li class="listitem">
1.10 hubertf 9224: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9225: command, which shouldn't find anything now:</p>
9226: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9227: </li>
1.23 wiz 9228: <li class="listitem">
1.1 dsieger 9229: <p>Reinstall the binary package:</p>
9230: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9231: </li>
1.23 wiz 9232: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9233: <li class="listitem">
1.10 hubertf 9234: <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 9235: reports:</p>
9236: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9237: </li>
1.23 wiz 9238: <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 9239: </ul></div>
9240: </div>
1.41 asau 9241: <div class="chapter">
1.1 dsieger 9242: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9243: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9244: <div class="toc">
9245: <p><b>Table of Contents</b></p>
9246: <dl>
1.6 rillig 9247: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9248: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9249: <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 9250: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 9251: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 9252: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9253: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9254: </dl>
9255: </div>
1.41 asau 9256: <div class="sect1">
1.1 dsieger 9257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9258: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9259: <p>Our policy is that we accept binaries only from pkgsrc
9260: developers to guarantee that the packages don't contain any
9261: trojan horses etc. This is not to annoy anyone but rather to
9262: protect our users! You're still free to put up your home-made
9263: binary packages and tell the world where to get them. NetBSD
9264: developers doing bulk builds and wanting to upload them please
1.66 asau 9265: 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
9266: builds)</i></a>.</p>
1.1 dsieger 9267: </div>
1.41 asau 9268: <div class="sect1">
1.1 dsieger 9269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9270: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9271: <p>First, check that your package is complete, compiles and
1.10 hubertf 9272: 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 9273: 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 9274: archive that contains all files that make up the package.
9275: Finally, send this package to the pkgsrc bug tracking system,
1.29 dholland 9276: 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 9277: that, go to the web page
1.10 hubertf 9278: <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 9279: which contains some instructions and a link to a form where you
9280: can submit packages. The
9281: <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
9282: also available as a substitute for either of the above two tools.
9283: </p>
1.1 dsieger 9284: <p>In the form of the problem report, the category should be
1.23 wiz 9285: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9286: and version number, and the description field should contain a
9287: short description of your package (contents of the COMMENT
9288: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9289: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9290: <p>If you want to submit several packages, please send a
9291: separate PR for each one, it's easier for us to track things
9292: that way.</p>
9293: <p>Alternatively, you can also import new packages into
1.23 wiz 9294: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.10 hubertf 9295: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1 dsieger 9296: for details.</p>
9297: </div>
1.41 asau 9298: <div class="sect1">
1.1 dsieger 9299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9300: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9301: <p>Please note all package additions, updates, moves, and
9302: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9303: important to keep this file up to date and conforming to the
9304: existing format, because it will be used by scripts to
1.10 hubertf 9305: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9306: sites. Additionally, check the
9307: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9308: for the package you updated or removed, in case it was mentioned
9309: there.</p>
9310: <p>When the <code class="varname">PKGREVISION</code> of a package is
9311: bumped, the change should appear in
9312: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9313: related or otherwise relevant. Mass bumps that result from a
9314: dependency being updated should not be mentioned. In all other
9315: cases it's the developer's decision.</p>
9316: <p>There is a make target that helps in creating proper
1.10 hubertf 9317: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9318: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9319: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9320: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9321: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9322: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9323: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9324: For new packages, or package moves or removals, set the
9325: <code class="varname">CTYPE</code> variable on the command line to "Added",
9326: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9327: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9328: not the same as your NetBSD login name. The target also automatically
9329: removes possibly existing entries for the package in the
9330: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9331: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9332: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9333: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9334: makes the cvs commands use the main repository.
9335: </p>
1.1 dsieger 9336: </div>
1.41 asau 9337: <div class="sect1">
1.1 dsieger 9338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 9339: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9340: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9341: access to the pkgsrc repository.</p>
9342: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9343: Start by adding the directory and then files in the directory. Don't
9344: forget to add the new package to the category's
9345: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9346: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9347: <pre class="programlisting">
9348: <code class="prompt">$</code> cd .../pkgsrc/category
9349: <code class="prompt">$</code> cvs add pkgname
9350: <code class="prompt">$</code> cd pkgname
9351: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9352: <code class="prompt">$</code> cvs add patches/p*
9353: <code class="prompt">$</code> cvs status | less
1.34 wiz 9354: <code class="prompt">$</code> cvs commit
1.33 wiz 9355: <code class="prompt">$</code> cd ..
9356: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9357: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9358: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9359: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9360: </pre>
1.1 dsieger 9361: <p>The commit message of the initial import should include part of the
9362: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9363: what the package is/does.</p>
1.33 wiz 9364: <p>Also mention the new package in
9365: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9366: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9367: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9368: </div>
1.41 asau 9369: <div class="sect1">
1.1 dsieger 9370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9371: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9372: <p>Please always put a concise, appropriate and relevant summary of the
9373: changes between old and new versions into the commit log when updating
9374: a package. There are various reasons for this:</p>
1.41 asau 9375: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9376: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9377: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9378: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9379: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9380: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9381: repository is very useful for people who read the pkgsrc-changes mailing
9382: list, so that they can make tactical decisions about when to upgrade
9383: the package.</p></li>
9384: </ul></div>
9385: <p>Please also recognize that, just because a new version of a package
9386: has been released, it should not automatically be upgraded in the CVS
9387: repository. We prefer to be conservative in the packages that are
9388: included in pkgsrc - development or beta packages are not really the
9389: best thing for most places in which pkgsrc is used. Please use your
9390: judgement about what should go into pkgsrc, and bear in mind that
9391: stability is to be preferred above new and possibly untested features.</p>
9392: </div>
1.41 asau 9393: <div class="sect1">
1.1 dsieger 9394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 9395: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9396: <p>Renaming packages is not recommended.</p>
9397: <p>When renaming packages, be sure to fix any references to old name
9398: in other Makefiles, options, buildlink files, etc.</p>
9399: <p>Also When renaming a package, please define
9400: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9401: pattern(s) of the previous package name.
9402: This may be repeated for multiple renames.
9403: The new package would be an exact replacement.
9404: </p>
1.23 wiz 9405: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9406: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9407: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9408: not be an exact replacement but is a suggestion for the replaced
9409: functionality.</p>
9410: </div>
1.41 asau 9411: <div class="sect1">
1.20 snj 9412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9413: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9414: <p>It is preferred that packages are not renamed or moved, but if needed
9415: please follow these steps.
9416: </p>
1.23 wiz 9417: <div class="orderedlist"><ol class="orderedlist" type="1">
9418: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9419: <li class="listitem">
1.1 dsieger 9420: <p>Remove all CVS dirs.</p>
9421: <p>Alternatively to the first two steps you can also do:</p>
9422: <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>
9423: <p>and use that for further work.</p>
9424: </li>
1.23 wiz 9425: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9426: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9427: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9428: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9429: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9430: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9431: for doing an update using pkgsrc building; for example, it can
1.29 dholland 9432: 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 9433: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9434: new <code class="varname">PKGPATH</code> for that moved package. Note that
9435: it may have multiple matches, so the tool should also check on the
9436: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9437: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9438: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9439: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9440: place.</p></li>
1.23 wiz 9441: <li class="listitem">
1.1 dsieger 9442: <p>Check if any package depends on it:
9443: </p>
9444: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9445: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9446: </li>
1.23 wiz 9447: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9448: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9449: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9450: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9451: <li class="listitem">
1.1 dsieger 9452: <p>Commit the changed and removed files:</p>
9453: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9454: <p>(and any packages from step 5, of course).</p>
9455: </li>
9456: </ol></div>
9457: </div>
9458: </div>
1.41 asau 9459: <div class="chapter">
1.1 dsieger 9460: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9461: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9462: <p>This section contains the answers to questions that may
9463: arise when you are writing a package. If you don't find your
9464: question answered here, first have a look in the other chapters,
9465: and if you still don't have the answer, ask on the
9466: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9467: <div class="qandaset">
1.77 ! wiz 9468: <a name="idm72688784"></a><dl>
1.6 rillig 9469: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9470: MAKEFLAGS, .MAKEFLAGS and
9471: MAKE_FLAGS?</a>
9472: </dt>
1.6 rillig 9473: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9474: MAKE, GMAKE and
9475: MAKE_PROGRAM?</a>
9476: </dt>
1.6 rillig 9477: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9478: CC, PKG_CC and
9479: PKGSRC_COMPILER?</a>
9480: </dt>
1.6 rillig 9481: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9482: BUILDLINK_LDFLAGS,
9483: BUILDLINK_LDADD and
9484: BUILDLINK_LIBS?</a>
9485: </dt>
1.6 rillig 9486: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9487: VARNAME=BUILDLINK_PREFIX.foo
9488: say it's empty?</a>
9489: </dt>
1.6 rillig 9490: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9491: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9492: don't understand the := inside
9493: it.</a>
9494: </dt>
1.6 rillig 9495: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9496: developers?</a>
9497: </dt>
1.6 rillig 9498: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9499: documentation?</a>
9500: </dt>
1.6 rillig 9501: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9502: do?</a>
9503: </dt>
9504: </dl>
1.41 asau 9505: <table border="0" style="width: 100%;">
9506: <colgroup>
1.1 dsieger 9507: <col align="left" width="1%">
1.23 wiz 9508: <col>
1.41 asau 9509: </colgroup>
1.1 dsieger 9510: <tbody>
1.41 asau 9511: <tr class="question">
1.1 dsieger 9512: <td align="left" valign="top">
1.77 ! wiz 9513: <a name="devfaq.makeflags"></a><a name="idm72688400"></a><p><b>22.1.</b></p>
1.1 dsieger 9514: </td>
9515: <td align="left" valign="top"><p>What is the difference between
9516: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9517: <code class="varname">MAKE_FLAGS</code>?</p></td>
9518: </tr>
9519: <tr class="answer">
9520: <td align="left" valign="top"></td>
9521: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.29 dholland 9522: 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 9523: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9524: the <code class="varname">MAKE_PROGRAM</code> when building the
9525: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9526: </tr>
1.41 asau 9527: <tr class="question">
1.1 dsieger 9528: <td align="left" valign="top">
1.77 ! wiz 9529: <a name="devfaq.make"></a><a name="idm72684304"></a><p><b>22.2.</b></p>
1.1 dsieger 9530: </td>
9531: <td align="left" valign="top"><p>What is the difference between
9532: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9533: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9534: </tr>
9535: <tr class="answer">
9536: <td align="left" valign="top"></td>
9537: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.29 dholland 9538: <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 9539: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9540: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9541: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9542: Make program that is used for building the
9543: package.</p></td>
9544: </tr>
1.41 asau 9545: <tr class="question">
1.1 dsieger 9546: <td align="left" valign="top">
1.77 ! wiz 9547: <a name="devfaq.cc"></a><a name="idm72679952"></a><p><b>22.3.</b></p>
1.1 dsieger 9548: </td>
9549: <td align="left" valign="top"><p>What is the difference between
9550: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9551: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9552: </tr>
9553: <tr class="answer">
9554: <td align="left" valign="top"></td>
9555: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9556: compiler, which can be configured by the pkgsrc user.
9557: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9558: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9559: path to a compiler, but the type of compiler that should be
9560: used. See <code class="filename">mk/compiler.mk</code> for more
9561: information about the latter variable.</p></td>
9562: </tr>
1.41 asau 9563: <tr class="question">
1.1 dsieger 9564: <td align="left" valign="top">
1.77 ! wiz 9565: <a name="devfaq.bl3flags"></a><a name="idm72675728"></a><p><b>22.4.</b></p>
1.1 dsieger 9566: </td>
9567: <td align="left" valign="top"><p>What is the difference between
9568: <code class="varname">BUILDLINK_LDFLAGS</code>,
9569: <code class="varname">BUILDLINK_LDADD</code> and
9570: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9571: </tr>
9572: <tr class="answer">
9573: <td align="left" valign="top"></td>
9574: <td align="left" valign="top"><p>[FIXME]</p></td>
9575: </tr>
1.41 asau 9576: <tr class="question">
1.1 dsieger 9577: <td align="left" valign="top">
1.77 ! wiz 9578: <a name="devfaq.bl3prefix"></a><a name="idm72673552"></a><p><b>22.5.</b></p>
1.1 dsieger 9579: </td>
1.10 hubertf 9580: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9581: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9582: say it's empty?</p></td>
9583: </tr>
9584: <tr class="answer">
9585: <td align="left" valign="top"></td>
9586: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9587: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9588: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9589: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9590: command.</p></td>
9591: </tr>
1.41 asau 9592: <tr class="question">
1.1 dsieger 9593: <td align="left" valign="top">
1.77 ! wiz 9594: <a name="devfaq.master_sites"></a><a name="idm72670480"></a><p><b>22.6.</b></p>
1.1 dsieger 9595: </td>
9596: <td align="left" valign="top"><p>What does
9597: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9598: don't understand the <code class="literal">:=</code> inside
9599: it.</p></td>
9600: </tr>
9601: <tr class="answer">
9602: <td align="left" valign="top"></td>
9603: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9604: assignment operator, like you might expect at first sight.
9605: Instead, it is a degenerate form of
9606: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.29 dholland 9607: 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 9608: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9609: case of <code class="varname">MASTER_SITE_*</code>,
9610: <em class="replaceable"><code>old_string</code></em> is the empty string and
9611: <em class="replaceable"><code>new_string</code></em> is
9612: <code class="literal">package/</code>. That's where the
9613: <code class="literal">:</code> and the <code class="literal">=</code> fall
9614: together.</p></td>
9615: </tr>
1.41 asau 9616: <tr class="question">
1.1 dsieger 9617: <td align="left" valign="top">
1.77 ! wiz 9618: <a name="devfaq.mailinglists"></a><a name="idm72650128"></a><p><b>22.7.</b></p>
1.1 dsieger 9619: </td>
9620: <td align="left" valign="top"><p>Which mailing lists are there for package
9621: developers?</p></td>
9622: </tr>
9623: <tr class="answer">
9624: <td align="left" valign="top"></td>
1.41 asau 9625: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9626: <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 9627: <dd><p>This is a list for technical discussions related
9628: to pkgsrc development, e.g. soliciting feedback for changes to
9629: pkgsrc infrastructure, proposed new features, questions related
9630: to porting pkgsrc to a new platform, advice for maintaining a
9631: package, patches that affect many packages, help requests moved
9632: from pkgsrc-users when an infrastructure bug is found,
9633: etc.</p></dd>
1.10 hubertf 9634: <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 9635: <dd><p>All bug reports in category "pkg" sent with
1.29 dholland 9636: <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 9637: directly; use one of the other mailing
9638: lists.</p></dd>
9639: </dl></div></td>
9640: </tr>
1.41 asau 9641: <tr class="question">
1.1 dsieger 9642: <td align="left" valign="top">
1.77 ! wiz 9643: <a name="devfaq.documentation"></a><a name="idm72646288"></a><p><b>22.8.</b></p>
1.1 dsieger 9644: </td>
9645: <td align="left" valign="top"><p>Where is the pkgsrc
9646: documentation?</p></td>
9647: </tr>
9648: <tr class="answer">
9649: <td align="left" valign="top"></td>
9650: <td align="left" valign="top">
9651: <p>There are many places where you can find
9652: documentation about pkgsrc:</p>
1.41 asau 9653: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9654: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9655: of chapters that explain large parts of pkgsrc, but some
9656: chapters tend to be outdated. Which ones they are is hard to
9657: say.</p></li>
1.23 wiz 9658: <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 9659: about certain features, announcements of new parts of the pkgsrc
9660: infrastructure and sometimes even announcements that a certain
9661: feature has been marked as obsolete. The benefit here is that
9662: each message has a date appended to it.</p></li>
1.23 wiz 9663: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9664: <code class="filename">mk/</code> directory start with a comment that
9665: describes the purpose of the file and how it can be used by the
9666: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9667: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9668: help</strong></span>.</p></li>
1.23 wiz 9669: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9670: information, but they tend to be highly abbreviated, especially
9671: for actions that occur often. Some contain a detailed
9672: description of what has changed, but they are geared towards the
9673: other pkgsrc developers, not towards an average pkgsrc user.
9674: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9675: don't know what has been before, these messages may not be worth
9676: too much to you.</p></li>
1.23 wiz 9677: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9678: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9679: mind of the developer who wrote the code. To get this
1.10 hubertf 9680: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9681: to see who has written it and ask on the
9682: <code class="literal">tech-pkg</code> mailing list, so that others can
9683: find your questions later (see above). To be sure that the
9684: developer in charge reads the mail, you may CC him or
9685: her.</p></li>
9686: </ul></div>
9687: </td>
9688: </tr>
1.41 asau 9689: <tr class="question">
1.1 dsieger 9690: <td align="left" valign="top">
1.77 ! wiz 9691: <a name="devfaq.too-much-time"></a><a name="idm72639760"></a><p><b>22.9.</b></p>
1.1 dsieger 9692: </td>
9693: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9694: do?</p></td>
9695: </tr>
9696: <tr class="answer">
9697: <td align="left" valign="top"></td>
9698: <td align="left" valign="top">
9699: <p>This is not really an FAQ yet, but here's the answer
9700: anyway.</p>
1.41 asau 9701: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9702: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1 dsieger 9703: <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
9704: will tell you about newer versions of installed packages that are
9705: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9706: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9707: — it contains a list of suggested new packages and a list of
1.1 dsieger 9708: cleanups and enhancements for pkgsrc that would be nice to
9709: have.</p></li>
1.23 wiz 9710: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9711: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9712: mailing list.</p></li>
9713: </ul></div>
9714: </td>
9715: </tr>
9716: </tbody>
9717: </table>
9718: </div>
9719: </div>
1.41 asau 9720: <div class="chapter">
1.1 dsieger 9721: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9722: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9723: <div class="toc">
9724: <p><b>Table of Contents</b></p>
9725: <dl>
1.6 rillig 9726: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9727: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9728: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9729: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9730: </dl>
9731: </div>
1.10 hubertf 9732: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9733: site</a>:</p>
9734: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9735: environment, an intuitive and attractive desktop for users, and the
9736: GNOME development platform, an extensive framework for building
9737: applications that integrate into the rest of the desktop.</p></blockquote></div>
9738: <p>pkgsrc provides a seamless way to automatically build and install
9739: a complete GNOME environment <span class="emphasis"><em>under many different
9740: platforms</em></span>. We can say with confidence that pkgsrc is one of
9741: the most advanced build and packaging systems for GNOME due to its
9742: included technologies buildlink3, the wrappers and tools framework and
9743: automatic configuration file management. Lots of efforts are put into
9744: achieving a completely clean deinstallation of installed software
9745: components.</p>
1.10 hubertf 9746: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9747: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9748: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9749: pkgsrc as its preferred packaging system, contributing lots of
9750: portability fixes to make GNOME build and install under it.</p>
9751: <p>This chapter is aimed at pkgsrc developers and other people
9752: interested in helping our GNOME porting and packaging efforts. It
9753: provides instructions on how to manage the existing packages and some
9754: important information regarding their internals.</p>
1.41 asau 9755: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9756: <h3 class="title">We need your help!</h3>
9757: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9758: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9759: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9760: work</a> list! There is still a long way to go to get a
9761: fully-functional GNOME desktop under NetBSD and we need your help to
9762: achieve it!</p>
9763: </div>
1.41 asau 9764: <div class="sect1">
1.1 dsieger 9765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9766: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9767: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9769: <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 9770: the core GNOME desktop environment. It only includes the necessary
9771: bits to get it to boot correctly, although it may lack important
9772: functionality for daily operation. The idea behind this package is
9773: to let end users build their own configurations on top of this one,
9774: first installing this meta package to achieve a functional setup and
9775: then adding individual applications.</p></li>
1.23 wiz 9776: <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 9777: complete installation of the GNOME platform and desktop as defined
9778: by the GNOME project; this is based on the components distributed in
9779: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9780: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9781: official FTP server. Developer-only tools found in those
9782: directories are not installed unless required by some other
9783: component to work properly. Similarly, packages from the bindings
9784: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9785: in unless required as a dependency for an end-user component. This
9786: 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 9787: <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 9788: Installs all the tools required to build a GNOME component when
9789: fetched from the CVS repository. These are required to let the
1.10 hubertf 9790: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9791: </ul></div>
9792: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9793: sorted in a way that eases updates: a package may depend on other
9794: packages listed before it but not on any listed after it. It is very
9795: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9796: change it to alphabetical sorting!</em></span></p>
9797: </div>
1.41 asau 9798: <div class="sect1">
1.1 dsieger 9799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9800: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9801: <p>Almost all GNOME applications are written in C and use a common
9802: set of tools as their build system. Things get different with the new
9803: bindings to other languages (such as Python), but the following will
9804: give you a general idea on the minimum required tools:</p>
1.41 asau 9805: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9806: <li class="listitem">
1.1 dsieger 9807: <p>Almost all GNOME applications use the GNU Autotools as their
9808: build system. As a general rule you will need to tell this to your
9809: package:</p>
9810: <pre class="programlisting">
9811: GNU_CONFIGURE=yes
9812: USE_LIBTOOL=yes
9813: USE_TOOLS+=gmake
9814: </pre>
9815: </li>
1.23 wiz 9816: <li class="listitem">
1.1 dsieger 9817: <p>If the package uses pkg-config to detect dependencies, add this
9818: tool to the list of required utilities:</p>
9819: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9820: <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
9821: the end of the build process to ensure that you did not miss to
9822: specify any dependency in your package and that the version
9823: requirements are all correct.</p>
9824: </li>
1.23 wiz 9825: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9826: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9827: to handle dependencies and to force the package to use the latest
9828: available version.</p></li>
1.23 wiz 9829: <li class="listitem">
1.1 dsieger 9830: <p>If the package uses gtk-doc (a documentation generation
9831: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9832: tool is rather big and the distfile should come with pregenerated
9833: documentation anyway; if it does not, it is a bug that you ought to
9834: report. For such packages you should disable gtk-doc (unless it is
9835: the default):</p>
9836: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9837: <p>The default location of installed HTML files
9838: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9839: and should not be changed unless the package insists on installing
9840: them somewhere else. Otherwise programs as
1.10 hubertf 9841: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9842: do that with an entry similar to:</p>
9843: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9844: </li>
9845: </ul></div>
9846: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9847: files under the installation prefix to maintain databases. In this
9848: context, shared means that those exact same directories and files are
9849: used among several different packages, leading to conflicts in the
9850: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9851: handle the most common cases, so you have to forget about using
9852: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9853: omitting shared files from them. If you find yourself doing those,
9854: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9855: <p>The following table lists the common situations that result in
9856: using shared directories or files. For each of them, the appropriate
9857: solution is given. After applying the solution be sure to
9858: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9859: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9860: <div class="table">
1.6 rillig 9861: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 9862: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
9863: <colgroup>
9864: <col>
9865: <col>
9866: </colgroup>
9867: <thead><tr>
9868: <th>If the package...</th>
9869: <th>Then...</th>
9870: </tr></thead>
9871: <tbody>
9872: <tr>
9873: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 9874: <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 9875: </tr>
9876: <tr>
9877: <td>Installs icons under the
9878: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9879: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9880: <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 9881: </tr>
9882: <tr>
9883: <td>Installs files under
9884: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9885: <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 9886: </tr>
9887: <tr>
9888: <td>Installs <code class="filename">.desktop</code> files under
9889: <code class="filename">share/applications</code> and these include MIME
9890: information.</td>
1.10 hubertf 9891: <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 9892: </tr>
9893: </tbody>
9894: </table></div>
9895: </div>
9896: <br class="table-break">
9897: </div>
1.41 asau 9898: <div class="sect1">
1.1 dsieger 9899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9900: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9901: <p>When seeing GNOME as a whole, there are two kinds of
9902: updates:</p>
1.41 asau 9903: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9904: <dt><span class="term">Major update</span></dt>
9905: <dd>
9906: <p>Given that there is still a very long way for GNOME 3 (if it
9907: ever appears), we consider a major update one that goes from a
9908: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9909: where <code class="literal">Y</code> is even and greater than
9910: <code class="literal">X</code>. These are hard to achieve because they
9911: introduce lots of changes in the components' code and almost all
9912: GNOME distfiles are updated to newer versions. Some of them can
9913: even break API and ABI compatibility with the previous major
9914: version series. As a result, the update needs to be done all at
9915: once to minimize breakage.</p>
9916: <p>A major update typically consists of around 80 package
9917: updates and the addition of some new ones.</p>
9918: </dd>
9919: <dt><span class="term">Minor update</span></dt>
9920: <dd>
9921: <p>We consider a minor update one that goes from a
9922: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9923: one where <code class="literal">Y</code> is greater than
9924: <code class="literal">X</code>. These are easy to achieve because they do
9925: not update all GNOME components, can be done in an incremental way
9926: and do not break API nor ABI compatibility.</p>
9927: <p>A minor update typically consists of around 50 package
9928: updates, although the numbers here may vary a lot.</p>
9929: </dd>
9930: </dl></div>
9931: <p>In order to update the GNOME components in pkgsrc to a new stable
9932: release (either major or minor), the following steps should be
9933: followed:</p>
1.23 wiz 9934: <div class="orderedlist"><ol class="orderedlist" type="1">
9935: <li class="listitem">
1.1 dsieger 9936: <p>Get a list of all the tarballs that form the new release by
9937: using the following commands. These will leave the full list of the
1.18 snj 9938: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9939: file:</p>
9940: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9941: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9942: awk '{ print $9 }' >list.txt</code></strong>
9943: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9944: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9945: awk '{ print $9 }' >>list.txt</code></strong></pre>
9946: </li>
1.23 wiz 9947: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9948: bump their version to the release you are updating them to. The
9949: three meta packages should be always consistent with versioning.
9950: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9951: in them.</p></li>
1.23 wiz 9952: <li class="listitem">
1.1 dsieger 9953: <p>For each meta package, update all its
9954: <code class="varname">DEPENDS</code> lines to match the latest versions as
9955: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9956: newer version (even if found in the FTP) because the meta packages
9957: are supposed to list the exact versions that form a specific GNOME
9958: release. Exceptions are permitted here if a newer version solves a
9959: serious issue in the overall desktop experience; these typically
9960: come in the form of a revision bump in pkgsrc, not in newer versions
9961: from the developers.</p>
9962: <p>Packages not listed in the <code class="filename">list.txt</code> file
9963: should be updated to the latest version available (if found in
9964: pkgsrc). This is the case, for example, of the dependencies on the
9965: 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>
9966: </li>
1.23 wiz 9967: <li class="listitem">
1.1 dsieger 9968: <p>Generate a patch from the modified meta packages and extract the
9969: list of "new" lines. This will provide you an outline on what
9970: packages need to be updated in pkgsrc and in what order:</p>
9971: <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>
9972: </li>
1.23 wiz 9973: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9974: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9975: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9976: of <code class="filename">todo.txt</code> and update the packages listed in
9977: it in order. For major desktop updates none of these should be
9978: committed until the entire set is completed because there are chances
9979: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9980: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9981: the tree one by one with appropriate log messages. At the end,
9982: commit the three meta package updates and all the corresponding
9983: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9984: <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>
9985: </ol></div>
9986: </div>
1.41 asau 9987: <div class="sect1">
1.1 dsieger 9988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9989: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9990: <p>GNOME is a very big component in pkgsrc which approaches 100
9991: packages. Please, it is very important that you always, always,
9992: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9993: 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 9994: their attention on portability issues and to ensure that future versions
9995: can be built out-of-the box on NetBSD. The less custom patches in
9996: pkgsrc, the easier further updates are. Those developers in charge of
9997: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9998: <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 9999: Bugzilla</a>. Not all components use these to track bugs, but most
10000: of them do. Do not be short on your reports: always provide detailed
10001: explanations of the current failure, how it can be improved to achieve
10002: maximum portability and, if at all possible, provide a patch against CVS
10003: head. The more verbose you are, the higher chances of your patch being
10004: accepted.</p>
10005: <p>Also, please avoid using preprocessor magic to fix portability
10006: issues. While the FreeBSD GNOME people are doing a great job in porting
10007: GNOME to their operating system, the official GNOME sources are now
10008: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10009: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 10010: 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 10011: details.</p>
10012: </div>
10013: </div>
10014: </div>
1.41 asau 10015: <div class="part">
1.1 dsieger 10016: <div class="titlepage"><div><div><h1 class="title">
10017: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10018: <div class="partintro">
1.1 dsieger 10019: <div></div>
10020: <p>This part of the guide deals with everything
10021: from the infrastructure that is behind the interfaces described
10022: in the developer's guide. A casual package maintainer should not
10023: need anything from this part.</p>
10024: <div class="toc">
10025: <p><b>Table of Contents</b></p>
10026: <dl>
1.6 rillig 10027: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10028: <dd><dl>
1.6 rillig 10029: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10030: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10031: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10032: <dd><dl>
1.6 rillig 10033: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10034: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10035: </dl></dd>
1.6 rillig 10036: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10037: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10038: <dd><dl>
1.6 rillig 10039: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10040: <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 10041: </dl></dd>
1.6 rillig 10042: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10043: <dd><dl>
1.23 wiz 10044: <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>
10045: <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 10046: </dl></dd>
10047: </dl></dd>
1.6 rillig 10048: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10049: <dd><dl>
1.6 rillig 10050: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10051: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10052: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10053: <dd><dl>
1.6 rillig 10054: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10055: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10056: </dl></dd>
10057: </dl></dd>
1.6 rillig 10058: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10059: <dd><dl>
1.6 rillig 10060: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10061: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10062: </dl></dd>
10063: </dl>
10064: </div>
10065: </div>
1.41 asau 10066: <div class="chapter">
1.1 dsieger 10067: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10068: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10069: <div class="toc">
10070: <p><b>Table of Contents</b></p>
10071: <dl>
1.6 rillig 10072: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10073: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10074: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10075: <dd><dl>
1.6 rillig 10076: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10077: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10078: </dl></dd>
1.6 rillig 10079: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10080: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10081: <dd><dl>
1.6 rillig 10082: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10083: <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 10084: </dl></dd>
1.6 rillig 10085: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10086: <dd><dl>
1.23 wiz 10087: <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>
10088: <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 10089: </dl></dd>
10090: </dl>
10091: </div>
10092: <p>The pkgsrc infrastructure consists of many small Makefile
10093: fragments. Each such fragment needs a properly specified
10094: interface. This chapter explains how such an interface looks
10095: like.</p>
1.41 asau 10096: <div class="sect1">
1.1 dsieger 10097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10098: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10099: <p>Whenever a variable is defined in the pkgsrc
10100: infrastructure, the location and the way of definition provide
10101: much information about the intended use of that variable.
10102: Additionally, more documentation may be found in a header
10103: comment or in this pkgsrc guide.</p>
10104: <p>A special file is
10105: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10106: variables that are intended to be user-defined. They are either
10107: defined using the <code class="literal">?=</code> operator or they are
10108: left undefined because defining them to anything would
1.23 wiz 10109: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10110: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10111: file.</p>
10112: <p>Outside this file, the following conventions apply:
10113: Variables that are defined using the <code class="literal">?=</code>
10114: operator may be overridden by a package.</p>
10115: <p>Variables that are defined using the <code class="literal">=</code>
10116: operator may be used read-only at run-time.</p>
10117: <p>Variables whose name starts with an underscore must not be
10118: accessed outside the pkgsrc infrastructure at all. They may
10119: change without further notice.</p>
1.41 asau 10120: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10121: <h3 class="title">Note</h3>
10122: <p>These conventions are currently not applied
10123: consistently to the complete pkgsrc
10124: infrastructure.</p>
10125: </div>
10126: </div>
1.41 asau 10127: <div class="sect1">
1.1 dsieger 10128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10129: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10130: <p>All variables that contain lists of things should default
10131: to being empty. Two examples that do not follow this rule are
10132: <code class="varname">USE_LANGUAGES</code> and
10133: <code class="varname">DISTFILES</code>. These variables cannot simply be
10134: modified using the <code class="literal">+=</code> operator in package
10135: <code class="filename">Makefile</code>s (or other files included by
10136: them), since there is no guarantee whether the variable is
10137: already set or not, and what its value is. In the case of
1.23 wiz 10138: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10139: the default value and just define it as in the following
10140: example.</p>
10141: <pre class="programlisting">
10142: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10143: </pre>
10144: <p>Because of the selection of this default value, the same
10145: value appears in many package Makefiles. Similarly for
10146: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10147: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10148: doesn't stand out. Nevertheless it is mentioned in many
10149: files.</p>
10150: </div>
1.41 asau 10151: <div class="sect1">
1.1 dsieger 10152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10153: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 10154: <div class="sect2">
1.1 dsieger 10155: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10156: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10157: <p>Variable evaluation takes place either at load time or at
10158: runtime, depending on the context in which they occur. The
10159: contexts where variables are evaluated at load time are:</p>
1.41 asau 10160: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10161: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10162: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10163: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10164: <code class="literal">.for</code>,</p></li>
1.23 wiz 10165: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10166: </ul></div>
10167: <p>A special exception are references to the iteration
10168: variables of <code class="literal">.for</code> loops, which are expanded
10169: inline, no matter in which context they appear.</p>
10170: <p>As the values of variables may change during load time,
10171: care must be taken not to evaluate them by accident. Typical
10172: examples for variables that should not be evaluated at load time
10173: are <code class="varname">DEPENDS</code> and
10174: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10175: clear, here is an example:</p>
10176: <pre class="programlisting">
10177: CONFIGURE_ARGS= # none
10178: CFLAGS= -O
10179: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10180:
10181: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10182:
10183: CFLAGS+= -Wall
10184: </pre>
10185: <p>This code shows how the use of the <code class="literal">:=</code>
10186: operator can quickly lead to unexpected results. The first
10187: paragraph is fairly common code. The second paragraph evaluates
10188: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10189: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10190: <code class="literal">-Wall</code> is appended to the
10191: <code class="varname">CFLAGS</code>, but this addition will not appear in
10192: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10193: paragraphs from above typically occur in completely unrelated
10194: files.</p>
10195: </div>
1.41 asau 10196: <div class="sect2">
1.1 dsieger 10197: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10198: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10199: <p>After all the files have been loaded, the values of the
10200: variables cannot be changed anymore. Variables that are used in
10201: the shell commands are expanded at this point.</p>
10202: </div>
10203: </div>
1.41 asau 10204: <div class="sect1">
1.1 dsieger 10205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10206: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10207: <p>There are many ways in which the definition and use of a
10208: variable can be restricted in order to detect bugs and
10209: violations of the (mostly unwritten) policies. See the
10210: <code class="literal">pkglint</code> developer's documentation for further
10211: details.</p>
10212: </div>
1.41 asau 10213: <div class="sect1">
1.1 dsieger 10214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10215: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10216: <p>Most of the <code class="filename">.mk</code> files fall into one
10217: of the following classes. Cases where a file falls into more
10218: than one class should be avoided as it often leads to subtle
10219: bugs.</p>
1.41 asau 10220: <div class="sect2">
1.1 dsieger 10221: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10222: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10223: <p>In a traditional imperative programming language some of
10224: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10225: procedures. They take some input parameters and—after
10226: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10227: variables in <code class="filename">Makefile</code>s have global scope
10228: care must be taken not to use parameter names that have already
10229: another meaning. For example, <code class="varname">PKGNAME</code> is a
10230: bad choice for a parameter name.</p>
10231: <p>Procedures are completely evaluated at preprocessing time.
10232: That is, when calling a procedure all input parameters must be
10233: completely resolvable. For example,
10234: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10235: parameter since it is very likely that further text will be
10236: added after calling the procedure, which would effectively apply
10237: the procedure to only a part of the variable. Also, references
10238: to other variables wit will be modified after calling the
10239: procedure.</p>
10240: <p>A procedure can declare its output parameters either as
10241: suitable for use in preprocessing directives or as only
10242: available at runtime. The latter alternative is for variables
10243: that contain references to other runtime variables.</p>
10244: <p>Procedures shall be written such that it is possible to
10245: call the procedure more than once. That is, the file must not
10246: contain multiple-inclusion guards.</p>
10247: <p>Examples for procedures are
10248: <code class="filename">mk/bsd.options.mk</code> and
10249: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10250: that the parameters are evaluated at load time, they should be
10251: assigned using the <code class="literal">:=</code> operator, which should
10252: be used only for this purpose.</p>
10253: </div>
1.41 asau 10254: <div class="sect2">
1.1 dsieger 10255: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10256: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10257: <p>Action files take some input parameters and may define
10258: runtime variables. They shall not define loadtime variables.
10259: There are action files that are included implicitly by the
10260: pkgsrc infrastructure, while other must be included
10261: explicitly.</p>
10262: <p>An example for action files is
10263: <code class="filename">mk/subst.mk</code>.</p>
10264: </div>
10265: </div>
1.41 asau 10266: <div class="sect1">
1.1 dsieger 10267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10268: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10269: <p>Package <code class="filename">Makefile</code>s usually consist of
10270: a set of variable definitions, and include the file
10271: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10272: Before that, they may also include various other
10273: <code class="filename">*.mk</code> files if they need to query the
10274: availability of certain features like the type of compiler or
10275: the X11 implementation. Due to the heavy use of preprocessor
10276: directives like <code class="literal">.if</code> and
10277: <code class="literal">.for</code>, the order in which the files are loaded
10278: matters.</p>
10279: <p>This section describes at which point the various files
10280: are loaded and gives reasons for that order.</p>
1.41 asau 10281: <div class="sect2">
1.1 dsieger 10282: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10283: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10284: </h3></div></div></div>
10285: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10286: is to define some essential variables like
10287: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10288: <code class="varname">MACHINE_ARCH</code>.</p>
10289: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10290: 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 10291: After that, those variables
1.1 dsieger 10292: that have not been overridden by the user are loaded from
10293: <code class="filename">mk/defaults/mk.conf</code>.</p>
10294: <p>After the user settings, the system settings and platform
10295: settings are loaded, which may override the user
10296: settings.</p>
10297: <p>Then, the tool definitions are loaded. The tool wrappers
10298: are not yet in effect. This only happens when building a
10299: package, so the proper variables must be used instead of the
10300: direct tool names.</p>
10301: <p>As the last steps, some essential variables from the
10302: wrapper and the package system flavor are loaded, as well as the
10303: variables that have been cached in earlier phases of a package
10304: build.</p>
10305: </div>
1.41 asau 10306: <div class="sect2">
1.1 dsieger 10307: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10308: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10309: </h3></div></div></div>
10310: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10311: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10312: loaded, which fill default values for those variables that have
10313: not been defined by the package. These variables may later
10314: be used even in unrelated files.</p>
10315: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10316: provides the target <code class="literal">error-check</code> that is added
10317: as a special dependency to all other targets that use
10318: <code class="varname">DELAYED_ERROR_MSG</code> or
10319: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10320: <p>Then, the package-specific hacks from
10321: <code class="filename">hacks.mk</code> are included.</p>
10322: <p>Then, various other files follow. Most of them don't have
10323: any dependencies on what they need to have included before or
10324: after them, though some do.</p>
10325: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10326: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10327: restricts the use of these variables to all the files that have
10328: been included before. Appearances in later files will be
10329: silently ignored.</p>
10330: <p>Then, the files for the main targets are included, in the
10331: order of later execution, though the actual order should not
10332: matter.</p>
10333: <p>At last, some more files are included that don't set any
10334: interesting variables but rather just define make targets to be
10335: executed.</p>
10336: </div>
10337: </div>
10338: </div>
1.41 asau 10339: <div class="chapter">
1.1 dsieger 10340: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10341: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10342: <div class="toc">
10343: <p><b>Table of Contents</b></p>
10344: <dl>
1.6 rillig 10345: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10346: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10347: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10348: <dd><dl>
1.6 rillig 10349: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10350: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10351: </dl></dd>
10352: </dl>
10353: </div>
10354: <p>The pkgsrc infrastructure consists of a large codebase,
10355: and there are many corners where every little bit of a file is
10356: well thought out, making pkgsrc likely to fail as soon as
10357: anything is changed near those parts. To prevent most changes
10358: from breaking anything, a suite of regression tests should go
10359: along with every important part of the pkgsrc infrastructure.
10360: This chapter describes how regression tests work in pkgsrc and
10361: how you can add new tests.</p>
1.41 asau 10362: <div class="sect1">
1.1 dsieger 10363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10364: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10365: <p></p>
10366: </div>
1.41 asau 10367: <div class="sect1">
1.1 dsieger 10368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10369: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1 dsieger 10370: <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 10371: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10372: can simply run that command, which will run all tests in the
10373: <code class="filename">regress</code> category.</p>
10374: </div>
1.41 asau 10375: <div class="sect1">
1.1 dsieger 10376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10377: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10378: <p>Every directory in the <code class="filename">regress</code>
10379: category that contains a file called <code class="filename">spec</code>
10380: is considered a regression test. This file is a shell program
1.10 hubertf 10381: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10382: The following functions can be overridden to suit your
10383: needs.</p>
1.41 asau 10384: <div class="sect2">
1.1 dsieger 10385: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10386: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10387: <p>These functions do not take any parameters. They are all
1.23 wiz 10388: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.1 dsieger 10389: to check the exitcodes of any commands you run in the
10390: test.</p>
1.41 asau 10391: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10392: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10393: <dd><p>This function prepares the environment for the
10394: test. By default it does nothing.</p></dd>
10395: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10396: <dd><p>This function runs the actual test. By default,
10397: it calls <code class="varname">TEST_MAKE</code> with the arguments
10398: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10399: error messages into the file
10400: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10401: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10402: <dd><p>This function is run after the test and is
10403: typically used to compare the actual output from the one that is
10404: expected. It can make use of the various helper functions from
10405: the next section.</p></dd>
10406: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10407: <dd><p>This function cleans everything up after the
10408: test has been run. By default it does nothing.</p></dd>
10409: </dl></div>
10410: </div>
1.41 asau 10411: <div class="sect2">
1.1 dsieger 10412: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10413: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.41 asau 10414: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10415: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10416: <dd><p>This function compares the exitcode of the
1.10 hubertf 10417: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1 dsieger 10418: If they differ, the test will fail.</p></dd>
10419: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10420: <dd><p>This function checks for each of its parameters
1.10 hubertf 10421: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1 dsieger 10422: extended regular expression. If it does not, the test will
10423: fail.</p></dd>
10424: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10425: <dd><p>This function checks for each of its parameters
1.10 hubertf 10426: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10427: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10428: If any of the regular expressions matches, the test will
10429: fail.</p></dd>
10430: </dl></div>
10431: </div>
10432: </div>
10433: </div>
1.41 asau 10434: <div class="chapter">
1.1 dsieger 10435: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10436: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10437: <div class="toc">
10438: <p><b>Table of Contents</b></p>
10439: <dl>
1.6 rillig 10440: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10441: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10442: </dl>
10443: </div>
10444: <p>The pkgsrc system has already been ported to many
10445: operating systems, hardware architectures and compilers. This
10446: chapter explains the necessary steps to make pkgsrc even more
10447: portable.</p>
1.41 asau 10448: <div class="sect1">
1.1 dsieger 10449: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10450: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10451: <p>To port pkgsrc to a new operating system (called
10452: <code class="literal">MyOS</code> in this example), you need to touch the
10453: following files:</p>
1.41 asau 10454: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10455: <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>
10456: <dd><p>This file contains some basic definitions, for
10457: example the name of the C
10458: compiler.</p></dd>
10459: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10460: <dd><p>Insert code that defines the variables
10461: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10462: <code class="varname">LOWER_OS_VERSION</code>,
10463: <code class="varname">LOWER_VENDOR</code>,
10464: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10465: <code class="varname">APPEND_ELF</code>, and the other variables that
10466: appear in this file.</p></dd>
10467: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10468: <dd><p>This file contains the platform-specific
10469: definitions that are used by pkgsrc. Start by copying one of the
10470: other files and edit it to your
10471: needs.</p></dd>
10472: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10473: <dd><p>This file defines the paths to all the tools
10474: that are needed by one or the other package in pkgsrc, as well
10475: as by pkgsrc itself. Find out where these tools are on your
10476: platform and add them.</p></dd>
10477: </dl></div>
10478: <p>Now, you should be able to build some basic packages, like
10479: <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>
10480: </div>
1.41 asau 10481: <div class="sect1">
1.1 dsieger 10482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10483: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10484: <p>TODO</p>
10485: </div>
10486: </div>
10487: </div>
1.41 asau 10488: <div class="appendix">
10489: <div class="titlepage"><div><div><h1 class="title">
10490: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10491: <div class="toc">
10492: <p><b>Table of Contents</b></p>
10493: <dl>
10494: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10495: <dd><dl>
10496: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10497: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10498: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10499: <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 10500: </dl></dd>
10501: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10502: </dl>
10503: </div>
10504: <p>We checked to find a piece of software that wasn't in the packages
10505: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10506: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10507: present in the tree is beyond us, but it's useful for the purposes of
10508: this exercise.</p>
1.41 asau 10509: <div class="sect1">
1.1 dsieger 10510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10511: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10512: <div class="sect2">
1.1 dsieger 10513: <div class="titlepage"><div><div><h3 class="title">
10514: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10515: <pre class="programlisting">
10516: # $NetBSD$
10517: #
10518:
10519: DISTNAME= bison-1.25
10520: CATEGORIES= devel
10521: MASTER_SITES= ${MASTER_SITE_GNU}
10522:
1.29 dholland 10523: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10524: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10525: COMMENT= GNU yacc clone
10526:
10527: GNU_CONFIGURE= yes
1.46 wiz 10528: INFO_FILES= yes
1.1 dsieger 10529:
10530: .include "../../mk/bsd.pkg.mk"
10531: </pre>
10532: </div>
1.41 asau 10533: <div class="sect2">
1.1 dsieger 10534: <div class="titlepage"><div><div><h3 class="title">
10535: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10536: <pre class="programlisting">
10537: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.29 dholland 10538: 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 10539: of the NetBSD source tree is beyond me.
10540: </pre>
10541: </div>
1.41 asau 10542: <div class="sect2">
1.1 dsieger 10543: <div class="titlepage"><div><div><h3 class="title">
10544: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10545: <pre class="programlisting">
10546: @comment $NetBSD$
10547: bin/bison
10548: man/man1/bison.1.gz
10549: share/bison.simple
10550: share/bison.hairy
10551: </pre>
10552: </div>
1.41 asau 10553: <div class="sect2">
1.1 dsieger 10554: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10555: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10556: </h3></div></div></div>
10557: <p>The NetBSD package system comes with
10558: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10559: which helps to check the contents of these
10560: files. After installation it is quite easy to use, just change to the
10561: directory of the package you wish to examine and execute
1.10 hubertf 10562: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10563: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10564: looks fine.</pre>
10565: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10566: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10567: -Wall</strong></span> for a very thorough check.</p>
10568: </div>
10569: </div>
1.41 asau 10570: <div class="sect1">
1.1 dsieger 10571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10572: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10573: <p>Create the directory where the package lives,
10574: plus any auxiliary directories:</p>
10575: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10576: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10577: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10578: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10579: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 10580: <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 10581: then continue with fetching the distfile:</p>
10582: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10583: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10584: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10585: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10586: ftp: Error retrieving file: 500 Internal error
10587:
10588: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10589: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10590: ftp: Error retrieving file: 500 Internal error
10591:
10592: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10593: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10594: Successfully retrieved file.</pre>
10595: <p>Generate the checksum of the distfile into
10596: <code class="filename">distinfo</code>:</p>
10597: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10598: <p>Now compile:</p>
10599: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10600: >> Checksum OK for bison-1.25.tar.gz.
10601: ===> Extracting for bison-1.25
10602: ===> Patching for bison-1.25
10603: ===> Ignoring empty patch directory
10604: ===> Configuring for bison-1.25
10605: creating cache ./config.cache
10606: checking for gcc... cc
10607: checking whether we are using GNU C... yes
10608: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10609: checking how to run the C preprocessor... cc -E
10610: checking for minix/config.h... no
10611: checking for POSIXized ISC... no
10612: checking whether cross-compiling... no
10613: checking for ANSI C header files... yes
10614: checking for string.h... yes
10615: checking for stdlib.h... yes
10616: checking for memory.h... yes
10617: checking for working const... yes
10618: checking for working alloca.h... no
10619: checking for alloca... yes
10620: checking for strerror... yes
10621: updating cache ./config.cache
10622: creating ./config.status
10623: creating Makefile
10624: ===> Building for bison-1.25
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 LR0.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 allocate.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 closure.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 conflicts.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 derives.c
10630: 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
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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.c
10640: 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
10641: 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
10642: 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
10643: 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
10644: 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
10645: 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
10646: 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
10647: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10648: rm -f bison.s1
10649: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10650: <p>Everything seems OK, so install the files:</p>
10651: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10652: >> Checksum OK for bison-1.25.tar.gz.
10653: ===> Installing for bison-1.25
10654: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10655: rm -f /usr/pkg/bin/bison
10656: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10657: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10658: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10659: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10660: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10661: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10662: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10663: ===> Registering installation for bison-1.25</pre>
10664: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10665: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10666: binary package, do this now:</p>
10667: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10668: >> Checksum OK for bison-1.25.tar.gz.
10669: ===> Building package for bison-1.25
10670: Creating package bison-1.25.tgz
10671: Registering depends:.
10672: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10673: <p>Now that you don't need the source and object files
10674: any more, clean up:</p>
10675: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10676: ===> Cleaning for bison-1.25</pre>
10677: </div>
10678: </div>
1.41 asau 10679: <div class="appendix">
10680: <div class="titlepage"><div><div><h1 class="title">
10681: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10682: <div class="toc">
10683: <p><b>Table of Contents</b></p>
10684: <dl>
10685: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10686: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10687: </dl>
10688: </div>
1.41 asau 10689: <div class="sect1">
1.1 dsieger 10690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10691: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10692: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10693: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10694: => figlet221.tar.gz doesn't seem to exist on this system.
10695: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10696: => [172219 bytes]
10697: Connected to ftp.plig.net.
10698: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10699: 331 Guest login ok, send your complete e-mail address as password.
10700: 230-You are user #5 of 500 simultaneous users allowed.
10701: 230-
10702: 230- ___ _ _ _
10703: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10704: 230- | _| _| . |_| . | | | . |_| . | _| . |
10705: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10706: 230- |_| |_| |___| |___|
10707: 230-
10708: 230-** Welcome to ftp.plig.org **
10709: 230-
10710: 230-Please note that all transfers from this FTP site are logged. If you
10711: 230-do not like this, please disconnect now.
10712: 230-
1.18 snj 10713: 230-This archive is available via
1.1 dsieger 10714: 230-
10715: 230-HTTP: http://ftp.plig.org/
10716: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10717: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10718: 230-
10719: 230-Please email comments, bug reports and requests for packages to be
10720: 230-mirrored to ftp-admin@plig.org.
10721: 230-
10722: 230-
10723: 230 Logged in anonymously.
10724: Remote system type is UNIX.
10725: Using binary mode to transfer files.
10726: 200 Type okay.
10727: 250 "/pub" is new cwd.
10728: 250-"/pub/figlet" is new cwd.
10729: 250-
10730: 250-Welcome to the figlet archive at ftp.figlet.org
10731: 250-
10732: 250- ftp://ftp.figlet.org/pub/figlet/
10733: 250-
10734: 250-The official FIGlet web page is:
10735: 250- http://www.figlet.org/
10736: 250-
10737: 250-If you have questions, please mailto:info@figlet.org. If you want to
10738: 250-contribute a font or something else, you can email us.
10739: 250
10740: 250 "/pub/figlet/program" is new cwd.
10741: 250 "/pub/figlet/program/unix" is new cwd.
10742: local: figlet221.tar.gz remote: figlet221.tar.gz
10743: 502 Unimplemented command.
10744: 227 Entering Passive Mode (195,40,6,41,246,104)
10745: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10746: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10747: 226 Transfer completed.
10748: 172219 bytes received in 00:02 (75.99 KB/s)
10749: 221 Goodbye.
10750: => Checksum OK for figlet221.tar.gz.
10751: ===> Extracting for figlet-2.2.1nb2
10752: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10753: ===> Patching for figlet-2.2.1nb2
10754: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10755: ===> Overriding tools for figlet-2.2.1nb2
10756: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10757: ===> Configuring for figlet-2.2.1nb2
10758: ===> Building for figlet-2.2.1nb2
10759: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10760: chmod a+x figlet
10761: gcc -O2 -o chkfont chkfont.c
10762: => Unwrapping files-to-be-installed.
10763: <code class="prompt">#</code>
10764: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10765: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10766: ===> Installing for figlet-2.2.1nb2
10767: install -d -o root -g wheel -m 755 /usr/pkg/bin
10768: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10769: mkdir -p /usr/pkg/share/figlet
10770: cp figlet /usr/pkg/bin
10771: cp chkfont /usr/pkg/bin
10772: chmod 555 figlist showfigfonts
10773: cp figlist /usr/pkg/bin
10774: cp showfigfonts /usr/pkg/bin
10775: cp fonts/*.flf /usr/pkg/share/figlet
10776: cp fonts/*.flc /usr/pkg/share/figlet
10777: cp figlet.6 /usr/pkg/man/man6
10778: ===> Registering installation for figlet-2.2.1nb2
10779: <code class="prompt">#</code></pre>
10780: </div>
1.41 asau 10781: <div class="sect1">
1.1 dsieger 10782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10783: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10784: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10785: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10786: ===> Packaging figlet-2.2.1nb2
10787: ===> Building binary package for figlet-2.2.1nb2
10788: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10789: Using SrcDir value of /usr/pkg
10790: Registering depends:.
10791: <code class="prompt">#</code></pre>
10792: </div>
10793: </div>
1.41 asau 10794: <div class="appendix">
10795: <div class="titlepage"><div><div><h1 class="title">
10796: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10797: <div class="toc">
10798: <p><b>Table of Contents</b></p>
10799: <dl>
1.23 wiz 10800: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10801: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10802: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10803: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10804: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10805: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10806: source packages</a></span></dt>
10807: </dl>
10808: </div>
10809: <p>As in other big projects, the directory layout of pkgsrc
10810: is quite complex for newbies. This chapter explains where you
10811: find things on the FTP server. The base directory on
1.10 hubertf 10812: <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 10813: On other servers it may be different, but inside this directory,
10814: everything should look the same, no matter on which server you
10815: are. This directory contains some subdirectories, which are
10816: explained below.</p>
1.41 asau 10817: <div class="sect1">
1.1 dsieger 10818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10819: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10820: <p>The directory <code class="filename">distfiles</code> contains lots
10821: of archive files from all pkgsrc packages, which are mirrored
10822: here. The subdirectories are called after their package names
10823: and are used when the distributed files have names that don't
10824: explicitly contain a version number or are otherwise too generic
10825: (for example <code class="filename">release.tar.gz</code>).</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-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10830: <p>This directory contains things that individual pkgsrc
10831: developers find worth publishing.</p>
10832: </div>
1.41 asau 10833: <div class="sect1">
1.1 dsieger 10834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10835: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10836: <p>This directory contains binary packages for the various
10837: platforms that are supported by pkgsrc.
10838: 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 10839: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10840: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10841: operating system for which the packages have been built. The
1.10 hubertf 10842: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10843: command, so it may differ from the one you are used to
10844: hear.</p></li>
1.23 wiz 10845: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10846: architecture of the platform for which the packages have been
1.10 hubertf 10847: built. It also includes the <code class="varname">ABI</code> (Application
10848: Binary Interface) for platforms that have several of
10849: them.</p></li>
1.23 wiz 10850: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10851: the operating system. For version numbers that change often (for
10852: example NetBSD-current), the often-changing part should be
10853: replaced with an <code class="literal">x</code>, for example
10854: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10855: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10856: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10857: for a stable branch, or <code class="literal">head</code> for packages
10858: built from the HEAD branch. The latter should only be used when
10859: the packages are updated on a regular basis. Otherwise the date
10860: from checking out pkgsrc should be appended, for example
10861: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10862: </ul></div>
10863: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10864: can quickly click through the directories on the
10865: server and find the best binary packages for their machines. Since they
10866: usually know the operating system and the hardware architecture, OPSYS
10867: and ARCH are placed first. After these choices, they can select the
10868: best combination of OSVERSION and TAG together, since it is usually the
10869: case that packages stay compatible between different version of the
10870: operating system.</p>
10871: <p>In each of these directories, there is a
10872: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10873: <code class="filename">All</code> which contains all binary packages.
10874: Besides that, there are various category directories that
10875: contain symbolic links to the real binary packages.</p>
10876: </div>
1.41 asau 10877: <div class="sect1">
1.1 dsieger 10878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10879: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10880: <p>Here are the reports from bulk builds, for those who want
10881: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10882: 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 10883: </div>
1.41 asau 10884: <div class="sect1">
1.8 rillig 10885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10886: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10887: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10888: source packages</h2></div></div></div>
1.23 wiz 10889: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10890: that is the files that define how to create binary packages from
10891: source archives.</p>
10892: <p>The directory <code class="filename">pkgsrc</code> contains a
10893: snapshot of the CVS repository, which is updated regularly. The
10894: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10895: directory, ready to be downloaded as a whole.</p>
10896: <p>In the directories for the quarterly branches, there is an
10897: additional file called
1.22 jakllsch 10898: <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 10899: which contains the state of pkgsrc when it was branched.</p>
10900: </div>
10901: </div>
1.41 asau 10902: <div class="appendix">
10903: <div class="titlepage"><div><div><h1 class="title">
10904: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 10905: <div class="toc">
10906: <p><b>Table of Contents</b></p>
10907: <dl>
10908: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10909: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10910: </dl>
10911: </div>
10912: <p>This section contains information on editing the pkgsrc
10913: guide itself.</p>
1.41 asau 10914: <div class="sect1">
1.1 dsieger 10915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10916: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10917: <p>The pkgsrc guide's source code is stored in
10918: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10919: are created from it:</p>
1.41 asau 10920: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10921: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10922: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10923: <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>
10924: <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 10925: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 10926: <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 10927: PostScript version of the pkgsrc guide.</p></li>
10928: </ul></div>
10929: </div>
1.41 asau 10930: <div class="sect1">
1.1 dsieger 10931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10932: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10933: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 10934: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 10935: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 10936: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 10937: documentation) installed. These are automatically installed when
10938: 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 10939: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10940: right directory. All further steps will take place
10941: here.</p></li>
1.41 asau 10942: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 10943: <code class="filename">files/</code>.</p></li>
1.41 asau 10944: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10945: guide for valid XML and to build the final output files. If you
10946: get any errors at this stage, you can just edit the files, as
10947: there are only symbolic links in the working directory, pointing
10948: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 10949: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10950: commit)</strong></span></p></li>
1.41 asau 10951: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10952: regenerate the output files with the proper RCS
10953: Ids.</p></li>
1.41 asau 10954: <li class="step">
1.10 hubertf 10955: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10956: commit the files in both <code class="filename">pkgsrc/doc</code> and
10957: <code class="filename">htdocs</code>.</p>
1.41 asau 10958: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10959: <h3 class="title">Note</h3>
10960: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10961: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10962: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10963: directory.</p>
10964: </div>
10965: </li>
10966: </ol></div>
10967: </div>
10968: </div>
10969: </div></body>
10970: </html>
CVSweb <webmaster@jp.NetBSD.org>