Annotation of pkgsrc/doc/pkgsrc.html, revision 1.186
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.185 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.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
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>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
1.157 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
1.82 rillig 78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
81: <dd><dl>
1.151 obache 82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166 jnemeth 85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75 rillig 92: </dl></dd>
93: </dl></dd>
94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
97: <dd><dl>
98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
103: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
105: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 106: </dl></dd>
107: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
108: <dd><dl>
109: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
110: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
111: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
112: </dl></dd>
113: </dl></dd>
114: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
115: <dd><dl>
116: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
117: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 118: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 119: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 120: <dd><dl>
1.103 wiz 121: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 wiz 122: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
123: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 124: </dl></dd>
1.103 wiz 125: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
126: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 127: </dl></dd>
128: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
129: <dd><dl>
130: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
131: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 132: </dl></dd>
133: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
134: builds)</a></span></dt>
1.75 rillig 135: <dd><dl>
1.180 wiz 136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
138: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
139: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174 asau 140: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 142: </dl></dd>
143: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
144: <dd><dl>
1.128 wiz 145: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
146: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106 rillig 147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
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.173 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.128 wiz 161: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.173 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.75 rillig 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.106 rillig 173: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 174: <dd><dl>
1.106 rillig 175: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 176: <dd><dl>
1.106 rillig 177: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 178: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 179: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 180: </dl></dd>
1.106 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.128 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.106 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.128 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.106 rillig 205: </dl></dd>
1.128 wiz 206: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 207: <dd><dl>
208: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 209: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 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.128 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.106 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.128 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.106 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.128 wiz 234: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 235: <dd><dl>
236: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 237: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
238: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
239: and
240: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
241: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 242: </dl></dd>
1.128 wiz 243: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106 rillig 244: <dd><dl>
1.128 wiz 245: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 246: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
247: </dl></dd>
248: </dl></dd>
249: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
250: <dd><dl>
251: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
254: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
255: </dl></dd>
256: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
257: <dd><dl>
1.128 wiz 258: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 259: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
260: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
261: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
262: </dl></dd>
263: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
264: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
265: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
266: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
267: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
268: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
269: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
270: </dl></dd>
271: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
272: <dd><dl>
273: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 274: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 275: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 276: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 277: </dl></dd>
278: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
281: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
282: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
283: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 284: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 285: <dd><dl>
286: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
287: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
288: </dl></dd>
1.128 wiz 289: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 299: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
300: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
301: </dl></dd>
302: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
303: <dd><dl>
304: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
305: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
306: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
307: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 315: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
1.128 wiz 326: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
330: </dl></dd>
1.128 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.106 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.147 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.106 rillig 344: </dl></dd>
1.128 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.106 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.128 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.106 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.128 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.106 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.107 rillig 362: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 363: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 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.87 wiz 372: emulation</a></span></dt>
1.106 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.77 rillig 375: </dl></dd>
1.106 rillig 376: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 377: </dl></dd>
1.106 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.77 rillig 380: <dd><dl>
1.106 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.140 wiz 384: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 385: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 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.106 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.85 jmmv 396: </dl></dd>
1.75 rillig 397: </dl></dd>
398: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
399: <dd><dl>
1.106 rillig 400: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 401: <dd><dl>
1.106 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.81 rillig 405: <dd><dl>
1.106 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.81 rillig 408: </dl></dd>
1.106 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.75 rillig 411: <dd><dl>
1.106 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.75 rillig 414: </dl></dd>
1.106 rillig 415: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 416: <dd><dl>
1.128 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.75 rillig 419: </dl></dd>
420: </dl></dd>
1.106 rillig 421: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 422: <dd><dl>
1.106 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.75 rillig 426: <dd><dl>
1.106 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.75 rillig 429: </dl></dd>
430: </dl></dd>
1.106 rillig 431: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 432: <dd><dl>
1.106 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.75 rillig 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.128 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.75 rillig 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>
1.76 rillig 453: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
454: <dd><dl>
1.128 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.76 rillig 461: source packages</a></span></dt>
462: </dl></dd>
1.75 rillig 463: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
464: <dd><dl>
1.79 rillig 465: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 466: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
467: </dl></dd>
468: </dl>
469: </div>
1.82 rillig 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.106 rillig 475: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 476: </dt>
1.106 rillig 477: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 478: </dt>
1.82 rillig 479: </dl>
480: </div>
1.148 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.75 rillig 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>
1.82 rillig 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>
1.75 rillig 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>
1.88 wiz 494: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 495: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
496: </dl>
497: </div>
1.148 asau 498: <div class="sect1">
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 508: <p>pkgsrc currently contains several thousand packages,
509: including:</p>
1.148 asau 510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 512: web server</p></li>
1.128 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.75 rillig 514: web browser</p></li>
1.128 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.75 rillig 516: Desktop Environment</p></li>
1.128 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.75 rillig 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.148 asau 524: <div class="sect2">
1.82 rillig 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.148 asau 530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 531: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 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.128 wiz 537: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 538: including binaries, libraries, man pages and other
539: documentation.</p></li>
1.128 wiz 540: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82 rillig 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.128 wiz 544: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 545: consists of highly portable code. This allows the greatest speed of
1.132 spz 546: development when porting to a new platform. This portability also
1.82 rillig 547: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
548: platforms</em></span>.</p></li>
1.128 wiz 549: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 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.128 wiz 553: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 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>
1.91 rillig 559: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 561: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 562: — That means, if a package contains bugs, it's better to find
1.91 rillig 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.128 wiz 568: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 569: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 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>
1.82 rillig 573: </div>
1.148 asau 574: <div class="sect2">
1.82 rillig 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>
1.75 rillig 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>
1.82 rillig 584: <div class="table">
585: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 586: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 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.110 hubertf 597: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 598: <td align="center">Aug 1997</td>
599: </tr>
600: <tr>
1.110 hubertf 601: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 602: <td align="center">Mar 1999</td>
603: </tr>
604: <tr>
1.110 hubertf 605: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 606: <td align="center">Jun 1999</td>
607: </tr>
608: <tr>
609: <td>
1.110 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.82 rillig 612: </td>
613: <td align="center">Oct 2001</td>
614: </tr>
615: <tr>
1.110 hubertf 616: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 617: <td align="center">Nov 2002</td>
618: </tr>
619: <tr>
1.110 hubertf 620: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 621: <td align="center">Nov 2002</td>
622: </tr>
623: <tr>
1.110 hubertf 624: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 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.110 hubertf 632: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 633: <td align="center">Dec 2003</td>
634: </tr>
635: <tr>
636: <td>
1.110 hubertf 637: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 638: (Microsoft Windows Services for Unix)
639: </td>
640: <td align="center">Mar 2004</td>
641: </tr>
642: <tr>
1.110 hubertf 643: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 644: <td align="center">Oct 2004</td>
645: </tr>
646: <tr>
1.110 hubertf 647: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 648: <td align="center">Nov 2004</td>
649: </tr>
1.98 wiz 650: <tr>
1.110 hubertf 651: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 652: <td align="center">Apr 2007</td>
653: </tr>
1.128 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.151 obache 658: <tr>
659: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 660: <td align="center">Jan 2011</td>
1.151 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.166 jnemeth 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.82 rillig 674: </tbody>
1.91 rillig 675: </table></div>
1.82 rillig 676: </div>
1.91 rillig 677: <br class="table-break">
1.82 rillig 678: </div>
1.75 rillig 679: </div>
1.148 asau 680: <div class="sect1">
1.75 rillig 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.110 hubertf 684: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 685: describes how one can use one of the packages in the Package
686: Collection, either by installing a precompiled binary package,
1.93 rillig 687: or by building one's own copy using the NetBSD package system.
1.110 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.75 rillig 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.110 hubertf 691: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 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.110 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.75 rillig 696: </div>
1.148 asau 697: <div class="sect1">
1.75 rillig 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.128 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.75 rillig 702: terminology used within this document.</p>
1.148 asau 703: <div class="variablelist"><dl class="variablelist">
1.75 rillig 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
1.76 rillig 709: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 710: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 711: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 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>
1.75 rillig 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
1.76 rillig 724: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 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.128 wiz 728: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 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
1.76 rillig 733: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 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
1.76 rillig 737: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 738: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 739: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 740: especially in the context of precompiled packages.</p>
741: </dd>
742: <dt><span class="term">Program</span></dt>
1.88 wiz 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>
1.75 rillig 746: </dl></div>
1.148 asau 747: <div class="sect2">
1.75 rillig 748: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 749: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 750: <div class="variablelist"><dl class="variablelist">
1.75 rillig 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.128 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.75 rillig 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.110 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.75 rillig 762: documentation.</p>
763: </dd>
764: <dt><span class="term">package maintainers</span></dt>
765: <dd><p>A
1.110 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.75 rillig 767: <dt><span class="term">infrastructure developers</span></dt>
768: <dd><p>These people are involved in all those files
1.76 rillig 769: that live in the <code class="filename">mk/</code> directory and below.
1.110 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.75 rillig 771: too.</p></dd>
772: </dl></div>
773: </div>
774: </div>
1.148 asau 775: <div class="sect1">
1.75 rillig 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.128 wiz 780: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.75 rillig 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.148 asau 785: <div class="part">
1.75 rillig 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.157 asau 795: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 796: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 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>
1.82 rillig 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.151 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.166 jnemeth 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.75 rillig 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>
1.82 rillig 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>
1.75 rillig 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.109 rillig 846: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 847: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 848: <dd><dl>
1.103 wiz 849: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 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.88 wiz 852: </dl></dd>
1.103 wiz 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.75 rillig 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.106 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.75 rillig 863: <dd><dl>
1.180 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.174 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.106 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.128 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.106 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.173 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.128 wiz 889: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.173 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.75 rillig 897: </dl></dd>
898: </dl>
899: </div>
1.148 asau 900: <div class="chapter">
1.75 rillig 901: <div class="titlepage"><div><div><h2 class="title">
902: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
903: <div class="toc">
904: <p><b>Table of Contents</b></p>
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.157 asau 908: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128 wiz 909: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 910: </dl></dd>
911: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
912: <dd><dl>
913: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
914: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
915: </dl></dd>
916: </dl>
917: </div>
1.91 rillig 918: <p>Before you download and extract the files, you need to decide
919: where you want to extract them. When using pkgsrc as root user, pkgsrc
920: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
921: free to install the sources and binary packages wherever you want in
922: your filesystem, provided that the pathname does not contain white-space
923: or other characters that are interpreted specially by the shell and some
924: other programs. A safe bet is to use only letters, digits, underscores
925: and dashes.</p>
1.148 asau 926: <div class="sect1">
1.75 rillig 927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
928: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
929: <p>Before you download any pkgsrc files, you should decide
930: whether you want the <span class="emphasis"><em>current</em></span> branch or the
931: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
932: quarterly basis from the current branch and only gets modified
933: for security updates. The names of the stable branches are built
934: from the year and the quarter, for example
1.124 snj 935: <code class="literal">2009Q1</code>.</p>
1.75 rillig 936: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 937: want to download pkgsrc. You can get it as a tar file or via CVS.
938: Both ways are described here.</p>
1.157 asau 939: <p>Note that tar archive contains CVS working copy.
940: Thus you can switch to using CVS at any later time.</p>
941: <p>Note also that quarterly branch is not frozen in stone.
942: It receives critical updates.</p>
1.148 asau 943: <div class="sect2">
1.75 rillig 944: <div class="titlepage"><div><div><h3 class="title">
1.157 asau 945: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75 rillig 946: <p>The primary download location for all pkgsrc files is
1.157 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.75 rillig 954: It is autogenerated daily.</p>
1.157 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.166 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.112 weinem 965: <p>To download a pkgsrc stable tarball, run:</p>
966: <pre class="screen">
1.166 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.126 jakllsch 968: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112 weinem 969: stable branch to be downloaded, for example,
1.166 jnemeth 970: <span class="quote">“<span class="quote">pkgsrc-2013Q1</span>”</span>.</p>
1.157 asau 971: <p>You can use fetch it also using "wget", "curl",
972: or your web browser.</p>
1.112 weinem 973: <p>Then, extract it with:</p>
1.126 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.112 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.75 rillig 980: </div>
1.148 asau 981: <div class="sect2">
1.75 rillig 982: <div class="titlepage"><div><div><h3 class="title">
1.128 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.146 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.128 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.146 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 grant 994: </pre>
1.136 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.128 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.146 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.128 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.101 rillig 1012: <pre class="programlisting">
1013: # recommended CVS configuration file from the pkgsrc guide
1.146 wiz 1014: cvs -q -z2
1.101 rillig 1015: checkout -P
1.103 wiz 1016: update -dP
1017: diff -upN
1.101 rillig 1018: rdiff -u
1.128 wiz 1019: release -d
1.101 rillig 1020: </pre>
1.75 rillig 1021: </div>
1022: </div>
1.148 asau 1023: <div class="sect1">
1.75 rillig 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.148 asau 1030: <div class="sect2">
1.75 rillig 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.148 asau 1033: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1034: <h3 class="title">Warning</h3>
1.77 rillig 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>
1.75 rillig 1042: </div>
1.82 rillig 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.110 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.75 rillig 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.148 asau 1054: <div class="sect2">
1.75 rillig 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.132 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.148 asau 1063: <div class="sect3">
1.75 rillig 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.128 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.75 rillig 1071: back to the stable branch, add the
1.128 wiz 1072: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.75 rillig 1073: </div>
1.148 asau 1074: <div class="sect3">
1.75 rillig 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.128 wiz 1083: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1084: </div>
1085: </div>
1086: </div>
1087: </div>
1.148 asau 1088: <div class="chapter">
1.75 rillig 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>
1.82 rillig 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.151 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.166 jnemeth 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.75 rillig 1108: </dl></dd>
1109: </dl>
1110: </div>
1.148 asau 1111: <div class="sect1">
1.75 rillig 1112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1113: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 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.82 rillig 1115: </div>
1.148 asau 1116: <div class="sect1">
1.82 rillig 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.149 asau 1119: <p>pkgsrc can be bootstrapped for use in two different modes:
1120: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1121: to privileged one all programs are installed under one particular user
1.149 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.82 rillig 1125: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1126: <pre class="screen">
1.167 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.75 rillig 1128: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1129: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1130: </pre>
1.149 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.87 wiz 1135: and <code class="filename">/var/db/pkg</code> for the package database
1.149 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.148 asau 1147: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1148: <h3 class="title">Note</h3>
1.110 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.128 wiz 1152: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1153: </div>
1.149 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.75 rillig 1162: </div>
1.148 asau 1163: <div class="sect1">
1.75 rillig 1164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1165: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1166: <p>Here are some platform-specific notes you should be aware of.</p>
1.148 asau 1167: <div class="sect2">
1.75 rillig 1168: <div class="titlepage"><div><div><h3 class="title">
1.151 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.148 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.126 jakllsch 1193: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148 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.75 rillig 1199: </div>
1.148 asau 1200: <div class="sect2">
1.75 rillig 1201: <div class="titlepage"><div><div><h3 class="title">
1.151 obache 1202: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136 dholland 1203: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87 wiz 1204: other versions may work.</p>
1.75 rillig 1205: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1206: with the FreeBSD userland tools. There are several steps:</p>
1.128 wiz 1207: <div class="orderedlist"><ol class="orderedlist" type="1">
1208: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87 wiz 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.128 wiz 1213: <li class="listitem">
1.75 rillig 1214: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 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>
1.75 rillig 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>
1.87 wiz 1221: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1222: </pre>
1.75 rillig 1223: </li>
1.128 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.87 wiz 1225: <code class="filename">/etc/mk.conf.example</code> file
1226: when you use the bootstrap script.</p></li>
1.75 rillig 1227: </ol></div>
1228: </div>
1.148 asau 1229: <div class="sect2">
1.75 rillig 1230: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 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.75 rillig 1240: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 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.110 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.93 rillig 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.129 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.148 asau 1255: <div class="sect3">
1.75 rillig 1256: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1257: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1258: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1259: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148 asau 1260: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 1265: </ul></div>
1266: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 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>
1.75 rillig 1270: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1271: not need to be installed, but Remote Connectivity itself should be
1272: installed in order to have a working inetd.</p>
1.75 rillig 1273: <p>During installation you may be asked whether to enable setuid
1.87 wiz 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>
1.75 rillig 1278: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 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.114 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.93 rillig 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>
1.75 rillig 1295: </div>
1.148 asau 1296: <div class="sect3">
1.75 rillig 1297: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 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.75 rillig 1299: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1300: with pkgsrc, note the following things.</p>
1.148 asau 1301: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1302: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1303: Windows Services for UNIX, then click Change. In the installer, choose
1304: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.128 wiz 1305: <li class="listitem">
1.75 rillig 1306: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1307: change the following registry key:</p>
1.75 rillig 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.128 wiz 1311: <li class="listitem">
1.75 rillig 1312: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1313: following registry key:</p>
1.75 rillig 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.148 asau 1319: <div class="sect3">
1.75 rillig 1320: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1321: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1322: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 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>
1.75 rillig 1326: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1327: automatically complain if this is not the case. This ensures that
1328: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1329: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 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>
1.75 rillig 1334: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 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>
1.75 rillig 1338: <pre class="programlisting">
1.100 rillig 1339: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1340: </pre>
1.75 rillig 1341: </div>
1.148 asau 1342: <div class="sect3">
1.75 rillig 1343: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1344: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1345: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 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.148 asau 1348: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1349: <li class="listitem">
1.75 rillig 1350: <p><span class="strong"><strong>X11:</strong></span></p>
1351: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 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.110 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.87 wiz 1356: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1357: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1358: and the free X11 server included with
1.110 hubertf 1359: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1360: </li>
1.128 wiz 1361: <li class="listitem">
1.75 rillig 1362: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1363: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 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>
1.75 rillig 1369: </li>
1.128 wiz 1370: <li class="listitem">
1.75 rillig 1371: <p><span class="strong"><strong>Audio:</strong></span></p>
1372: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1373: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1374: audio system on Interix. Unlike on most platforms, the
1.91 rillig 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.110 hubertf 1376: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1377: server component. To output audio via an Interix host, the
1.91 rillig 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
1.87 wiz 1379: must also be installed.</p>
1.75 rillig 1380: </li>
1.128 wiz 1381: <li class="listitem">
1.75 rillig 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
1.87 wiz 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>
1.75 rillig 1388: </li>
1.128 wiz 1389: <li class="listitem">
1.75 rillig 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
1.87 wiz 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>
1.75 rillig 1396: </li>
1397: </ul></div>
1398: </div>
1.148 asau 1399: <div class="sect3">
1.75 rillig 1400: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1401: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1402: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 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.110 hubertf 1408: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 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>
1.75 rillig 1413: <pre class="screen">
1.87 wiz 1414: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1415: </pre>
1.75 rillig 1416: </div>
1417: </div>
1.148 asau 1418: <div class="sect2">
1.75 rillig 1419: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1420: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75 rillig 1421: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 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.110 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.75 rillig 1425: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.136 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.87 wiz 1427: etc.</p>
1.86 schwarz 1428: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 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
1.87 wiz 1433: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1434: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1435: try to link n32 object files with lib64 or vice versa. Check your
1436: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1437: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 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>
1.75 rillig 1441: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 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>
1.75 rillig 1445: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1446:
1.87 wiz 1447: </p>
1.75 rillig 1448: <pre class="programlisting">
1.100 rillig 1449: PKGSRC_COMPILER= mipspro
1.87 wiz 1450: </pre>
1.75 rillig 1451: <p>
1.1 grant 1452:
1.110 hubertf 1453: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 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>
1.75 rillig 1457: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1458: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 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>
1.75 rillig 1462: </div>
1.148 asau 1463: <div class="sect2">
1.75 rillig 1464: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1465: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87 wiz 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>
1.75 rillig 1473: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1474: directory:</p>
1.75 rillig 1475: <pre class="programlisting">
1.138 wiz 1476: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87 wiz 1477: </pre>
1.148 asau 1478: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1479: <h3 class="title">Note</h3>
1.138 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.137 wiz 1487: <pre class="programlisting">
1.138 wiz 1488: ICCBASE= /opt/intel/cc/10.1.008
1.87 wiz 1489: </pre>
1.138 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.75 rillig 1495: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 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.136 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.87 wiz 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>
1.75 rillig 1505: </div>
1.148 asau 1506: <div class="sect2">
1.75 rillig 1507: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1508: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163 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.166 jnemeth 1531: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136 dholland 1532: <p>OpenBSD 5.1 has been tested and supported,
1533: other versions may work.</p>
1.75 rillig 1534: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1535: with the OpenBSD userland tools. There are several steps:</p>
1.128 wiz 1536: <div class="orderedlist"><ol class="orderedlist" type="1">
1537: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87 wiz 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.128 wiz 1542: <li class="listitem">
1.75 rillig 1543: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 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>
1.75 rillig 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>
1.87 wiz 1550: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1551: </pre>
1.75 rillig 1552: </li>
1.128 wiz 1553: <li class="listitem">
1.110 hubertf 1554: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1555: <code class="filename">/etc/mk.conf.example</code> file
1556: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1557: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 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">
1.100 rillig 1561: .ifdef BSD_PKG_MK
1562: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1563: .else
1564: # OpenBSD stuff
1565: .endif
1.87 wiz 1566: </pre>
1.75 rillig 1567: </li>
1568: </ol></div>
1569: </div>
1.148 asau 1570: <div class="sect2">
1.75 rillig 1571: <div class="titlepage"><div><div><h3 class="title">
1.166 jnemeth 1572: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142 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.87 wiz 1575: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1576: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1577: process and to build packages.</p>
1.148 asau 1578: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 1584: </ul></div>
1.78 rillig 1585: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1586: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1587: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 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.148 asau 1591: <div class="sect3">
1.75 rillig 1592: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1593: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1594: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1595: for building all packages.</p>
1.75 rillig 1596: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1597: then either build gcc from
1.142 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.87 wiz 1599: package, then remove gcc used during bootstrapping.</p>
1.110 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.75 rillig 1601: </div>
1.148 asau 1602: <div class="sect3">
1.75 rillig 1603: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1604: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1605: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1606: 5.0)</p>
1.148 asau 1607: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1608: <li class="listitem"><p>SPROcc
1.87 wiz 1609: - Sun WorkShop Compiler C 5.0</p></li>
1.128 wiz 1610: <li class="listitem"><p>SPROcpl
1.87 wiz 1611: - Sun WorkShop Compiler C++ 5.0</p></li>
1.128 wiz 1612: <li class="listitem"><p>SPROild
1.87 wiz 1613: - Sun WorkShop Incremental Linker</p></li>
1.128 wiz 1614: <li class="listitem"><p>SPROlang
1.87 wiz 1615: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1616: </ul></div>
1.96 rillig 1617: <p>You should set the following variables in your
1.110 hubertf 1618: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1619: <pre class="programlisting">
1.100 rillig 1620: CC= cc
1621: CXX= CC
1622: CPP= cc -E
1623: CXXCPP= CC -E
1.96 rillig 1624: </pre>
1.148 asau 1625: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 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>
1.75 rillig 1631: </div>
1.148 asau 1632: <div class="sect3">
1.75 rillig 1633: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1634: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1635: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1636: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1637: <pre class="programlisting">
1.100 rillig 1638: PKGSRC_COMPILER= sunpro
1639: ABI= 64
1.96 rillig 1640: </pre>
1.148 asau 1641: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96 rillig 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>
1.75 rillig 1647: </div>
1.148 asau 1648: <div class="sect3">
1.75 rillig 1649: <div class="titlepage"><div><div><h4 class="title">
1.166 jnemeth 1650: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110 hubertf 1651: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1652: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1653: The workaround is to use another shell for the configure
1.91 rillig 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.110 hubertf 1655: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1656: <pre class="programlisting">
1.100 rillig 1657: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1658: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1659: </pre>
1.91 rillig 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>
1.75 rillig 1661: </div>
1662: </div>
1663: </div>
1664: </div>
1.148 asau 1665: <div class="chapter">
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 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
1.88 wiz 1691: is to only install the package tools and to use binary packages
1.128 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.88 wiz 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.148 asau 1696: <div class="sect1">
1.75 rillig 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.110 hubertf 1699: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 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.148 asau 1703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.109 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.110 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.148 asau 1711: <div class="sect2">
1.75 rillig 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.105 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.110 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.105 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.128 wiz 1721: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 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.75 rillig 1730: </div>
1.148 asau 1731: <div class="sect2">
1.75 rillig 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.109 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.128 wiz 1738: medium you are using).</p>
1.109 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.110 hubertf 1741: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 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.75 rillig 1759: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1760: package in question will be installed, too, assuming they are
1761: present where you install from.</p>
1.128 wiz 1762: <p>Adding packages might install vulnerable packages.
1763: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1764: regularly, especially after installing new packages, and verify
1765: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1766: <p>After you've installed packages, be sure to have
1.88 wiz 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>
1.75 rillig 1770: </div>
1.148 asau 1771: <div class="sect2">
1.75 rillig 1772: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 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
1.88 wiz 1775: installed from source code or from a binary package. The
1.110 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.88 wiz 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>
1.82 rillig 1784: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1785: removes all the packages that require the package in question
1786: and then removes the package itself. For example:
1.82 rillig 1787:
1.88 wiz 1788: </p>
1.82 rillig 1789: <pre class="screen">
1.88 wiz 1790: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1791: </pre>
1.82 rillig 1792: <p>
1793:
1.88 wiz 1794: will remove jpeg and all the packages that used it; this allows
1795: upgrading the jpeg package.</p>
1.82 rillig 1796: </div>
1.148 asau 1797: <div class="sect2">
1.82 rillig 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.110 hubertf 1800: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1801: installed packages or binary package files.</p>
1.82 rillig 1802: </div>
1.148 asau 1803: <div class="sect2">
1.82 rillig 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>
1.88 wiz 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.110 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.88 wiz 1811: </p>
1.82 rillig 1812: <p>
1.125 wiz 1813: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 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>
1.82 rillig 1818: <p>
1.125 wiz 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.88 wiz 1822: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1823: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1824: installed packages are vulnerable. If a package is vulnerable, you
1825: will see output similar to the following:
1826: </p>
1.82 rillig 1827: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1828: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1829: <p>
1.125 wiz 1830: You may wish to have the
1.110 hubertf 1831: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1832: file downloaded daily so that
1833: it remains current. This may be done by adding an appropriate entry
1.136 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.125 wiz 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.88 wiz 1852: </p>
1.82 rillig 1853: </div>
1.148 asau 1854: <div class="sect2">
1.82 rillig 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.112 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.128 wiz 1859: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 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>
1.82 rillig 1864: ...
1.88 wiz 1865: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1866: </pre>
1.110 hubertf 1867: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1868: package on your system and rebuild any dependencies.
1869: </p>
1.82 rillig 1870: </div>
1.148 asau 1871: <div class="sect2">
1.82 rillig 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.110 hubertf 1874: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1875: administrative functions on the package system.</p>
1.82 rillig 1876: </div>
1.148 asau 1877: <div class="sect2">
1.82 rillig 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>
1.75 rillig 1880: <p>Please pay very careful attention to the warnings
1.136 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.88 wiz 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>
1.75 rillig 1886: <p>The same warning of course applies to every package you
1.88 wiz 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>
1.75 rillig 1891: </div>
1892: </div>
1.148 asau 1893: <div class="sect1">
1.75 rillig 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>
1.88 wiz 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.110 hubertf 1899: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1900: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 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>
1.88 wiz 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.110 hubertf 1905: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 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.110 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.88 wiz 1910: instructions how to create your own packages.</p>
1.148 asau 1911: <div class="sect2">
1.75 rillig 1912: <div class="titlepage"><div><div><h3 class="title">
1913: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1914: <p>To build packages from source, you need a working C
1.88 wiz 1915: compiler. On NetBSD, you need to install the
1.128 wiz 1916: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1917: sets. If you want to build X11-related packages, the
1.128 wiz 1918: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1919: sets are required, too.</p>
1.75 rillig 1920: </div>
1.148 asau 1921: <div class="sect2">
1.75 rillig 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
1.88 wiz 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>
1.82 rillig 1932: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1933: <p>
1.110 hubertf 1934: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 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>
1.88 wiz 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>
1.75 rillig 1953: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1954: if you want to keep the settings, by editing the
1.110 hubertf 1955: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1956: and adding the definitions there.</p>
1.82 rillig 1957: <p>
1.88 wiz 1958: If a package depends on many other packages (such as
1.93 rillig 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
1.88 wiz 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>
1.82 rillig 1964: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1965: <p>
1.88 wiz 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>
1.75 rillig 1970: </div>
1.148 asau 1971: <div class="sect2">
1.75 rillig 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>
1.82 rillig 1974: <p>
1.88 wiz 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.148 asau 1980: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1981: <h3 class="title">Note</h3>
1982: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1983: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1984: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1985: </div>
1.87 wiz 1986: <p>For example, type</p>
1.88 wiz 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>
1.75 rillig 1991: <p>at the shell prompt to build the various components of the
1.88 wiz 1992: package.</p>
1.82 rillig 1993: <p>The next stage is to actually install the newly compiled
1.88 wiz 1994: program onto your system. Do this by entering:
1.82 rillig 1995:
1.88 wiz 1996: </p>
1.82 rillig 1997: <pre class="screen">
1.88 wiz 1998: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1999: </pre>
1.82 rillig 2000: <p>
2001:
1.88 wiz 2002: while you are still in the directory for whatever package you
2003: are installing.</p>
1.82 rillig 2004: <p>Installing the package on your system may require you to
1.88 wiz 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>
1.82 rillig 2008: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2009: You can now enter:
1.82 rillig 2010:
1.88 wiz 2011: </p>
1.82 rillig 2012: <pre class="screen">
1.88 wiz 2013: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2014: </pre>
1.82 rillig 2015: <p>
2016:
1.88 wiz 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>
1.82 rillig 2021: <pre class="screen">
1.88 wiz 2022: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2023: </pre>
1.75 rillig 2024: <p>Taking the figlet utility as an example, we can install it on our
1.110 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.88 wiz 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.110 hubertf 2043: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 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.110 hubertf 2048: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2049: set them each time you want to use pkgsrc.</p>
1.128 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.88 wiz 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.128 wiz 2055: <div class="orderedlist"><ol class="orderedlist" type="1">
2056: <li class="listitem">
1.136 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.88 wiz 2058: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2059: information will be displayed. For example,</p>
1.75 rillig 2060: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2061: <p>will show all the commands that are invoked, up to and
1.128 wiz 2062: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 2063: </li>
1.128 wiz 2064: <li class="listitem">
1.136 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.88 wiz 2066: definition, then the <code class="varname">VARNAME</code> definition
2067: should be used, in conjunction with the show-var
1.136 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.88 wiz 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>
1.75 rillig 2072: /usr/pkg
2073: <code class="prompt">%</code>
1.88 wiz 2074: </pre>
1.75 rillig 2075: </li>
2076: </ol></div>
2077: <p>If you want to install a binary package that you've either
1.88 wiz 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.136 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.110 hubertf 2082: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2083: sites searched is kept in the variable
2084: <code class="varname">BINPKG_SITES</code>, which defaults to
1.136 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.88 wiz 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>
1.75 rillig 2099: </div>
2100: </div>
2101: </div>
1.148 asau 2102: <div class="chapter">
1.75 rillig 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.109 rillig 2110: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2111: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2112: <dd><dl>
1.103 wiz 2113: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128 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.88 wiz 2116: </dl></dd>
1.103 wiz 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.75 rillig 2119: </dl>
2120: </div>
1.104 rillig 2121: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 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.136 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.89 rillig 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.148 asau 2138: <div class="sect1">
1.75 rillig 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
1.89 rillig 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.148 asau 2146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2147: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 2148: packages will be installed. The default is
1.76 rillig 2149: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2150: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 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.75 rillig 2153: installed. The default is
1.76 rillig 2154: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 2155: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 2156: X11 is installed on the system. The default is
1.76 rillig 2157: <code class="filename">/usr/X11R6</code>.</p></li>
1.128 wiz 2158: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 2159: downloaded copies of the original source distributions used
2160: for building pkgsrc packages. The default is
1.76 rillig 2161: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 2162: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 2163: database about installed packages is stored. The default is
2164: <code class="filename">/var/db/pkg</code>.</p></li>
1.128 wiz 2165: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 2166: If set, override the packages'
2167: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 2168: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 2169: Backup location(s) for distribution files and patch files
2170: if not found locally or in
1.76 rillig 2171: <code class="filename">${MASTER_SITES}</code> or
2172: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2173: The defaults are
1.132 spz 2174: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2175: and
1.76 rillig 2176: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 2177: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 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.128 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.125 wiz 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.75 rillig 2188: </ul></div>
2189: </div>
1.148 asau 2190: <div class="sect1">
1.75 rillig 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.148 asau 2195: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2196: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 2197: directory for the binary packages. The default is
1.76 rillig 2198: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 2199: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 2200: The top level directory where, if defined, the separate
2201: working directories will get created, and symbolically
1.76 rillig 2202: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2203: This is useful for building packages on several
1.76 rillig 2204: architectures, then <code class="filename">${PKGSRCDIR}</code>
2205: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 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.126 jakllsch 2208: — it is an internal definition which refers to the
1.75 rillig 2209: root of the pkgsrc tree. It is possible to have many
2210: pkgsrc tree instances.)</p></li>
1.128 wiz 2211: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 2212: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2213: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2214: information.</p></li>
1.128 wiz 2215: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2216: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2217: BSD-style Makefile. If this is not set,
2218: <code class="varname">MAKECONF</code> is set to
1.76 rillig 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.128 wiz 2221: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82 rillig 2222: By default, dependencies are only installed, and no binary
2223: package is created for them. You can set this variable to
1.174 asau 2224: <code class="literal">package-install</code> to automatically create binary
1.82 rillig 2225: packages after installing dependencies.</p></li>
1.75 rillig 2226: </ul></div>
2227: </div>
1.148 asau 2228: <div class="sect1">
1.75 rillig 2229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2230: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131 wiz 2231: <p>Most packages support installation into a
1.103 wiz 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.148 asau 2235: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2236: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 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.103 wiz 2246: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2247: clean</code></strong> needs to be run as root.</p>
1.118 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.174 asau 2265: <code class="prompt">$</code> make stage-install
1.118 imil 2266: </pre>
2267: <p>
2268:
2269: Create a package without root privileges
2270:
2271: </p>
2272: <pre class="programlisting">
1.174 asau 2273: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 2274: </pre>
2275: <p>
2276:
2277: For the following command, you must be able to gain root
1.136 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.118 imil 2279:
2280: </p>
2281: <pre class="programlisting">
1.174 asau 2282: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 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.103 wiz 2295: </div>
1.148 asau 2296: <div class="sect1">
1.103 wiz 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.148 asau 2299: <div class="sect2">
1.78 rillig 2300: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2301: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 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.148 asau 2304: <div class="variablelist"><dl class="variablelist">
1.89 rillig 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.148 asau 2310: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 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.128 wiz 2317: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 2318: distributed C/C++ (chainable)</p></li>
1.174 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.128 wiz 2325: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 2326: GNU C/C++ Compiler</p></li>
1.174 asau 2327: <li class="listitem"><p><code class="varname">hp</code>:
2328: HP-UX C/aC++ compilers</p></li>
1.128 wiz 2329: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 2330: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 2331: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 2332: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 2333: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 2334: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 2335: <li class="listitem"><p><code class="varname">xlc</code>:
2336: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89 rillig 2337: </ul></div>
2338: <p>The default is
1.128 wiz 2339: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 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.128 wiz 2343: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 2344: variable should always be terminated with a value for
2345: a real compiler. Note that only one real compiler
1.128 wiz 2346: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 2347: is not allowed).</p>
1.89 rillig 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.148 asau 2356: <div class="sect2">
1.89 rillig 2357: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2358: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 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">
1.100 rillig 2363: CFLAGS+= -your -flags
1.78 rillig 2364: </pre>
2365: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 2366: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 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.128 wiz 2369: package if you're interested in optimization specifically
2370: for the current CPU. </p>
1.78 rillig 2371: </div>
1.148 asau 2372: <div class="sect2">
1.88 wiz 2373: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2374: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 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">
1.100 rillig 2386: LDFLAGS+= -your -linkerflags
1.88 wiz 2387: </pre>
2388: </div>
1.78 rillig 2389: </div>
1.148 asau 2390: <div class="sect1">
1.78 rillig 2391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2392: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2393: <p>XXX
2394: </p>
1.148 asau 2395: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2396: <li class="listitem">
1.75 rillig 2397: <p><code class="varname">PKG_DEVELOPER</code>:
2398: Run some sanity checks that package developers want:
2399: </p>
1.148 asau 2400: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 2401: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 2402: fuzz</p></li>
1.128 wiz 2403: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 2404: binaries will find their shared libs.</p></li>
1.75 rillig 2405: </ul></div>
2406: <p>
1.87 wiz 2407: </p>
1.75 rillig 2408: </li>
1.128 wiz 2409: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 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.110 hubertf 2416: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2417: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2418: </ul></div>
2419: <p>
2420: </p>
2421: </div>
1.148 asau 2422: <div class="sect1">
1.75 rillig 2423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2424: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 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>
1.75 rillig 2428: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2429: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2430: show-options</strong></span>, for example:</p>
1.75 rillig 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.
1.1 grant 2440:
1.75 rillig 2441: These options are enabled by default: firefox
2442: These options are currently enabled: mozilla ssl
1.1 grant 2443: </pre>
1.75 rillig 2444: <p>The following variables can be defined in
1.110 hubertf 2445: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 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.128 wiz 2452: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2453: are disabled. A few examples:</p>
1.75 rillig 2454: <pre class="screen">
1.110 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.75 rillig 2456: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2457: PKG_OPTIONS.kdebase= debug -sasl
2458: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2459: <p>It is important to note that options that were specifically
1.120 snj 2460: suggested by the package maintainer must be explicitly removed if
1.111 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.88 wiz 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.128 wiz 2466: <div class="orderedlist"><ol class="orderedlist" type="1">
2467: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2468: maintainer</p></li>
1.128 wiz 2469: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2470: variables (see below)</p></li>
1.128 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.75 rillig 2473: </ol></div>
2474: <p>For groups of mutually exclusive options, the last option
1.88 wiz 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.110 hubertf 2483: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 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.110 hubertf 2488: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2489: directly. Support for the legacy variables will be removed
2490: eventually.</p>
1.75 rillig 2491: </div>
2492: </div>
1.148 asau 2493: <div class="chapter">
1.75 rillig 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.148 asau 2503: <div class="sect1">
1.75 rillig 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>
1.87 wiz 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.136 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.87 wiz 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.110 hubertf 2513: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 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.110 hubertf 2521: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2522: it. Binary packages are created by default in
2523: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 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.91 rillig 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.110 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.87 wiz 2527: such a binary package.</p>
1.75 rillig 2528: </div>
1.148 asau 2529: <div class="sect1">
1.75 rillig 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.110 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.106 rillig 2533: </div>
2534: </div>
1.148 asau 2535: <div class="chapter">
1.106 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.180 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.174 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.106 rillig 2548: </dl>
2549: </div>
1.180 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.174 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.106 rillig 2559: are most likely to be usable later.</p>
1.148 asau 2560: <div class="sect1">
1.106 rillig 2561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 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.106 rillig 2580: certain packages tried to install files outside the
2581: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2582: <code class="filename">/etc</code>.
2583: </p>
1.106 rillig 2584: </div>
1.148 asau 2585: <div class="sect1">
1.106 rillig 2586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 wiz 2587: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2588: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2589: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.116 rillig 2592: </ul></div>
1.148 asau 2593: <div class="sect2">
1.116 rillig 2594: <div class="titlepage"><div><div><h3 class="title">
1.180 wiz 2595: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.178 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.181 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.178 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.179 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.178 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.106 rillig 2651: </div>
2652: </div>
1.148 asau 2653: <div class="sect1">
1.106 rillig 2654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 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.174 asau 2671: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 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
1.91 rillig 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
1.87 wiz 2676: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2677: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2678: way that keeps all the dependencies for a given package on the same
2679: CD as that package.</p>
1.148 asau 2680: <div class="sect2">
1.75 rillig 2681: <div class="titlepage"><div><div><h3 class="title">
1.174 asau 2682: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 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>
1.75 rillig 2691: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 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>
1.75 rillig 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>
1.87 wiz 2705: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2706: </pre>
1.75 rillig 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>
1.76 rillig 2709: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2710: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2711: in their root directories.</p>
1.75 rillig 2712: </div>
2713: </div>
2714: </div>
1.148 asau 2715: <div class="chapter">
1.75 rillig 2716: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2717: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2718: <div class="toc">
2719: <p><b>Table of Contents</b></p>
2720: <dl>
1.128 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.90 rillig 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>
1.91 rillig 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">
1.100 rillig 2737: LOCALBASE= /usr/pkg
2738: PKG_SYSCONFBASE= /usr/pkg/etc
2739: VARBASE= /var
2740: PKG_DBDIR= /var/db/pkg
1.91 rillig 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">
1.100 rillig 2745: LOCALBASE= ${HOME}/pkg
2746: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2747: VARBASE= ${HOME}/pkg/var
2748: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 2749: </pre>
2750: <p>What these four directories are for, and what they look like is
2751: explained below.</p>
1.148 asau 2752: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2753: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2754: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2755: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 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.128 wiz 2760: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 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.128 wiz 2764: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2765: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 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.90 rillig 2767: itself.</p></li>
2768: </ul></div>
1.148 asau 2769: <div class="sect1">
1.90 rillig 2770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2771: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2772: </h2></div></div></div>
1.90 rillig 2773: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2774: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2775: <div class="variablelist"><dl class="variablelist">
1.90 rillig 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.148 asau 2835: <div class="sect1">
1.90 rillig 2836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2837: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2838: </h2></div></div></div>
1.148 asau 2839: <div class="variablelist"><dl class="variablelist">
1.90 rillig 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.148 asau 2856: <div class="chapter">
1.90 rillig 2857: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 2858: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2859: <div class="toc">
2860: <p><b>Table of Contents</b></p>
2861: <dl>
1.106 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.173 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.128 wiz 2873: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.173 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.75 rillig 2881: </dl>
2882: </div>
2883: <p>This section contains hints, tips & tricks on special things in
2884: pkgsrc that we didn't find a better place for in the previous chapters, and
2885: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2886: <div class="sect1">
1.75 rillig 2887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2888: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2889: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2890: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2891: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 2892: This is a general purpose list for most issues regarding
2893: pkgsrc, regardless of platform, e.g. soliciting user help
2894: for pkgsrc configuration, unexpected build failures, using
2895: particular packages, upgrading pkgsrc installations,
2896: questions regarding the pkgsrc release branches, etc. General announcements or
2897: proposals for changes that impact the pkgsrc user community,
2898: e.g. major infrastructure changes, new features, package
2899: removals, etc., may also be posted.</p></li>
1.128 wiz 2900: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 2901: A list where the results of pkgsrc bulk builds are sent and
2902: discussed.</p></li>
1.128 wiz 2903: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 2904: This list is for those who are interested in getting a
2905: commit message for every change committed to pkgsrc. It is
2906: also available in digest form, meaning one daily message
2907: containing all commit messages for changes to the package
2908: source tree in that 24 hour period.</p></li>
2909: </ul></div>
2910: <p>To subscribe, do:</p>
2911: <pre class="programlisting">
1.100 rillig 2912: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2913: </pre>
2914: <p>Archives for all these mailing lists are available from
1.110 hubertf 2915: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2916: </div>
1.148 asau 2917: <div class="sect1">
1.75 rillig 2918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2919: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 2920: <p>Pkgviews is tightly integrated with buildlink. You can find a
2921: pkgviews User's guide in
1.76 rillig 2922: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 2923: </div>
1.148 asau 2924: <div class="sect1">
1.75 rillig 2925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2926: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2927: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 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.148 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.75 rillig 2934: Symlinks for use by buildlink.</p></li></ul></div>
2935: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2936: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 2938: Calculates various kinds of checksums (including SHA1).</p></li>
1.128 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.75 rillig 2940: Compatibility library for pkgsrc tools.</p></li>
1.128 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.87 wiz 2942: non-BSD systems due to lack of native mtree.</p></li>
1.128 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.75 rillig 2944: Up-to-date replacement for
1.76 rillig 2945: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2946: systems where pkg_install is not present.</p></li>
2947: </ul></div>
2948: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2949: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 2951: Create a binary package from an
1.110 hubertf 2952: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2953: save the old package.</p></li>
1.128 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.75 rillig 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.128 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.117 jnemeth 2959: the best compiler flags to optimise code for your current
1.128 wiz 2960: CPU and compiler. </p></li>
1.75 rillig 2961: </ul></div>
2962: <p>Utilities for keeping track of installed packages, being up to date,
2963: etc:</p>
1.148 asau 2964: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.173 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.128 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.75 rillig 2969: packages whose installed versions do not match the latest pkgsrc
2970: entries.</p></li>
1.128 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.75 rillig 2972: dependency graphs of packages, to aid in choosing a strategy for
2973: updating.</p></li>
1.128 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.91 rillig 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.128 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.112 weinem 2977: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.128 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.75 rillig 2979: does various checks on the complete pkgsrc system.</p></li>
1.128 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.75 rillig 2981: packages you have installed.</p></li>
2982: </ul></div>
2983: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 2986: making and maintaining patches for a package (includes pkgdiff,
2987: pkgvi, mkpatches, etc.).</p></li>
1.173 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.75 rillig 2989: converting to pkgsrc.</p></li>
2990: </ul></div>
2991: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2992: utilities)</p>
1.148 asau 2993: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 2995: packages in a chrooted area.</p></li>
1.128 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.75 rillig 2997: kernel version for chrooted cross builds.</p></li>
2998: </ul></div>
2999: </div>
1.148 asau 3000: <div class="sect1">
1.75 rillig 3001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3002: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 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.128 wiz 3005: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.75 rillig 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.110 hubertf 3014: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128 wiz 3015: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.76 rillig 3016: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3017: installation targets. These directories can be overridden by the
1.128 wiz 3018: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.75 rillig 3019: that allow finer tuning of the tree layout.</p>
3020: </div>
1.148 asau 3021: <div class="sect1">
1.75 rillig 3022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3023: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 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.110 hubertf 3027: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3028: distfile is found, pkgsrc will try to resume it.</p>
3029: <p>You can also
1.168 wiz 3030: use a different program than the platform default program by changing the
1.117 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.75 rillig 3038: <p>For example, if you want to use
1.117 jnemeth 3039: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 3040: like:</p>
3041: <pre class="programlisting">
1.117 jnemeth 3042: FETCH_USING= wget
1.1 grant 3043: </pre>
1.75 rillig 3044: </div>
1.148 asau 3045: <div class="sect1">
1.75 rillig 3046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 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.103 wiz 3048: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3049: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3050: you will have to add the following line into
1.110 hubertf 3051: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3052: <pre class="programlisting">
1.103 wiz 3053: X11_TYPE=modular
1.1 grant 3054: </pre>
1.148 asau 3055: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 3056: <h3 class="title">Note</h3>
1.103 wiz 3057: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3058: </p>
1.75 rillig 3059: </div>
3060: </div>
1.148 asau 3061: <div class="sect1">
1.75 rillig 3062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3063: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 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.128 wiz 3068: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 3069: port 80 as the proxy port number. So the proxy environment variables
3070: are:</p>
3071: <pre class="programlisting">
1.100 rillig 3072: ftp_proxy=ftp://orpheus.amdahl.com:80/
3073: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3074: </pre>
1.75 rillig 3075: </div>
1.148 asau 3076: <div class="sect1">
1.75 rillig 3077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 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.75 rillig 3094: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3095: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3096: the first available command from the following list:</p>
1.148 asau 3097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 3100: </ul></div>
3101: <p>On a default NetBSD installation, this will be
1.76 rillig 3102: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 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.110 hubertf 3105: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3106: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3107: <p>Having that option present will prevent
1.76 rillig 3108: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3109: transfers.</p>
3110: </div>
1.148 asau 3111: <div class="sect1">
1.75 rillig 3112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3113: <a name="fetching-all-distfiles"></a>9.10. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3114: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3115: from work or university, where you can't run a <span class="command"><strong>make
1.132 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.75 rillig 3117: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3118: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3119: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3120: resulting list to your machine at work/school and use it there. If you
1.136 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.75 rillig 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>
1.76 rillig 3130: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3131: home.</p>
3132: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 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.110 hubertf 3135: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3136: directly by running:</p>
1.75 rillig 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.148 asau 3143: <div class="sect1">
1.75 rillig 3144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 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.128 wiz 3146: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.91 rillig 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>
1.75 rillig 3148: package, you get the error from make that it doesn't know how to make
1.76 rillig 3149: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 3150: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 3151: the NetBSD base distribution on your machine. It is recommended to do
3152: that to format man pages.</p>
1.91 rillig 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
1.75 rillig 3154: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3155: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3156: </div>
1.148 asau 3157: <div class="sect1">
1.75 rillig 3158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 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.87 wiz 3160: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3161: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3162: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 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>
1.76 rillig 3165: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3166: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3167: -r</strong></span>).</p>
3168: </div>
1.148 asau 3169: <div class="sect1">
1.75 rillig 3170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3171: <a name="using-sudo-with-pkgsrc"></a>9.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3172: <p>When installing packages as non-root user and using the just-in-time
1.136 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.75 rillig 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
1.98 wiz 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.110 hubertf 3178: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3179: <span class="emphasis"><em>after</em></span> the definition of the
3180: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3181: <pre class="programlisting">
1.100 rillig 3182: .if exists(${LOCALBASE}/bin/sudo)
3183: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3184: .endif
1.1 grant 3185: </pre>
1.75 rillig 3186: </div>
1.148 asau 3187: <div class="sect1">
1.75 rillig 3188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3189: <a name="faq.conf"></a>9.14. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3190: <p>As the system administrator, you can choose where configuration files
3191: are installed. The default settings make all these files go into
1.76 rillig 3192: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 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.110 hubertf 3198: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3199: directory; some common examples include <code class="filename">/etc</code> or
3200: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 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.148 asau 3209: <div class="sect1">
1.75 rillig 3210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3211: <a name="audit-packages"></a>9.15. Automated security checks</h2></div></div></div>
1.75 rillig 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.114 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.128 wiz 3220: <div class="orderedlist"><ol class="orderedlist" type="1">
3221: <li class="listitem">
1.122 reed 3222: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3223: download a list of the security vulnerabilities information. This list
1.132 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.75 rillig 3227: </li>
1.128 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.75 rillig 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.114 jmcneill 3234: <p>Use of these tools is strongly recommended! After
1.128 wiz 3235: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.75 rillig 3236: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114 jmcneill 3237: pkg_install</code></strong>.</p>
1.87 wiz 3238: <p>If this package is installed, pkgsrc builds will use it to
1.110 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.87 wiz 3240: check.</p>
1.75 rillig 3241: </div>
1.148 asau 3242: <div class="sect1">
1.75 rillig 3243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 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.75 rillig 3245: <p>When you add your own preferences to the
3246: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3247: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3248: environment variables to the <code class="filename">./configure</code>
1.136 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.75 rillig 3250: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3251: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 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.110 hubertf 3255: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3256: directory and then inspect any <code class="filename">Makefile</code> and
3257: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3258: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3259: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 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.148 asau 3264: <div class="sect1">
1.80 rillig 3265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 wiz 3266: <a name="ufaq-fail"></a>9.17. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3267: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3268: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 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.148 asau 3274: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 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.80 rillig 3277: files.</p></li>
1.148 asau 3278: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3279: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3280: verify this.</p></li>
1.148 asau 3281: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3282: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3283: </ol></div>
3284: </div>
1.148 asau 3285: <div class="sect1">
1.88 wiz 3286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173 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.89 rillig 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.110 hubertf 3295: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3296: -dP</strong></span> in that directory to download the current version.</p>
3297: </div>
1.75 rillig 3298: </div>
3299: </div>
1.148 asau 3300: <div class="part">
1.75 rillig 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.148 asau 3303: <div class="partintro">
1.77 rillig 3304: <div></div>
3305: <p>This part of the book deals with creating and
1.128 wiz 3306: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3307: guide on creating a new package. The remaining chapters are more
3308: like a reference manual for pkgsrc.</p>
1.75 rillig 3309: <div class="toc">
3310: <p><b>Table of Contents</b></p>
3311: <dl>
1.106 rillig 3312: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3313: <dd><dl>
1.106 rillig 3314: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3315: <dd><dl>
1.106 rillig 3316: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3317: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3318: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3319: </dl></dd>
1.106 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.128 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.106 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.128 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.106 rillig 3344: </dl></dd>
1.128 wiz 3345: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3346: <dd><dl>
3347: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 3348: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 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.128 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.106 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.128 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.106 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.128 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.106 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.133 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.106 rillig 3381: </dl></dd>
1.128 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.106 rillig 3383: <dd><dl>
1.128 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.106 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.128 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.106 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.128 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.106 rillig 3414: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3415: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 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.128 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.106 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.128 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.106 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.128 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.106 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.128 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.106 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.128 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.106 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.147 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.106 rillig 3483: </dl></dd>
1.128 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.106 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.128 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.106 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.128 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.106 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.107 rillig 3501: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 3502: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 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.87 wiz 3511: emulation</a></span></dt>
1.106 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.77 rillig 3514: </dl></dd>
1.106 rillig 3515: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3516: </dl></dd>
1.106 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.77 rillig 3519: <dd><dl>
1.106 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.140 wiz 3523: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 3524: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 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.106 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.85 jmmv 3535: </dl></dd>
1.75 rillig 3536: </dl>
3537: </div>
1.77 rillig 3538: </div>
1.148 asau 3539: <div class="chapter">
1.77 rillig 3540: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3541: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3542: <div class="toc">
3543: <p><b>Table of Contents</b></p>
3544: <dl>
1.106 rillig 3545: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3546: <dd><dl>
1.106 rillig 3547: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174 asau 3548: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118 imil 3549: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91 rillig 3550: </dl></dd>
1.106 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.91 rillig 3553: </dl>
3554: </div>
1.77 rillig 3555: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 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.128 wiz 3559: <div class="procedure"><ol class="procedure" type="1">
1.148 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.91 rillig 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.148 asau 3566: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 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.148 asau 3573: <li class="step">
1.91 rillig 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.132 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.91 rillig 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>
1.77 rillig 3590: <pre class="programlisting">
1.100 rillig 3591: [...]
1.77 rillig 3592:
1.174 asau 3593: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3594: DEPENDS+= screen-[0-9]*:../../misc/screen
3595: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3596:
1.100 rillig 3597: [...]
1.77 rillig 3598:
1.100 rillig 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"
1.77 rillig 3602: </pre>
3603: </li>
1.148 asau 3604: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 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.110 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.91 rillig 3608: -e</strong></span>, which outputs additional
3609: explanations.</p></li>
1.148 asau 3610: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110 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.91 rillig 3612: over there, you can hopefully continue here.</p></li>
1.148 asau 3613: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 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.148 asau 3618: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110 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.148 asau 3620: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3621: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3622: everything works.</p></li>
1.148 asau 3623: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3624: contains a list of the files that are installed by the package, is
1.110 hubertf 3625: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 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.148 asau 3629: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3630: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3631: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3632: has been registered in the database of installed files, but with an
1.110 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.91 rillig 3635: registered with the list of files from
3636: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3637: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3638: package from the set of installed files.</p></li>
1.77 rillig 3639: </ol></div>
1.148 asau 3640: <div class="sect1">
1.91 rillig 3641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3642: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148 asau 3643: <div class="sect2">
1.91 rillig 3644: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3645: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3646: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3647: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3648: </div>
1.148 asau 3649: <div class="sect2">
1.91 rillig 3650: <div class="titlepage"><div><div><h3 class="title">
1.174 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.91 rillig 3653: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174 asau 3654: settings that are typical of KDE3 packages.</p>
1.91 rillig 3655: </div>
1.148 asau 3656: <div class="sect2">
1.118 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.171 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.118 imil 3665: </p>
3666: <pre class="programlisting">
1.172 wiz 3667: PYTHON_VERSIONS_INCOMPATIBLE= 26
1.118 imil 3668: </pre>
3669: <p>
3670: If the packaged software is a Python module, include
1.128 wiz 3671: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.118 imil 3672: In this case, the package directory should be called
1.128 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.118 imil 3675: </p>
3676: <pre class="programlisting">
3677: DISTNAME= foopymodule-1.2.10
3678: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3679: </pre>
1.171 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.118 imil 3683: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3684: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3685: For example:
1.118 imil 3686: </p>
3687: <pre class="programlisting">
1.142 wiz 3688: REPLACE_PYTHON= *.py
1.118 imil 3689: </pre>
1.171 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.118 imil 3717: </div>
1.91 rillig 3718: </div>
1.148 asau 3719: <div class="sect1">
1.91 rillig 3720: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3721: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148 asau 3722: <div class="sect2">
1.91 rillig 3723: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3724: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3725: <div class="sect3">
1.91 rillig 3726: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3727: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3728: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3729: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3730: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3731: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3732: <pre class="programlisting">
1.100 rillig 3733: <code class="prompt">$</code> mkdir www/nvu
3734: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3735: </pre>
3736: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3737: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3738: <pre class="programlisting">
1.100 rillig 3739: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 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.128 wiz 3743: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 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">
1.100 rillig 3748: # $NetBSD$
3749: #
1.91 rillig 3750:
1.100 rillig 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
1.91 rillig 3760:
1.100 rillig 3761: # url2pkg-marker (please do not remove this line.)
3762: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3763: </pre>
3764: <p>Then, I quit the editor and watched pkgsrc downloading a large
3765: source archive:</p>
3766: <pre class="programlisting">
1.100 rillig 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.
1.91 rillig 3782:
1.100 rillig 3783: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3784:
1.100 rillig 3785: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3786: </pre>
3787: </div>
1.148 asau 3788: <div class="sect3">
1.91 rillig 3789: <div class="titlepage"><div><div><h4 class="title">
1.106 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.91 rillig 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">
1.100 rillig 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: [...]
1.91 rillig 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.128 wiz 3813: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3814: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3815: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3816: from scratch.</p>
3817: <pre class="programlisting">
1.100 rillig 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: [...]
1.91 rillig 3825: </pre>
1.128 wiz 3826: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3827: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3828: <pre class="programlisting">
1.100 rillig 3829: [...]
3830: checking for GTK - version >= 1.2.0... no
3831: *** Could not run GTK test program, checking why...
3832: [...]
1.91 rillig 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">
1.100 rillig 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
1.91 rillig 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.128 wiz 3851: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 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">
1.100 rillig 3858: [...]
3859: .include "../../x11/gtk2/buildlink3.mk"
3860: .include "../../mk/bsd.pkg.mk
1.91 rillig 3861: </pre>
1.110 hubertf 3862: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3863: was:</p>
3864: <pre class="programlisting">
1.100 rillig 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: [...]
1.91 rillig 3875: </pre>
1.128 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.91 rillig 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.110 hubertf 3880: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 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">
1.100 rillig 3885: [...]
1.166 jnemeth 3886: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 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: [...]
1.91 rillig 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">
1.100 rillig 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
1.91 rillig 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">
1.100 rillig 3910: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3911: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 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.148 asau 3924: <div class="sect3">
1.91 rillig 3925: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3926: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3927: <pre class="programlisting">
1.100 rillig 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
1.91 rillig 3933: </pre>
3934: </div>
3935: </div>
3936: </div>
1.77 rillig 3937: </div>
1.148 asau 3938: <div class="chapter">
1.75 rillig 3939: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3940: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3941: <div class="toc">
3942: <p><b>Table of Contents</b></p>
3943: <dl>
1.128 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.106 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.78 rillig 3960: </dl></dd>
1.128 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.75 rillig 3963: </dl>
3964: </div>
1.87 wiz 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.148 asau 3968: <div class="sect1">
1.75 rillig 3969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3970: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 3971: </h2></div></div></div>
1.75 rillig 3972: <p>Building, installation and creation of a binary package are all
1.87 wiz 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>
1.76 rillig 3977: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3978: sections that describe the package.</p>
1.75 rillig 3979: <p>In the first section there are the following variables, which
1.87 wiz 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.148 asau 3983: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3984: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3985: distribution file to be downloaded from the package's
3986: website.</p></li>
1.128 wiz 3987: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3988: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3989: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 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.87 wiz 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>
3997: the package file to create if the <code class="varname">PKGNAME</code>
3998: isn't unique on a SVR4 system. The default is
3999: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4000: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
1.87 wiz 4001: does not produce an unique package name on a SVR4 system.
4002: characters.</p></li>
1.128 wiz 4003: <li class="listitem">
1.75 rillig 4004: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4005: which the package fits in. You can choose any of the top-level
4006: directories of pkgsrc for it.</p>
1.75 rillig 4007: <p>Currently the following values are available for
1.87 wiz 4008: <code class="varname">CATEGORIES</code>. If more than
4009: one is used, they need to be separated by spaces:</p>
1.75 rillig 4010: <pre class="programlisting">
1.100 rillig 4011: archivers cross geography meta-pkgs security
4012: audio databases graphics misc shells
4013: benchmarks devel ham multimedia sysutils
4014: biology editors inputmethod net textproc
4015: cad emulators lang news time
4016: chat finance mail parallel wm
4017: comms fonts math pkgtools www
4018: converters games mbone print x11
4019: </pre>
1.75 rillig 4020: </li>
1.128 wiz 4021: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4022: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4023: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4024: and <code class="varname">DISTFILES</code> are discussed in detail in
1.128 wiz 4025: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.75 rillig 4026: </ul></div>
4027: <p>The second section contains information about separately
1.87 wiz 4028: downloaded patches, if any.
4029: </p>
1.148 asau 4030: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4031: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4032: Name(s) of additional files that contain distribution patches.
4033: There is no default. pkgsrc will look for them at
4034: <code class="varname">PATCH_SITES</code>.
4035: They will automatically be uncompressed before patching if
4036: the names end with <code class="filename">.gz</code> or
4037: <code class="filename">.Z</code>.</p></li>
1.128 wiz 4038: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4039: Primary location(s) for distribution patch files (see
4040: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4041: </ul></div>
4042: <p>The third section contains the following variables.
1.87 wiz 4043: </p>
1.148 asau 4044: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4045: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 4046: address of the person who feels responsible for this package,
4047: and who is most likely to look at problems or questions regarding
1.136 dholland 4048: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114 jmcneill 4049: Other developers may contact the <code class="varname">MAINTAINER</code>
4050: before making changes to the package, but are not required to
4051: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4052: to yourself. If you really can't maintain the package for future
4053: updates, set it to
1.110 hubertf 4054: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 4055: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 4056: of <code class="varname">MAINTAINER</code> when you do not want other
4057: developers to update or change the package without contacting
4058: you first. A package Makefile should contain one of
4059: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4060: not both. </p></li>
1.128 wiz 4061: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4062: find more information about the package.</p></li>
1.128 wiz 4063: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4064: description of the package (should not include the package
4065: name).</p></li>
1.75 rillig 4066: </ul></div>
4067: <p>Other variables that affect the build:
1.87 wiz 4068: </p>
1.148 asau 4069: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 4070: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4071: interesting distribution files of the package are found. The
4072: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4073: works for most packages.</p>
1.75 rillig 4074: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4075: (most GNU software does, for instance), but extracts itself in
4076: the current directory, you should set
4077: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4078: <p>If a package doesn't create a subdirectory with the
4079: name of <code class="varname">DISTNAME</code> but some different name,
4080: set <code class="varname">WRKSRC</code> to point to the proper name in
4081: <code class="filename">${WRKDIR}</code>, for example
4082: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4083: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75 rillig 4084: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4085: taken from the <code class="varname">WRKDIR_BASENAME</code>
4086: variable. By default, its value is
4087: <code class="filename">work</code>. If you want to use the same
4088: pkgsrc tree for building different kinds of binary packages,
4089: you can change the variable according to your needs. Two
4090: other variables handle common cases of setting
4091: <code class="varname">WRKDIR_BASENAME</code> individually. If
4092: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4093: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4094: the host's name is attached to the directory name. If
4095: <code class="varname">OBJMACHINE</code> is defined, the platform name
4096: is attached, which might look like
4097: <code class="filename">work.i386</code> or
4098: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4099: </li></ul></div>
4100: <p>Please pay attention to the following gotchas:</p>
1.148 asau 4101: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4102: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4103: installed in compressed form by the package. For packages using
4104: BSD-style makefiles which honor MANZ, there is
4105: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 4106: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4107: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 4108: below).</p></li>
1.128 wiz 4109: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.75 rillig 4110: </ul></div>
4111: </div>
1.148 asau 4112: <div class="sect1">
1.75 rillig 4113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4114: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4115: </h2></div></div></div>
1.76 rillig 4116: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4117: digest, or checksum, of each distfile needed for the package. This
4118: ensures that the distfiles retrieved from the Internet have not been
4119: corrupted during transfer or altered by a malign force to introduce
4120: a security hole. Due to recent rumor about weaknesses of digest
4121: algorithms, all distfiles are protected using both SHA1 and RMD160
4122: message digests, as well as the file size.</p>
1.76 rillig 4123: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4124: checksums for all the patches found in the
1.110 hubertf 4125: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.76 rillig 4126: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4127: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4128: command.</p>
1.75 rillig 4129: <p>Some packages have different sets of distfiles depending on
1.128 wiz 4130: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87 wiz 4131: <code class="filename">distinfo</code> file and care should be taken when
4132: upgrading such a package to ensure distfile information is not
4133: lost.</p>
1.75 rillig 4134: </div>
1.148 asau 4135: <div class="sect1">
1.75 rillig 4136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4137: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4138: <p>Many packages still don't work out-of-the box on the various
4139: platforms that are supported by pkgsrc. Therefore, a number of custom
4140: patch files are needed to make the package work. These patch files are
4141: found in the <code class="filename">patches/</code> directory.</p>
4142: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4143: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4144: extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.130 wiz 4145: order</a>.</p>
1.148 asau 4146: <div class="sect2">
1.93 rillig 4147: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4148: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4149: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4150: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4151: problems. (To force patches to apply with fuzz you can set
4152: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4153: should contain only changes for a single file, and no file should be
1.93 rillig 4154: patched by more than one patch file. This helps to keep future
4155: modifications simple.</p>
4156: <p>Each patch file is structured as follows: In the first line,
4157: there is the RCS Id of the patch itself. The second line should be
4158: empty for aesthetic reasons. After that, there should be a comment for
4159: each change that the patch does. There are a number of standard
4160: cases:</p>
1.148 asau 4161: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4162: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 4163: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 4164: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 4165: platform and other environment (for example, the compiler) that the
4166: patch is needed for.</p></li>
4167: </ul></div>
1.130 wiz 4168: <p>In all, the patch should be commented so that any
1.93 rillig 4169: developer who knows the code of the application can make some use of
4170: the patch. Special care should be taken for the upstream developers,
4171: since we generally want that they accept our patches, so we have less
4172: work in the future.</p>
4173: </div>
1.148 asau 4174: <div class="sect2">
1.93 rillig 4175: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4176: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4177: <p>One important thing to mention is to pay attention that no RCS
4178: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4179: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4180: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93 rillig 4181: problems.</p>
1.87 wiz 4182: <p>For even more automation, we recommend using
1.110 hubertf 4183: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4184: whole set of patches. You just have to backup files before you
4185: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4186: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4187: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4188: you upgrade a package this way, you can easily compare the new
4189: set of patches with the previously existing one with
1.130 wiz 4190: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4191: are replaced by new files, so carefully check if you want to take all
4192: the changes.</p>
1.87 wiz 4193: <p>When you have finished a package, remember to generate
1.110 hubertf 4194: the checksums for the patch files by using the <span class="command"><strong>make
1.128 wiz 4195: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.87 wiz 4196: <p>When adding a patch that corrects a problem in the
4197: distfile (rather than e.g. enforcing pkgsrc's view of where
4198: man pages should go), send the patch as a bug report to the
4199: maintainer. This benefits non-pkgsrc users of the package,
4200: and usually makes it possible to remove the patch in future
4201: version.</p>
1.101 rillig 4202: <p>The file names of the patch files are usually of the form
1.130 wiz 4203: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4204: Many packages still use the previous convention
4205: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4206: but new patches should be of the form containing the filename.
4207: <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
4208: automatically.</p>
1.93 rillig 4209: </div>
1.148 asau 4210: <div class="sect2">
1.93 rillig 4211: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4212: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4213: <p>If you want to share patches between multiple packages
4214: in pkgsrc, e.g. because they use the same distfiles, set
4215: <code class="varname">PATCHDIR</code> to the path where the patch files
4216: can be found, e.g.:</p>
4217: <pre class="programlisting">
1.100 rillig 4218: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4219: </pre>
1.75 rillig 4220: <p>Patch files that are distributed by the author or other
1.87 wiz 4221: maintainers can be listed in
4222: <code class="varname">PATCHFILES</code>.</p>
4223: <p>If it is desired to store any patches that should not be
4224: committed into pkgsrc, they can be kept outside the pkgsrc
4225: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4226: directory tree there is expected to have the same
1.128 wiz 4227: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 4228: patches are expected to be stored inside these dirs (also
4229: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4230: example, if you want to keep a private patch for
4231: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4232: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4233: files in the named directory are expected to be patch files,
4234: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4235: applied</em></span>.</p>
1.93 rillig 4236: </div>
1.148 asau 4237: <div class="sect2">
1.85 jmmv 4238: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4239: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4240: <p>When fixing a portability issue in the code do not use
4241: preprocessor magic to check for the current operating system nor
4242: platform. Doing so hurts portability to other platforms because
4243: the OS-specific details are not abstracted appropriately.</p>
4244: <p>The general rule to follow is: instead of checking for the
4245: operating system the application is being built on, check for the
4246: specific <span class="emphasis"><em>features</em></span> you need. For example,
4247: instead of assuming that kqueue is available under NetBSD and
4248: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 4249: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4250: yes, this generally involves patching the
1.110 hubertf 4251: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4252: that prevents some OSes from adopting interfaces from other OSes
4253: (e.g. Linux implementing kqueue), something that the above checks
4254: cannot take into account.</p>
4255: <p>Of course, checking for features generally involves more
4256: work on the developer's side, but the resulting changes are
1.87 wiz 4257: cleaner and there are chances they will work on many other
1.85 jmmv 4258: platforms. Not to mention that there are higher chances of being
4259: later integrated into the mainstream sources. Remember:
4260: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4261: <p>Some typical examples:</p>
4262: <div class="table">
1.106 rillig 4263: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4264: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4265: <colgroup>
4266: <col>
4267: <col>
4268: <col>
4269: </colgroup>
4270: <thead><tr>
4271: <th>Where</th>
4272: <th>Incorrect</th>
4273: <th>Correct</th>
4274: </tr></thead>
4275: <tbody>
4276: <tr>
4277: <td>configure script</td>
4278: <td>
1.100 rillig 4279: <pre class="programlisting">
4280: case ${target_os} in
4281: netbsd*) have_kvm=yes ;;
4282: *) have_kvm=no ;;
4283: esac
4284: </pre>
1.85 jmmv 4285: </td>
4286: <td>
1.100 rillig 4287: <pre class="programlisting">
4288: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4289: </pre>
1.85 jmmv 4290: </td>
4291: </tr>
4292: <tr>
4293: <td>C source file</td>
4294: <td>
1.100 rillig 4295: <pre class="programlisting">
4296: #if defined(__NetBSD__)
4297: # include <sys/event.h>
4298: #endif
4299: </pre>
1.85 jmmv 4300: </td>
4301: <td>
1.100 rillig 4302: <pre class="programlisting">
4303: #if defined(HAVE_SYS_EVENT_H)
4304: # include <sys/event.h>
4305: #endif
4306: </pre>
1.85 jmmv 4307: </td>
4308: </tr>
4309: <tr>
4310: <td>C source file</td>
4311: <td>
1.100 rillig 4312: <pre class="programlisting">
4313: int
4314: monitor_file(...)
4315: {
4316: #if defined(__NetBSD__)
4317: int fd = kqueue();
4318: ...
4319: #else
4320: ...
4321: #endif
4322: }
4323: </pre>
1.85 jmmv 4324: </td>
4325: <td>
1.100 rillig 4326: <pre class="programlisting">
4327: int
4328: monitor_file(...)
4329: {
4330: #if defined(HAVE_KQUEUE)
4331: int fd = kqueue();
4332: ...
4333: #else
4334: ...
4335: #endif
4336: }
4337: </pre>
1.85 jmmv 4338: </td>
4339: </tr>
4340: </tbody>
1.91 rillig 4341: </table></div>
1.85 jmmv 4342: </div>
1.91 rillig 4343: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4344: 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
4345: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4346: 2</a>). It summarizes multiple details on how to make
4347: software easier to package; all the suggestions in it were
4348: collected from our experience in pkgsrc work, so they are possibly
4349: helpful when creating patches too.</p>
4350: </div>
1.148 asau 4351: <div class="sect2">
1.85 jmmv 4352: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4353: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4354: <p>Always, always, <span class="strong"><strong>always</strong></span>
4355: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4356: improvements you do to a package to the mainstream developers.
4357: This is the only way to get their attention on portability issues
4358: and to ensure that future versions can be built out-of-the box on
4359: NetBSD. Furthermore, any user that gets newer distfiles will get
4360: the fixes straight from the packaged code.</p>
1.93 rillig 4361: <p>This generally involves cleaning up the patches
4362: (because sometimes the patches that are
1.147 wiz 4363: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 4364: appropriate trackers for the projects and working with the
4365: mainstream authors to accept your changes. It is
4366: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4367: the packages in pkgsrc are kept simple and thus further changes
4368: can be done without much hassle.</p>
1.130 wiz 4369: <p>When you have done this, please add a URL to the upstream
4370: bug report to the patch comment.</p>
1.85 jmmv 4371: <p>Support the idea of free software!</p>
4372: </div>
1.75 rillig 4373: </div>
1.148 asau 4374: <div class="sect1">
1.75 rillig 4375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4376: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148 asau 4377: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4378: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4379: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4380: any credits where they are due. Please bear in mind that others do not
4381: share your sense of humour (or spelling idiosyncrasies), and that others
4382: will read everything that you write here.</p></dd>
1.76 rillig 4383: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4384: <dd><p>This file governs the files that are installed on your
4385: system: all the binaries, manual pages, etc. There are other
4386: directives which may be entered in this file, to control the
4387: creation and deletion of directories, and the location of
1.110 hubertf 4388: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87 wiz 4389: information.</p></dd>
1.75 rillig 4390: </dl></div>
4391: </div>
1.148 asau 4392: <div class="sect1">
1.75 rillig 4393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4394: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148 asau 4395: <div class="sect2">
1.78 rillig 4396: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4397: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 4398: <div class="variablelist"><dl class="variablelist">
1.76 rillig 4399: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 4400: <dd>
1.136 dholland 4401: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 4402: First time after package extraction and before files are
4403: moved in place, the second time after the files to install
4404: are moved in place. This can be used to do any custom
4405: procedures not possible with @exec commands in
1.136 dholland 4406: <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
4407: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.
1.135 wiz 4408: Please note that you can modify variables in it easily by using
4409: <code class="varname">FILES_SUBST</code> in the package's
4410: <code class="filename">Makefile</code>:</p>
4411: <pre class="programlisting">
4412: FILES_SUBST+= SOMEVAR="somevalue"
4413: </pre>
4414: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4415: <code class="filename">INSTALL</code>. By default, substitution is
4416: performed for <code class="varname">PREFIX</code>,
4417: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4418: <code class="varname">VARBASE</code>, and a few others, type
4419: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4420: complete list.</p>
4421: </dd>
1.76 rillig 4422: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4423: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4424: this script's responsibility to clean up any additional messy details
4425: around the package's installation, since all pkg_delete knows is how to
4426: delete the files created in the original distribution.
1.136 dholland 4427: 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>
4428: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135 wiz 4429: The same methods to replace variables can be used as for
4430: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 4431: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4432: <dd>
4433: <p>This file is displayed after installation of the package.
1.87 wiz 4434: Useful for things like legal notices on almost-free
4435: software and hints for updating config files after
4436: installing modules for apache, PHP etc.
4437: Please note that you can modify variables in it easily by using
4438: <code class="varname">MESSAGE_SUBST</code> in the package's
4439: <code class="filename">Makefile</code>:</p>
1.75 rillig 4440: <pre class="programlisting">
1.100 rillig 4441: MESSAGE_SUBST+= SOMEVAR="somevalue"
4442: </pre>
1.128 wiz 4443: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 4444: <code class="filename">MESSAGE</code>. By default, substitution is
4445: performed for <code class="varname">PKGNAME</code>,
4446: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4447: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4448: <code class="varname">X11BASE</code>,
4449: <code class="varname">PKG_SYSCONFDIR</code>,
4450: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 4451: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 4452: <p>You can display a different or additional files by
4453: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4454: default is <code class="filename">MESSAGE</code>, if the file
4455: exists.</p>
1.75 rillig 4456: </dd>
1.78 rillig 4457: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 4458: <dd>
4459: <p>This file is used by the alternatives framework.
4460: It creates, configures, and destroys generic wrappers used to
4461: run programs with similar interfaces.
4462: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4463: for more information.</p>
4464: <p>Each line of the file contains two filenames, first
4465: the wrapper and then the alternative provided by the package.
4466: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4467: </dd>
1.78 rillig 4468: </dl></div>
4469: </div>
1.148 asau 4470: <div class="sect2">
1.78 rillig 4471: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4472: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4473: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4474: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4475: <dd><p>This file contains arbitrary things that could
4476: also go into a <code class="filename">Makefile</code>, but its purpose is
4477: to be used by more than one package. This file should only be
4478: used when the packages that will use the file are known in
4479: advance. For other purposes it is often better to write a
4480: <code class="filename">*.mk</code> file and give it a good name that
4481: describes what it does.</p></dd>
4482: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4483: <dd><p>This file contains the dependency information
1.110 hubertf 4484: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78 rillig 4485: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4486: <dd><p>This file contains workarounds for compiler bugs
4487: and similar things. It is included automatically by the pkgsrc
4488: infrastructure, so you don't need an extra
4489: <code class="literal">.include</code> line for
4490: it.</p></dd>
4491: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4492: <dd><p>This file contains the code for the
1.110 hubertf 4493: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78 rillig 4494: selected by the user. If a package has only one or two options,
4495: it is equally acceptable to put the code directly into the
4496: <code class="filename">Makefile</code>.</p></dd>
4497: </dl></div>
4498: </div>
1.148 asau 4499: <div class="sect2">
1.78 rillig 4500: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4501: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4502: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4503: <dt><span class="term"><code class="filename">README*</code></span></dt>
4504: <dd><p>These files do not take place in the creation of
4505: a package and thus are purely informative to the package
4506: developer.</p></dd>
4507: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4508: <dd><p>This file contains things that need to be done
4509: to make the package even
4510: better.</p></dd>
1.75 rillig 4511: </dl></div>
4512: </div>
1.78 rillig 4513: </div>
1.148 asau 4514: <div class="sect1">
1.75 rillig 4515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4516: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4517: </h2></div></div></div>
1.110 hubertf 4518: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4519: unpacked into the directory denoted by
4520: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4521: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4522: directory is also used to keep various timestamp files.
4523: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4524: The default is <code class="filename">${.CURDIR}/work</code>
4525: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4526: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4527: </div>
1.148 asau 4528: <div class="sect1">
1.75 rillig 4529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4530: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4531: </h2></div></div></div>
1.75 rillig 4532: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4533: to configuration or building, you could place these files here and use
1.110 hubertf 4534: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4535: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4536: this. Alternatively, you could simply diff the file against
4537: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4538: the creation of this file.</p>
4539: <p>If you want to share files in this way with other
4540: packages, set the <code class="varname">FILESDIR</code> variable to point
4541: to the other package's <code class="filename">files</code> directory,
4542: e.g.:</p>
4543: <pre class="programlisting">
1.100 rillig 4544: FILESDIR=${.CURDIR}/../xemacs/files
4545: </pre>
1.75 rillig 4546: </div>
4547: </div>
1.148 asau 4548: <div class="chapter">
1.75 rillig 4549: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4550: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4551: <div class="toc">
4552: <p><b>Table of Contents</b></p>
4553: <dl>
1.106 rillig 4554: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128 wiz 4555: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106 rillig 4556: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4557: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4558: <dd><dl>
4559: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4560: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4561: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4562: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4563: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4564: </dl></dd>
4565: </dl>
4566: </div>
1.76 rillig 4567: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4568: each of which forms a well-defined part of the pkgsrc system. Using
1.136 dholland 4569: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75 rillig 4570: like pkgsrc requires some discipline to keep the code correct and
4571: understandable.</p>
1.76 rillig 4572: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4573: programming are variables (which are actually macros) and shell
4574: commands. Among these shell commands may even be more complex ones
1.136 dholland 4575: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75 rillig 4576: as intended it is necessary to quote all variables correctly when they
4577: are used.</p>
4578: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4579: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4580: with them.</p>
1.148 asau 4581: <div class="sect1">
1.75 rillig 4582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4583: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148 asau 4584: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4585: <p>When you are creating a file as a
4586: target of a rule, always write the data to a temporary file first
4587: and finally rename that file. Otherwise there might occur an error
4588: in the middle of generating the file, and when the user runs
1.136 dholland 4589: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97 rillig 4590: regenerated properly. Example:</p>
4591: <pre class="programlisting">
1.100 rillig 4592: wrong:
4593: @echo "line 1" > ${.TARGET}
4594: @echo "line 2" >> ${.TARGET}
4595: @false
4596:
4597: correct:
4598: @echo "line 1" > ${.TARGET}.tmp
4599: @echo "line 2" >> ${.TARGET}.tmp
4600: @false
4601: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4602: </pre>
1.110 hubertf 4603: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4604: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4605: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4606: correct</strong></span> gives an error message twice, as expected.</p>
1.136 dholland 4607: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4608: <code class="literal">${.TARGET}</code> in case of error, but this only
4609: happens when it is interrupted, for example by pressing
4610: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.136 dholland 4611: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4612: </li></ul></div>
4613: </div>
1.148 asau 4614: <div class="sect1">
1.97 rillig 4615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4616: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4617: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4618: can be processed using the five operators ``='', ``+='', ``?='',
1.136 dholland 4619: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4620: page.</p>
4621: <p>When a variable's value is parsed from a
1.76 rillig 4622: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4623: backslash character ``\'' are handled specially. If a backslash is
4624: followed by a newline, any whitespace immediately in front of the
4625: backslash, the backslash, the newline, and any whitespace
4626: immediately behind the newline are replaced with a single space. A
4627: backslash character and an immediately following hash character are
4628: replaced with a single hash character. Otherwise, the backslash is
4629: passed as is. In a variable assignment, any hash character that is
4630: not preceded by a backslash starts a comment that continues upto the
4631: end of the logical line.</p>
4632: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4633: the only way to create a variable consisting of a single backslash
4634: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4635: <p>So far for defining variables. The other thing you can do with
4636: variables is evaluating them. A variable is evaluated when it is
4637: part of the right side of the ``:='' or the ``!='' operator, or
4638: directly before executing a shell command which the variable is part
1.136 dholland 4639: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75 rillig 4640: is, variables are not evaluated until there's no other way. The
4641: ``modifiers'' mentioned in the man page also evaluate the
4642: variable.</p>
4643: <p>Some of the modifiers split the string into words and then
4644: operate on the words, others operate on the string as a whole. When
4645: a string is split into words, it is split as you would expect
1.136 dholland 4646: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.126 jakllsch 4647: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4648: loop does not follow the shell quoting rules but splits at sequences
4649: of whitespace.</p>
4650: <p>There are several types of variables that should be handled
4651: differently. Strings and two types of lists.</p>
1.148 asau 4652: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4653: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75 rillig 4654: characters. Nevertheless, you should restrict yourself to only
4655: using printable characters. Examples are
4656: <code class="varname">PREFIX</code> and
4657: <code class="varname">COMMENT</code>.</p></li>
1.128 wiz 4658: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75 rillig 4659: are never exported to any shell command. Their elements are
4660: separated by whitespace. Therefore, the elements themselves cannot
4661: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4662: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4663: Examples are <code class="varname">DEPENDS</code> and
4664: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128 wiz 4665: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75 rillig 4666: may be exported to a shell command. Their elements can contain any
4667: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4668: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4669: <code class="varname">DISTFILES</code> and
4670: <code class="varname">MASTER_SITES</code>.</p></li>
4671: </ul></div>
1.148 asau 4672: <div class="sect2">
1.75 rillig 4673: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4674: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4675: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4676: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4677: are reserved for use by the pkgsrc infrastructure. They shall
4678: not be used by package
1.76 rillig 4679: <code class="filename">Makefile</code>s.</p></li>
1.128 wiz 4680: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4681: lowercase variable names for the iteration
4682: variables.</p></li>
1.128 wiz 4683: <li class="listitem"><p>All list variables should have a ``plural''
1.75 rillig 4684: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4685: <code class="varname">DISTFILES</code>.</p></li>
4686: </ul></div>
4687: </div>
4688: </div>
1.148 asau 4689: <div class="sect1">
1.75 rillig 4690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4691: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4692: <p>This section presents you with some code snippets you should
4693: use in your own code. If you don't find anything appropriate here,
4694: you should test your code and add it here.</p>
1.148 asau 4695: <div class="sect2">
1.75 rillig 4696: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4697: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4698: <pre class="programlisting">
1.100 rillig 4699: STRING= foo * bar `date`
4700: INT_LIST= # empty
4701: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4702: EXT_LIST= # empty
4703: ANOTHER_EXT_LIST= a=b c=d
4704:
4705: INT_LIST+= ${STRING} # 1
4706: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4707: EXT_LIST+= ${STRING:Q} # 3
4708: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4709: </pre>
1.75 rillig 4710: <p>When you add a string to an external list (example 3), it
4711: must be quoted. In all other cases, you must not add a quoting
4712: level. You must not merge internal and external lists, unless you
4713: are sure that all entries are correctly interpreted in both
4714: lists.</p>
4715: </div>
1.148 asau 4716: <div class="sect2">
1.75 rillig 4717: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4718: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 4719: <pre class="programlisting">
1.100 rillig 4720: EXT_LIST= # empty
4721: .for i in ${INT_LIST}
4722: EXT_LIST+= ${i:Q}""
4723: .endfor
1.1 grant 4724: </pre>
1.75 rillig 4725: <p>This code converts the internal list
4726: <code class="varname">INT_LIST</code> into the external list
4727: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4728: are unquoted they must be quoted here. The reason for appending
4729: <code class="varname">""</code> is explained below.</p>
4730: </div>
1.148 asau 4731: <div class="sect2">
1.75 rillig 4732: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4733: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4734: <p>Sometimes you may want to print an arbitrary string. There
4735: are many ways to get it wrong and only few that can handle every
4736: nastiness.</p>
1.75 rillig 4737: <pre class="programlisting">
1.100 rillig 4738: STRING= foo bar < > * `date` $$HOME ' "
4739: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4740:
1.100 rillig 4741: all:
4742: echo ${STRING} # 1
4743: echo "${STRING}" # 2
4744: echo "${STRING:Q}" # 3
4745: echo ${STRING:Q} # 4
4746: echo x${STRING:Q} | sed 1s,.,, # 5
4747: printf "%s\\n" ${STRING:Q}"" # 6
4748: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4749: </pre>
1.75 rillig 4750: <p>Example 1 leads to a syntax error in the shell, as the
4751: characters are just copied.</p>
4752: <p>Example 2 leads to a syntax error too, and if you leave out
4753: the last " character from <code class="varname">${STRING}</code>,
1.136 dholland 4754: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75 rillig 4755: variable would be evaluated, too.</p>
4756: <p>Example 3 outputs each space character preceded by a
4757: backslash (or not), depending on the implementation of the
1.136 dholland 4758: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75 rillig 4759: <p>Example 4 handles correctly every string that does not start
4760: with a dash. In that case, the result depends on the
1.136 dholland 4761: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75 rillig 4762: guarantee that your input does not start with a dash, this form is
4763: appropriate.</p>
4764: <p>Example 5 handles even the case of a leading dash
4765: correctly.</p>
1.79 rillig 4766: <p>Example 6 also works with every string and is the
4767: light-weight solution, since it does not involve a pipe, which has
4768: its own problems.</p>
1.75 rillig 4769: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4770: because the quoting has already been done when adding elements to
4771: the list.</p>
4772: <p>As internal lists shall not be passed to the shell, there is
4773: no example for it.</p>
4774: </div>
1.148 asau 4775: <div class="sect2">
1.75 rillig 4776: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4777: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4778: <p>There are many possible sources of wrongly quoted variables.
4779: This section lists some of the commonly known ones.</p>
1.148 asau 4780: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4781: <li class="listitem">
1.75 rillig 4782: <p>Whenever you use the value of a list, think
4783: about what happens to leading or trailing whitespace. If the
4784: list is a well-formed shell expression, you can apply the
4785: <code class="varname">:M*</code> modifier to strip leading and trailing
4786: whitespace from each word. The <code class="varname">:M</code> operator
4787: first splits its argument according to the rules of the shell,
4788: and then creates a new list consisting of all words that match
4789: the shell glob expression <code class="varname">*</code>, that is: all.
4790: One class of situations where this is needed is when adding a
4791: variable like <code class="varname">CPPFLAGS</code> to
4792: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4793: invokes other configure scripts, it strips the leading and
4794: trailing whitespace from the variable and then passes it to the
4795: other configure scripts. But these configure scripts expect the
4796: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4797: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4798: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4799: here is how we do it:</p>
4800: <pre class="programlisting">
1.100 rillig 4801: CPPFLAGS= # empty
4802: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4803: CPPFLAGS+= ${MY_CPPFLAGS}
4804:
4805: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4806:
4807: all:
4808: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4809: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4810: </pre>
1.75 rillig 4811: </li>
1.128 wiz 4812: <li class="listitem"><p>The example above contains one bug: The
1.75 rillig 4813: <code class="varname">${PREFIX}</code> is a properly quoted shell
4814: expression, but there is the C compiler after it, which also
4815: expects a properly quoted string (this time in C syntax). The
4816: version above is therefore only correct if
4817: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4818: or double quotes. If you want to allow these, you have to add
4819: another layer of quoting to each variable that is used as a C
4820: string literal. You cannot use the <code class="varname">:Q</code>
4821: operator for it, as this operator only works for the
4822: shell.</p></li>
1.128 wiz 4823: <li class="listitem">
1.75 rillig 4824: <p>Whenever a variable can be empty, the
4825: <code class="varname">:Q</code> operator can have surprising results. Here
4826: are two completely different cases which can be solved with the
4827: same trick.</p>
4828: <pre class="programlisting">
1.100 rillig 4829: EMPTY= # empty
4830: empty_test:
4831: for i in a ${EMPTY:Q} c; do \
4832: echo "$$i"; \
4833: done
4834:
4835: for_test:
4836: .for i in a:\ a:\test.txt
4837: echo ${i:Q}
4838: echo "foo"
4839: .endfor
1.1 grant 4840: </pre>
1.75 rillig 4841: <p>The first example will only print two of the three lines
4842: we might have expected. This is because
4843: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4844: the shell cannot see. The workaround is to write
4845: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
4846: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
4847: -f ${FNAME:Q}</code> (both of these are wrong).</p>
4848: <p>The second example will only print three lines instead of
4849: four. The first line looks like <code class="varname">a:\ echo foo</code>.
4850: This is because the backslash of the value
4851: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.136 dholland 4852: <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
4853: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75 rillig 4854: <code class="varname">${i:Q}""</code>.</p>
4855: </li>
4856: </ul></div>
4857: </div>
1.148 asau 4858: <div class="sect2">
1.75 rillig 4859: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4860: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 4861: <p>The pkgsrc bmake program does not handle the following
4862: assignment correctly. In case <code class="varname">_othervar_</code>
4863: contains a ``-'' character, one of the closing braces is included
4864: in <code class="varname">${VAR}</code> after this code executes.</p>
4865: <pre class="programlisting">
1.100 rillig 4866: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 4867: </pre>
1.75 rillig 4868: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 4869: package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
1.75 rillig 4870: <code class="varname">bug1</code>.</p>
4871: </div>
4872: </div>
4873: </div>
1.148 asau 4874: <div class="chapter">
1.75 rillig 4875: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4876: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 4877: <div class="toc">
4878: <p><b>Table of Contents</b></p>
4879: <dl>
1.106 rillig 4880: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128 wiz 4881: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4882: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 4883: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
4884: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128 wiz 4885: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106 rillig 4886: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
4887: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 4888: </dl>
4889: </div>
1.87 wiz 4890: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4891: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4892: the package (relative to the <code class="filename">${PREFIX}</code>
4893: directory it's been installed in) plus some additional statements
1.136 dholland 4894: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 4895: This chapter addresses some issues that need attention when
4896: dealing with the <code class="filename">PLIST</code> file (or files, see
4897: below!).</p>
1.148 asau 4898: <div class="sect1">
1.75 rillig 4899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4900: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 4901: <p>Be sure to add a RCS ID line as the first thing in any
4902: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4903: <pre class="programlisting">
1.100 rillig 4904: @comment $NetBSD$
1.87 wiz 4905: </pre>
1.75 rillig 4906: </div>
1.148 asau 4907: <div class="sect1">
1.75 rillig 4908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4909: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4910: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4911: to output a PLIST that matches any new files since the package
1.110 hubertf 4912: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.87 wiz 4913: more information on this target.</p>
1.75 rillig 4914: </div>
1.148 asau 4915: <div class="sect1">
1.75 rillig 4916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 4917: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4918: </h2></div></div></div>
1.87 wiz 4919: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 4920: <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
4921: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 4922: <code class="varname">@comment</code>s instead of real
4923: <code class="varname">@dirrm</code> lines. You can also do this for
4924: specific directories and files, so that the results of that
4925: command are very close to reality. This helps <span class="emphasis"><em>a
4926: lot</em></span> during the update of packages.</p>
4927: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4928: of AWK patterns and actions that are used to filter the output of
4929: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4930: scripting you like to it, but be careful with quoting.</p>
4931: <p>For example, to get all files inside the
4932: <code class="filename">libdata/foo</code> directory removed from the
4933: resulting PLIST:</p>
4934: <pre class="programlisting">
1.100 rillig 4935: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 4936: </pre>
4937: <p>And to get all the <code class="varname">@dirrm</code> lines referring
4938: to a specific (shared) directory converted to
4939: <code class="varname">@comment</code>s:</p>
1.75 rillig 4940: <pre class="programlisting">
1.100 rillig 4941: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 4942: </pre>
1.75 rillig 4943: </div>
1.148 asau 4944: <div class="sect1">
1.75 rillig 4945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4946: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4947: <p>A number of variables are substituted automatically in
4948: PLISTs when a package is installed on a system. This includes the
4949: following variables:</p>
1.148 asau 4950: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4951: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4952: <dd>
4953: <p>Some packages like emacs and perl embed information
1.87 wiz 4954: about which architecture they were built on into the
4955: pathnames where they install their files. To handle this
4956: case, PLIST will be preprocessed before actually used, and
4957: the symbol
1.128 wiz 4958: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4959: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4960: same is done if the string
4961: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4962: PLIST somewhere - use this on packages that have GNU
4963: autoconf-created configure scripts.</p>
1.148 asau 4964: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4965: <h3 class="title">Legacy note</h3>
4966: <p>There used to be a symbol
1.128 wiz 4967: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4968: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4969: -m</strong></span>, but that's no longer supported and has
4970: been removed.</p>
1.75 rillig 4971: </div>
4972: </dd>
4973: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4974: <dd>
4975: <p>Some packages want to embed the OS name and version
1.87 wiz 4976: into some paths. To do this, use these variables in the
4977: <code class="filename">PLIST</code>:
4978: </p>
1.148 asau 4979: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4980: <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>
4981: <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>
4982: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.75 rillig 4983: </ul></div>
4984: </dd>
4985: </dl></div>
1.87 wiz 4986: <p>For a complete list of values which are replaced by
4987: default, please look in <code class="filename">bsd.pkg.mk</code> (and
4988: search for <code class="varname">PLIST_SUBST</code>).</p>
4989: <p>If you want to change other variables not listed above, you
4990: can add variables and their expansions to this variable in the
1.110 hubertf 4991: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.75 rillig 4992: <pre class="programlisting">
1.100 rillig 4993: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 4994: </pre>
1.128 wiz 4995: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4996: in the <code class="filename">PLIST</code> with
1.128 wiz 4997: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4998: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4999: the common case of conditionally including some
5000: <code class="filename">PLIST</code> entries. It can be done by adding
5001: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 5002: setting the corresponding <code class="varname">PLIST.foo</code> variable
5003: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 5004: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 5005: in the <code class="filename">PLIST</code> with either
1.128 wiz 5006: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5007: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 5008: For example, in <code class="filename">Makefile</code>:</p>
5009: <pre class="programlisting">
5010: PLIST_VARS+= foo
5011: .if <em class="replaceable"><code>condition</code></em>
5012: PLIST.foo= yes
5013: .else
5014: </pre>
5015: <p>And then in <code class="filename">PLIST</code>:</p>
5016: <pre class="programlisting">
5017: @comment $NetBSD$
5018: bin/bar
5019: man/man1/bar.1
5020: ${PLIST.foo}bin/foo
5021: ${PLIST.foo}man/man1/foo.1
5022: ${PLIST.foo}share/bar/foo.data
5023: ${PLIST.foo}@dirrm share/bar
5024: </pre>
1.75 rillig 5025: </div>
1.148 asau 5026: <div class="sect1">
1.75 rillig 5027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5028: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5029: <p>Man pages should be installed in compressed form if
1.87 wiz 5030: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5031: and uncompressed otherwise. To handle this in the
1.128 wiz 5032: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 5033: appended/removed automatically for man pages according to
5034: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5035: or not, see above for details. This modification of the
5036: <code class="filename">PLIST</code> file is done on a copy of it, not
5037: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5038: </div>
1.148 asau 5039: <div class="sect1">
1.75 rillig 5040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5041: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5042: </h2></div></div></div>
1.76 rillig 5043: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5044: in generating the binary package, set the variable
5045: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.136 dholland 5046: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 5047: important. The default for <code class="varname">PLIST_SRC</code> is
5048: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5049: </div>
1.148 asau 5050: <div class="sect1">
1.75 rillig 5051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5052: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5053: <p>Some packages decide to install a different set of files based on
1.87 wiz 5054: the operating system being used. These differences can be
5055: automatically handled by using the following files:</p>
1.148 asau 5056: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5057: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5058: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5059: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5060: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5061: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5062: </ul></div>
5063: </div>
1.148 asau 5064: <div class="sect1">
1.75 rillig 5065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5066: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128 wiz 5067: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 5068: multiple (and unrelated) packages install files. These
1.125 wiz 5069: directories were problematic because you had to add special
5070: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 5071: centralized package handle them.</p>
1.125 wiz 5072: <p>In pkgsrc, it is now easy: Each package should create
5073: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5074: will remove any directories left empty after uninstalling a
5075: package.</p>
5076: <p>If a package needs an empty directory to work, create
5077: the directory during installation as usual, and also add an
5078: entry to the PLIST:
5079: </p>
1.87 wiz 5080: <pre class="programlisting">
1.125 wiz 5081: @pkgdir path/to/empty/directory
1.87 wiz 5082: </pre>
1.125 wiz 5083: <p>
5084: </p>
1.75 rillig 5085: </div>
5086: </div>
1.148 asau 5087: <div class="chapter">
1.75 rillig 5088: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5089: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5090: <div class="toc">
5091: <p><b>Table of Contents</b></p>
5092: <dl>
1.106 rillig 5093: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128 wiz 5094: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5095: <dd><dl>
1.106 rillig 5096: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133 wiz 5097: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5098: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5099: and
5100: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5101: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5102: </dl></dd>
1.128 wiz 5103: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 5104: <dd><dl>
1.128 wiz 5105: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106 rillig 5106: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 5107: </dl></dd>
5108: </dl>
5109: </div>
5110: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5111: are seen by a package's configure and build processes. This is implemented
5112: in a two step process:</p>
1.128 wiz 5113: <div class="orderedlist"><ol class="orderedlist" type="1">
5114: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 5115: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5116: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 5117: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5118: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5119: <code class="option">-L${LOCALBASE}/lib</code> into references to
5120: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5121: native compiler on some operating systems look like GCC, so that
5122: packages that expect GCC won't require modifications to build with
5123: those native compilers.</p></li>
1.75 rillig 5124: </ol></div>
5125: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5126: package may be built consistently despite what other software may be
5127: installed. Please note that the normal system header and library paths,
5128: e.g. <code class="filename">/usr/include</code>,
5129: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5130: designed to insulate the package build from non-system-supplied
5131: software.</p>
1.148 asau 5132: <div class="sect1">
1.75 rillig 5133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5134: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5135: <p>The process of converting packages to use the buildlink3
1.128 wiz 5136: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 5137: The things to keep in mind are:</p>
1.128 wiz 5138: <div class="orderedlist"><ol class="orderedlist" type="1">
5139: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 5140: instead of the actual toolchain. Some packages are tricky,
5141: and the only way to know for sure is the check
5142: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5143: wrappers are being invoked.</p></li>
1.128 wiz 5144: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 5145: the package Makefile, e.g. Java VMs, standalone shells,
5146: etc., because the code to symlink files into
5147: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 5148: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 5149: </p></li>
1.128 wiz 5150: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 5151: <code class="filename">buildlink3.mk</code> files that you list in a
5152: package's Makefile are added as dependencies for that package.
5153: </p></li>
1.75 rillig 5154: </ol></div>
1.87 wiz 5155: <p>If a dependency on a particular package is required for its libraries and
5156: headers, then we replace:</p>
1.75 rillig 5157: <pre class="programlisting">
1.100 rillig 5158: DEPENDS+= foo>=1.1.0:../../category/foo
5159: </pre>
1.75 rillig 5160: <p>with</p>
5161: <pre class="programlisting">
1.100 rillig 5162: .include "../../category/foo/buildlink3.mk"
5163: </pre>
1.75 rillig 5164: <p>The buildlink3.mk files usually define the required dependencies.
5165: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5166: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5167: <pre class="programlisting">
1.100 rillig 5168: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5169: .include "../../category/foo/buildlink3.mk"
5170: </pre>
1.76 rillig 5171: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5172: files in <code class="filename">pkgsrc/mk</code>
5173: that handle special package issues:</p>
1.148 asau 5174: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5175: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5176: the native or a pkgsrc Berkeley DB implementation based on
5177: the values of <code class="varname">BDB_ACCEPTED</code> and
5178: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 5179: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5180: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5181: to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.128 wiz 5182: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5183: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5184: adding a dependency on Heimdal or MIT-krb5 for packages that
5185: require a Kerberos 5 implementation.</p></li>
1.128 wiz 5186: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 5187: system-provided Motif installation or adds a dependency on
1.151 obache 5188: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>. The user can set
1.128 wiz 5189: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.151 obache 5190: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5191: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.88 wiz 5192: which Motif version will be used.</p></li>
1.161 ryoon 5193: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 5194: system-provided GNU readline or editline (libedit) installation,
1.161 ryoon 5195: 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>,
5196: <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
5197: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5198: If your package really needs GNU readline library, its Makefile
5199: should include <code class="filename">devel/readline/buildlink3.mk</code>
5200: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 5201: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5202: variables that may be used by packages that use the
5203: Open Sound System (OSS) API.</p></li>
1.128 wiz 5204: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 5205: any of the Postgres versions in the variable
5206: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5207: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 5208: the file for more information.</p></li>
1.128 wiz 5209: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5210: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5211: a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.128 wiz 5212: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5213: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5214: library.</p></li>
1.75 rillig 5215: </ul></div>
1.76 rillig 5216: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5217: files provide a more complete
5218: description of how to use them properly.</p>
1.75 rillig 5219: </div>
1.148 asau 5220: <div class="sect1">
1.75 rillig 5221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5222: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5223: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5224: included by Makefiles to indicate the need to compile and link
5225: against header files and libraries provided by the package. A
5226: <code class="filename">buildlink3.mk</code> file should always provide
5227: enough information to add the correct type of dependency
5228: relationship and include any other
5229: <code class="filename">buildlink3.mk</code> files that it needs to find
5230: headers and libraries that it needs in turn.</p>
5231: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5232: file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87 wiz 5233: package is highly recommended. For most packages, the following
5234: command will generate a good starting point for
5235: <code class="filename">buildlink3.mk</code> files:</p>
5236: <pre class="screen">
5237: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5238: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5239: </pre>
1.148 asau 5240: <div class="sect2">
1.75 rillig 5241: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5242: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5243: <p>The following real-life example
1.87 wiz 5244: <code class="filename">buildlink3.mk</code> is taken
5245: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5246: <pre class="programlisting">
1.120 snj 5247: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 5248:
1.120 snj 5249: BUILDLINK_TREE+= tiff
1.1 grant 5250:
1.120 snj 5251: .if !defined(TIFF_BUILDLINK3_MK)
5252: TIFF_BUILDLINK3_MK:=
1.87 wiz 5253:
1.120 snj 5254: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5255: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5256: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 5257:
1.100 rillig 5258: .include "../../devel/zlib/buildlink3.mk"
5259: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 5260: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5261:
1.120 snj 5262: BUILDLINK_TREE+= -tiff
1.100 rillig 5263: </pre>
1.87 wiz 5264: <p>The header and footer manipulate
1.120 snj 5265: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 5266: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 5267: the dependency tree.</p>
5268: <p>The main section is protected from multiple inclusion
1.87 wiz 5269: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5270: added. Several important variables are set in the section:</p>
1.148 asau 5271: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5272: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5273: is the actual dependency recorded in the installed
5274: package; this should always be set using
1.110 hubertf 5275: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5276: we're appending to any pre-existing list of values. This
5277: variable should be set to the first version of the
1.133 wiz 5278: package that had an backwards-incompatible API change.
1.87 wiz 5279: </p></li>
1.128 wiz 5280: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5281: is the location of the <em class="replaceable"><code>pkg</code></em>
5282: pkgsrc directory.</p></li>
1.128 wiz 5283: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5284: (not shown above) controls whether we use
5285: <code class="varname">BUILD_DEPENDS</code> or
5286: <code class="varname">DEPENDS</code> to add the dependency on
5287: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5288: selected by setting
5289: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5290: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 5291: used.</p></li>
1.128 wiz 5292: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5293: and
5294: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5295: (not shown above) are lists of subdirectories of
1.76 rillig 5296: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5297: to add to the header and library search paths. These
1.128 wiz 5298: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 5299: respectively.</p></li>
1.128 wiz 5300: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5301: (not shown above) is the list of preprocessor flags to add
5302: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 5303: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 5304: should be avoided and instead be handled using
5305: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5306: above.</p></li>
1.75 rillig 5307: </ul></div>
1.87 wiz 5308: <p>The following variables are all optionally defined within
5309: this second section (protected against multiple inclusion) and
5310: control which package files are symlinked into
5311: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5312: transformed during the symlinking:</p>
1.148 asau 5313: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5314: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5315: (not shown above) is a shell glob pattern relative to
1.76 rillig 5316: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5317: to be symlinked into
1.76 rillig 5318: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5319: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 5320: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 5321: (not shown above) is a shell pipeline that
5322: outputs to stdout a list of files relative to
5323: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5324: The resulting files are to be symlinked
5325: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5326: this takes the <code class="filename">+CONTENTS</code> of a
5327: <em class="replaceable"><code>pkg</code></em> and filters it through
5328: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 5329: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5330: (not shown above) is a filter command that filters
1.76 rillig 5331: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5332: relative to
1.76 rillig 5333: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5334: on stdout. By default for overwrite packages,
5335: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5336: outputs the contents of the <code class="filename">include</code>
5337: and <code class="filename">lib</code> directories in the package
5338: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5339: it outputs any libtool archives in
1.87 wiz 5340: <code class="filename">lib</code> directories.</p></li>
1.128 wiz 5341: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5342: (not shown above) is a list of sed arguments used to
5343: transform the name of the source filename into a
1.110 hubertf 5344: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5345: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5346: </ul></div>
1.120 snj 5347: <p>This section can additionally include any
1.87 wiz 5348: <code class="filename">buildlink3.mk</code> needed for
5349: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5350: Including these <code class="filename">buildlink3.mk</code> files
5351: means that the headers and libraries for these
5352: dependencies are also symlinked into
5353: <code class="filename">${BUILDLINK_DIR}</code>
5354: whenever the <em class="replaceable"><code>pkg</code></em>
5355: <code class="filename">buildlink3.mk</code>
1.120 snj 5356: file is included. Dependencies are only added for directly
5357: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 5358: <p>When providing a <code class="filename">buildlink3.mk</code> and
5359: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 5360: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 5361: header files are automatically exposed when the package is
5362: use.</p>
5363: <p>In particular, if only an executable
5364: (<code class="filename">bin/foo</code>) is linked against a library, that
5365: library does not need to be propagated in the
5366: <code class="filename">buildlink3.mk</code> file.</p>
5367: <p>The following steps should help you decide if a
5368: <code class="filename">buildlink3.mk</code> file needs to be included:
5369: </p>
5370: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5371: <li class="listitem"><p>Look at the installed header files: What
5372: headers do they include? The packages providing these files
5373: must be buildlinked.</p></li>
1.155 wiz 5374: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5375: libraries and look against what other libraries they link.
5376: Some of the packages providing these probably need to be
5377: buildlinked; however, it's not automatic, since e.g. GTK on
5378: some systems pulls in the X libraries, so they will show up in
5379: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 5380: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 5381: used as a hint.</p></li>
1.153 wiz 5382: </ul></div>
5383: <p>
5384: </p>
1.75 rillig 5385: </div>
1.148 asau 5386: <div class="sect2">
1.75 rillig 5387: <div class="titlepage"><div><div><h3 class="title">
1.133 wiz 5388: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87 wiz 5389: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5390: and
5391: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5392: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5393: <p>These two variables differ in that one describes source
5394: compatibility (API) and the other binary compatibility (ABI).
5395: The difference is that a change in the API breaks compilation of
5396: programs while changes in the ABI stop compiled programs from
5397: running.</p>
5398: <p>Changes to the
1.134 wiz 5399: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 5400: variable in a <code class="filename">buildlink3.mk</code> file happen
5401: very rarely. One possible reason is that all packages depending
5402: on this already need a newer version. In case it is bumped see
5403: the description below.</p>
5404: <p>The most common example of an ABI change is that the major
5405: version of a shared library is increased. In this case,
5406: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5407: should be adjusted to require at least the new package version.
5408: Then the packages that depend on this package need their
5409: <code class="varname">PKGREVISION</code>s increased and, if they have
5410: <code class="filename">buildlink3.mk</code> files, their
5411: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5412: adjusted, too. This is needed so pkgsrc will require the correct
5413: package dependency and not settle for an older one when building
5414: the source.</p>
1.110 hubertf 5415: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.133 wiz 5416: more information about dependencies on other packages,
5417: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5418: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5419: <p>Please take careful consideration before adjusting
5420: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5421: or
5422: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5423: as we don't want to cause unneeded package deletions and
5424: rebuilds. In many cases, new versions of packages work just
5425: fine with older dependencies.</p>
5426: <p>Also it is not needed to set
1.133 wiz 5427: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5428: when it is identical to
1.87 wiz 5429: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5430: </div>
5431: </div>
1.148 asau 5432: <div class="sect1">
1.75 rillig 5433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5434: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5435: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5436: coincide with headers and libraries present in the base system.
1.76 rillig 5437: Aside from a <code class="filename">buildlink3.mk</code> file, these
5438: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5439: file that includes the necessary checks to decide whether using
5440: the built-in software or the pkgsrc software is
1.87 wiz 5441: appropriate.</p>
5442: <p>The only requirements of a builtin.mk file for
5443: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 5444: <div class="orderedlist"><ol class="orderedlist" type="1">
5445: <li class="listitem"><p>It should set
1.87 wiz 5446: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5447: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 5448: after it is included.</p></li>
1.128 wiz 5449: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 5450: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5451: which is already set before the
5452: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 5453: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 5454: is <span class="emphasis"><em>very</em></span> important and takes careful
5455: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5456: </ol></div>
1.148 asau 5457: <div class="sect2">
1.75 rillig 5458: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5459: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75 rillig 5460: <p>The following is the recommended template for builtin.mk
1.87 wiz 5461: files:</p>
1.75 rillig 5462: <pre class="programlisting">
1.100 rillig 5463: .if !defined(IS_BUILTIN.foo)
5464: #
5465: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5466: # genuinely exists in the system or not.
5467: #
5468: IS_BUILTIN.foo?= no
5469:
5470: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5471: # version can be determined.
5472: #
5473: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5474: BUILTIN_PKG.foo?= foo-1.0
5475: . endif
5476: .endif # IS_BUILTIN.foo
5477:
5478: .if !defined(USE_BUILTIN.foo)
5479: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5480: . if defined(BUILTIN_PKG.foo)
5481: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5482: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5483: USE_BUILTIN.foo!= \
5484: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5485: && ${ECHO} "yes" || ${ECHO} "no"
5486: . endif
5487: . endfor
5488: . endif
5489: .endif # USE_BUILTIN.foo
5490:
5491: CHECK_BUILTIN.foo?= no
5492: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5493: #
5494: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5495: # "yes" or "no".
5496: #
5497: .endif # CHECK_BUILTIN.foo
5498: </pre>
1.87 wiz 5499: <p>The first section sets
5500: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5501: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5502: in the base system. This should not be a base system software
5503: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 5504: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 5505: included as part of the base system. This variable is only
5506: used internally within the <code class="filename">builtin.mk</code>
5507: file.</p>
5508: <p>The second section sets
5509: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5510: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5511: system if it exists (if
5512: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5513: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 5514: within the <code class="filename">builtin.mk</code> file.</p>
5515: <p>The third section sets
5516: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5517: and is <span class="emphasis"><em>required</em></span> in all
5518: <code class="filename">builtin.mk</code> files. The code in this
5519: section must make the determination whether the built-in
5520: software is adequate to satisfy the dependencies listed in
5521: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5522: This is typically done by comparing
5523: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5524: against each of the dependencies in
5525: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5526: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5527: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5528: end of the <code class="filename">builtin.mk</code> file. Note that
5529: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5530: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 5531: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 5532: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 5533: that the built-in version of the software is similar enough to
5534: be used as a replacement.</p>
5535: <p>The last section is guarded by
5536: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5537: and includes code that uses the value of
5538: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5539: set in the previous section. This typically includes, e.g.,
5540: adding additional dependency restrictions and listing additional
5541: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5542: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5543: </div>
1.148 asau 5544: <div class="sect2">
1.75 rillig 5545: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5546: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5547: <p>When building packages, it's possible to choose whether to set
5548: a global preference for using either the built-in (native)
5549: version or the pkgsrc version of software to satisfy a
5550: dependency. This is controlled by setting
5551: <code class="varname">PREFER_PKGSRC</code> and
5552: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 5553: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.87 wiz 5554: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5555: use the pkgsrc versions of software, while
5556: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5557: built-in versions. Preferences are determined by the most
5558: specific instance of the package in either
5559: <code class="varname">PREFER_PKGSRC</code> or
5560: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5561: in neither or in both variables, then
5562: <code class="varname">PREFER_PKGSRC</code> has precedence over
5563: <code class="varname">PREFER_NATIVE</code>. For example, to require
5564: using pkgsrc versions of software for all but the most basic
5565: bits on a NetBSD system, you can set:</p>
5566: <pre class="programlisting">
1.100 rillig 5567: PREFER_PKGSRC= yes
5568: PREFER_NATIVE= getopt skey tcp_wrappers
5569: </pre>
1.87 wiz 5570: <p>A package <span class="emphasis"><em>must</em></span> have a
5571: <code class="filename">builtin.mk</code>
5572: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5573: otherwise it is simply ignored in that list.</p>
1.75 rillig 5574: </div>
5575: </div>
5576: </div>
1.148 asau 5577: <div class="chapter">
1.75 rillig 5578: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5579: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5580: <div class="toc">
5581: <p><b>Table of Contents</b></p>
5582: <dl>
1.106 rillig 5583: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 5584: <dd><dl>
1.106 rillig 5585: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5586: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5587: </dl></dd>
1.106 rillig 5588: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5589: <dd><dl>
1.128 wiz 5590: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106 rillig 5591: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5592: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5593: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5594: </dl></dd>
5595: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5596: <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>
5597: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5598: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5599: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5600: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5601: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75 rillig 5602: </dl>
5603: </div>
5604: <p>This chapter describes the framework known as
5605: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5606: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5607: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5608: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5609: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5610: provided that packages are correctly designed.</p></li>
1.128 wiz 5611: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5612: <li class="listitem"><p>Registration of system users and groups.</p></li>
5613: <li class="listitem"><p>Registration of system shells.</p></li>
5614: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5615: </ul></div>
5616: <p>The following sections inspect each of the above points in detail.</p>
5617: <p>You may be thinking that many of the things described here could be
5618: easily done with simple code in the package's post-installation target
5619: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5620: as the code in them is only executed when building from source. Machines
5621: using binary packages could not benefit from it at all (as the code itself
5622: could be unavailable). Therefore, the only way to achieve any of the items
5623: described above is by means of the installation scripts, which are
5624: automatically generated by pkginstall.</p>
1.148 asau 5625: <div class="sect1">
1.75 rillig 5626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5627: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5628: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5629: of files and directories that belong to a package. The names used in it
1.76 rillig 5630: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5631: which means that it cannot register files outside this directory (absolute
5632: path names are not allowed). Despite this restriction, some packages need
5633: to install files outside this location; e.g., under
1.76 rillig 5634: <code class="filename">${VARBASE}</code> or
1.87 wiz 5635: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5636: is to create such files during installation time by using
5637: installation scripts.</p>
5638: <p>The generic installation scripts are shell scripts that can
5639: contain arbitrary code. The list of scripts to execute is taken from
5640: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5641: <code class="filename">INSTALL</code>. A similar variable exists for package
5642: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5643: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5644: commands, so they have the potential to create and manage files
5645: anywhere in the file system.</p>
5646: <p>Using these general installation files is not recommended, but
5647: may be needed in some special cases. One reason for avoiding them is
5648: that the user has to trust the packager that there is no unwanted or
5649: simply erroneous code included in the installation script. Also,
5650: previously there were many similar scripts for the same functionality,
5651: and fixing a common error involved finding and changing all of
5652: them.</p>
5653: <p>The pkginstall framework offers another, standardized way. It
5654: provides generic scripts to abstract the manipulation of such files
5655: and directories based on variables set in the package's
5656: <code class="filename">Makefile</code>. The rest of this section describes
5657: these variables.</p>
1.148 asau 5658: <div class="sect2">
1.75 rillig 5659: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5660: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5661: <p>The following variables can be set to request the creation of
5662: directories anywhere in the file system:</p>
1.148 asau 5663: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5664: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5665: contain a list of directories that should be created and should attempt
5666: to be destroyed by the installation scripts. The difference between
5667: the two is that the latter prompts the administrator to remove any
5668: directories that may be left after deinstallation (because they were
5669: not empty), while the former does not.</p></li>
1.128 wiz 5670: <li class="listitem">
1.75 rillig 5671: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5672: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5673: which directories should be created and should attempt to be destroyed
5674: by the installation scripts. Each tuple holds the following values,
5675: separated by spaces: the directory name, its owner, its group and its
5676: numerical mode. For example:</p>
5677: <pre class="programlisting">
1.100 rillig 5678: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5679: </pre>
1.75 rillig 5680: <p>The difference between the two is exactly the same as their
5681: non-<code class="varname">PERMS</code> counterparts.</p>
5682: </li>
5683: </ul></div>
5684: </div>
1.148 asau 5685: <div class="sect2">
1.75 rillig 5686: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5687: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5688: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5689: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5690: To overcome this problem, the only solution is to extract the file in the
5691: known place (i.e., inside the installation prefix) and copy it to the
5692: appropriate location during installation (done by the installation scripts
5693: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5694: file</em></span> in the following paragraphs, which describe the variables
5695: that can be used to automatically and consistently handle files outside the
5696: installation prefix:</p>
1.148 asau 5697: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5698: <li class="listitem">
1.75 rillig 5699: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5700: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5701: During installation time, the master file is copied to the target one
5702: if and only if the latter does not exist. Upon deinstallation, the
5703: target file is removed provided that it was not modified by the
5704: installation.</p>
5705: <p>The difference between the two is that the latter prompts the
5706: administrator to remove any files that may be left after
5707: deinstallation (because they were not empty), while the former does
5708: not.</p>
5709: </li>
1.128 wiz 5710: <li class="listitem">
1.75 rillig 5711: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5712: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5713: files as well as their target locations. For each of them, it also
5714: specifies their owner, their group and their numeric permissions, in
5715: this order. For example:</p>
5716: <pre class="programlisting">
1.137 wiz 5717: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5718: </pre>
1.75 rillig 5719: <p>The difference between the two is exactly the same as their
5720: non-<code class="varname">PERMS</code> counterparts.</p>
5721: </li>
5722: </ul></div>
5723: </div>
5724: </div>
1.148 asau 5725: <div class="sect1">
1.75 rillig 5726: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5727: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5728: <p>Configuration files are special in the sense that they are installed
5729: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5730: need special treatment during installation (most of which is automated by
5731: pkginstall). The main concept you must bear in mind is that files marked
5732: as configuration files are automatically copied to the right place (somewhere
5733: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5734: and only if</em></span> they didn't exist before. Similarly, they will not
5735: be removed if they have local modifications. This ensures that
5736: administrators never lose any custom changes they may have made.</p>
1.148 asau 5737: <div class="sect2">
1.75 rillig 5738: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5739: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 5740: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5741: specifies where configuration files shall be installed. Its contents are
5742: set based upon the following variables:</p>
1.148 asau 5743: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5744: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5745: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5746: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5747: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5748: Packages must not use it directly.</p></li>
1.128 wiz 5749: <li class="listitem">
1.75 rillig 5750: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5751: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5752: for the package being built shall be installed. The definition of this
5753: variable only makes sense in the package's
1.76 rillig 5754: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5755: <p>As an example, consider the Apache package,
1.177 joerg 5756: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.75 rillig 5757: configuration files under the
1.76 rillig 5758: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5759: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5760: Makefile.</p>
5761: </li>
1.128 wiz 5762: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5763: variable that holds this package's configuration directory (if
5764: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5765: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5766: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5767: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5768: directory where the configuration files for the package identified by
5769: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5770: </ul></div>
5771: <p>Based on the above variables, pkginstall determines the value of
5772: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5773: variable that can be used within a package to refer to its configuration
5774: directory. The algorithm used to set its value is basically the
5775: following:</p>
1.128 wiz 5776: <div class="orderedlist"><ol class="orderedlist" type="1">
5777: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5778: its value is used.</p></li>
1.128 wiz 5779: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5780: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5781: <code class="filename">Makefile</code>, the resulting value is
5782: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5783: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5784: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5785: </ol></div>
1.76 rillig 5786: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117 jnemeth 5787: 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
5788: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5789: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5790: </div>
1.148 asau 5791: <div class="sect2">
1.75 rillig 5792: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5793: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5794: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5795: known place, you need to teach each package where it shall install its
5796: files. In some cases you will have to patch the package Makefiles to
5797: achieve it. If you are lucky, though, it may be as easy as passing an
5798: extra flag to the configuration script; this is the case of GNU Autoconf-
5799: generated files:</p>
5800: <pre class="programlisting">
1.100 rillig 5801: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5802: </pre>
1.75 rillig 5803: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5804: for</em></span> its configuration files, not where they will be originally
5805: installed (although the difference is never explicit,
5806: unfortunately).</p>
5807: </div>
1.148 asau 5808: <div class="sect2">
1.75 rillig 5809: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5810: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5811: <p>As said before, pkginstall automatically handles configuration files.
5812: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5813: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5814: directly</strong></span>. Bad news is that many software installation scripts
5815: will, out of the box, mess with the contents of that directory. So what is
5816: the correct procedure to fix this issue?</p>
5817: <p>You must teach the package (usually by manually patching it) to
5818: install any configuration files under the examples hierarchy,
1.76 rillig 5819: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5820: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5821: has the original copies available.</p>
5822: <p>Once the required configuration files are in place (i.e., under the
5823: examples hierarchy), the pkginstall framework can use them as master copies
5824: during the package installation to update what is in
1.76 rillig 5825: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5826: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5827: used. Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.75 rillig 5828: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 5829: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75 rillig 5830: <pre class="programlisting">
1.100 rillig 5831: EGDIR= ${PREFIX}/share/doc/mutt/samples
5832: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5833: </pre>
1.75 rillig 5834: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5835: package and has no meaning outside it.</p>
5836: </div>
1.148 asau 5837: <div class="sect2">
1.75 rillig 5838: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5839: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5840: <p>The automatic copying of config files can be toggled by setting the
5841: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5842: installation.</p>
5843: </div>
5844: </div>
1.148 asau 5845: <div class="sect1">
1.75 rillig 5846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5847: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5848: <p>System startup scripts are special files because they must be
5849: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5850: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.75 rillig 5851: can be used. However, pkginstall provides a special mechanism to handle
5852: these files.</p>
5853: <p>In order to provide system startup scripts, the package has
5854: to:</p>
1.128 wiz 5855: <div class="orderedlist"><ol class="orderedlist" type="1">
5856: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5857: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 5858: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76 rillig 5859: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5860: <li class="listitem">
1.75 rillig 5861: <p>Tell pkginstall to handle it, appending the name of the script,
5862: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5863: Continuing the previous example:</p>
5864: <pre class="programlisting">
1.100 rillig 5865: RCD_SCRIPTS+= cupsd
1.1 grant 5866: </pre>
1.75 rillig 5867: </li>
5868: </ol></div>
5869: <p>Once this is done, pkginstall will do the following steps for each
5870: script in an automated fashion:</p>
1.128 wiz 5871: <div class="orderedlist"><ol class="orderedlist" type="1">
5872: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5873: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5874: variable.</p></li>
1.128 wiz 5875: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5876: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5877: that this master file must be explicitly registered in the
1.76 rillig 5878: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5879: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5880: from the examples hierarchy into the system-wide startup scripts
5881: directory.</p></li>
5882: </ol></div>
1.148 asau 5883: <div class="sect2">
1.75 rillig 5884: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5885: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5886: <p>The automatic copying of config files can be toggled by setting the
5887: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5888: installation. Note that the scripts will be always copied inside the
1.76 rillig 5889: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5890: matter what the value of this variable is.</p>
5891: </div>
5892: </div>
1.148 asau 5893: <div class="sect1">
1.75 rillig 5894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5895: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 5896: <p>If a package needs to create special users and/or groups during
5897: installation, it can do so by using the pkginstall framework.</p>
5898: <p>Users can be created by adding entries to the
5899: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5900: syntax:</p>
5901: <pre class="programlisting">
1.100 rillig 5902: user:group
1.1 grant 5903: </pre>
1.87 wiz 5904: <p>Further specification of user details may be done by setting
5905: per-user variables.
5906: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5907: numeric UID for the user.
5908: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5909: user's description or comment.
5910: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5911: user's home directory, and defaults to
5912: <code class="filename">/nonexistent</code> if not specified.
5913: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5914: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5915: not specified.</p>
1.75 rillig 5916: <p>Similarly, groups can be created by adding entries to the
5917: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5918: <pre class="programlisting">
1.100 rillig 5919: group
1.1 grant 5920: </pre>
1.93 rillig 5921: <p>The numeric GID of the group may be set by defining
1.75 rillig 5922: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5923: <p>If a package needs to create the users and groups at an earlier
5924: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
5925: either <code class="literal">configure</code> or <code class="literal">build</code> to
5926: indicate the phase before which the users and groups are created. In
5927: this case, the numeric UIDs and GIDs of the created users and groups
5928: are automatically hardcoded into the final installation scripts.</p>
5929: </div>
1.148 asau 5930: <div class="sect1">
1.75 rillig 5931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5932: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 5933: <p>Packages that install system shells should register them in the shell
1.76 rillig 5934: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5935: administrator. This must be done from the installation scripts to keep
5936: binary packages working on any system. pkginstall provides an easy way to
5937: accomplish this task.</p>
5938: <p>When a package provides a shell interpreter, it has to set the
5939: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5940: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 5941: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75 rillig 5942: <pre class="programlisting">
1.100 rillig 5943: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5944: </pre>
1.148 asau 5945: <div class="sect2">
1.75 rillig 5946: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5947: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5948: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5949: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5950: environment variable to <code class="literal">NO</code>.</p>
5951: </div>
5952: </div>
1.148 asau 5953: <div class="sect1">
1.75 rillig 5954: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5955: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 5956: <p>Packages that install X11 fonts should update the database files
5957: that index the fonts within each fonts directory. This can easily be
5958: accomplished within the pkginstall framework.</p>
5959: <p>When a package installs X11 fonts, it must list the directories in
5960: which fonts are installed in the
5961: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5962: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5963: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.75 rillig 5964: installation scripts to run the appropriate commands to update the fonts
5965: database files within each of those directories. For convenience, if the
5966: directory path is relative, it is taken to be relative to the package's
1.91 rillig 5967: installation prefix. Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75 rillig 5968: <pre class="programlisting">
1.175 wiz 5969: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5970: </pre>
1.148 asau 5971: <div class="sect2">
1.75 rillig 5972: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5973: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5974: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5975: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5976: environment variable to <code class="literal">NO</code>.</p>
5977: </div>
5978: </div>
5979: </div>
1.148 asau 5980: <div class="chapter">
1.75 rillig 5981: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5982: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 5983: <div class="toc">
5984: <p><b>Table of Contents</b></p>
5985: <dl>
1.106 rillig 5986: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128 wiz 5987: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106 rillig 5988: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 5989: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 5990: </dl>
5991: </div>
5992: <p>Many packages have the ability to be built to support different
1.76 rillig 5993: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 5994: in pkgsrc that provides generic handling of those options that
5995: determine different ways in which the packages can be built. It's
5996: possible for the user to specify exactly which sets of options will be
5997: built into a package or to allow a set of global default options
5998: apply.</p>
1.107 rillig 5999: <p>There are two broad classes of behaviors that one might want to
6000: control via options. One is whether some particular feature is
6001: enabled in a program that will be built anyway, often by including or
6002: not including a dependency on some other package. The other is
6003: whether or not an additional program will be built as part of the
6004: package. Generally, it is better to make a split package for such
6005: additional programs instead of using options, because it enables
6006: binary packages to be built which can then be added separately. For
6007: example, the foo package might have minimal dependencies (those
6008: packages without which foo doesn't make sense), and then the foo-gfoo
6009: package might include the GTK frontend program gfoo. This is better
6010: than including a gtk option to foo that adds gfoo, because either that
6011: option is default, in which case binary users can't get foo without
6012: gfoo, or not default, in which case they can't get gfoo. With split
6013: packages, they can install foo without having GTK, and later decide to
6014: install gfoo (pulling in GTK at that time). This is an advantage to
6015: source users too, avoiding the need for rebuilds.</p>
6016: <p>Plugins with widely varying dependencies should usually be split
6017: instead of options.</p>
6018: <p>It is often more work to maintain split packages, especially if
6019: the upstream package does not support this. The decision of split
6020: vs. option should be made based on the likelihood that users will want
6021: or object to the various pieces, the size of the dependencies that are
6022: included, and the amount of work.</p>
6023: <p>A further consideration is licensing. Non-free parts, or parts
6024: that depend on non-free dependencies (especially plugins) should
6025: almost always be split if feasible.</p>
1.148 asau 6026: <div class="sect1">
1.75 rillig 6027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6028: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6029: <p>Global default options are listed in
6030: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6031: that should be built into every package if that option is supported.
1.110 hubertf 6032: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6033: </div>
1.148 asau 6034: <div class="sect1">
1.75 rillig 6035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6036: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6037: </h2></div></div></div>
1.75 rillig 6038: <p>The following example shows how
1.76 rillig 6039: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6040: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6041: <code class="filename">Makefile</code>, or in a file,
6042: e.g. <code class="filename">options.mk</code>, that is included by the
6043: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6044: <pre class="programlisting">
1.100 rillig 6045: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6046: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6047: PKG_OPTIONS_OPTIONAL_GROUPS= database
6048: PKG_OPTIONS_GROUP.database= mysql pgsql
6049: PKG_SUGGESTED_OPTIONS= wibble-foo
6050: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6051: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6052:
6053: .include "../../mk/bsd.prefs.mk"
6054:
6055: # this package was previously named wibble2
6056: .if defined(PKG_OPTIONS.wibble2)
6057: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6058: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6059: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6060: .endif
6061:
6062: .include "../../mk/bsd.options.mk"
6063:
6064: # Package-specific option-handling
6065:
6066: ###
6067: ### FOO support
6068: ###
6069: .if !empty(PKG_OPTIONS:Mwibble-foo)
6070: CONFIGURE_ARGS+= --enable-foo
6071: .endif
6072:
6073: ###
6074: ### LDAP support
6075: ###
6076: .if !empty(PKG_OPTIONS:Mldap)
6077: . include "../../databases/openldap-client/buildlink3.mk"
6078: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6079: .endif
6080:
6081: ###
6082: ### database support
6083: ###
6084: .if !empty(PKG_OPTIONS:Mmysql)
6085: . include "../../mk/mysql.buildlink3.mk"
6086: .endif
6087: .if !empty(PKG_OPTIONS:Mpgsql)
6088: . include "../../mk/pgsql.buildlink3.mk"
6089: .endif
1.75 rillig 6090: </pre>
6091: <p>The first section contains the information about which build
6092: options are supported by the package, and any default options settings
6093: if needed.</p>
1.128 wiz 6094: <div class="orderedlist"><ol class="orderedlist" type="1">
6095: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.136 dholland 6096: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75 rillig 6097: options. It should be set to
1.78 rillig 6098: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6099: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6100: at the point where the options are processed.</p></li>
1.128 wiz 6101: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 6102: build options supported by the package.</p></li>
1.128 wiz 6103: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 6104: list of names of groups of mutually exclusive options. The options in
6105: each group are listed in
6106: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6107: The most specific setting of any option from the group takes
6108: precedence over all other options in the group. Options from the
6109: groups will be automatically added to
6110: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 6111: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 6112: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6113: packages will fail if no option from the group is
6114: selected.</p></li>
1.128 wiz 6115: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 6116: of names of sets of options. At least one option from each set must
6117: be selected. The options in each set are listed in
6118: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6119: Options from the sets will be automatically added to
6120: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6121: fail if no option from the set is selected.</p></li>
1.128 wiz 6122: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 6123: build options which are enabled by default.</p></li>
1.128 wiz 6124: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 6125: of
1.128 wiz 6126: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.110 hubertf 6127: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6128: their option counterparts. Pairs should be added with
1.128 wiz 6129: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 6130: warning will be issued if the user uses a legacy
6131: variable.</p></li>
1.128 wiz 6132: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 6133: of
1.128 wiz 6134: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.75 rillig 6135: pairs that map options that have been renamed to their new
1.128 wiz 6136: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 6137: the listing of global legacy options. A warning will be issued if
6138: the user uses a legacy option.</p></li>
1.128 wiz 6139: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 6140: options implied by deprecated variables used. This can be used for
6141: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6142: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6143: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 6144: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 6145: a list of warnings about deprecated variables or options used, and
6146: what to use instead.</p></li>
6147: </ol></div>
6148: <p>A package should never modify
6149: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6150: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6151: To suggest a default set of options, use
6152: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6153: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6154: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6155: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6156: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6157: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6158: happen with platform-specific options if none of them is supported on
6159: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6160: empty list and the package is otherwise treated as not using the
6161: options framework.</p>
1.76 rillig 6162: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6163: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6164: build options, properly filtered to remove unsupported and duplicate
6165: options.</p>
6166: <p>The remaining sections contain the logic that is specific to
6167: each option. The correct way to check for an option is to check
6168: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6169: <pre class="programlisting">
1.100 rillig 6170: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6171: </pre>
6172: </div>
1.148 asau 6173: <div class="sect1">
1.75 rillig 6174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6175: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6176: <p>Options that enable similar features in different packages (like
6177: optional support for a library) should use a common name in all
6178: packages that support it (like the name of the library). If another
6179: package already has an option with the same meaning, use the same
6180: name.</p>
6181: <p>Options that enable features specific to one package, where it's
6182: unlikely that another (unrelated) package has the same (or a similar)
6183: optional feature, should use a name prefixed with
6184: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6185: <p>If a group of related packages share an optional feature
6186: specific to that group, prefix it with the name of the
1.128 wiz 6187: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 6188: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6189: <p>For new options, add a line to
1.76 rillig 6190: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6191: fields, separated by tab. The first field is the option name, the
6192: second its description. The description should be a whole sentence
6193: (starting with an uppercase letter and ending with a period) that
1.128 wiz 6194: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6195: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 6196: </div>
1.148 asau 6197: <div class="sect1">
1.107 rillig 6198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6199: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6200: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107 rillig 6201: different dependencies based on the options with which the package was
6202: built. For querying these options, the file
6203: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6204: typical example looks like this:</p>
6205: <pre class="programlisting">
6206: pkgbase := libpurple
6207: .include "../../mk/pkg-build-options.mk"
6208:
6209: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6210: ...
6211: .endif
6212: </pre>
6213: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6214: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6215: options of the libpurple package, which can then be queried like
6216: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6217: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6218: details.</p>
6219: </div>
1.75 rillig 6220: </div>
1.148 asau 6221: <div class="chapter">
1.75 rillig 6222: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6223: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6224: <div class="toc">
6225: <p><b>Table of Contents</b></p>
6226: <dl>
1.106 rillig 6227: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6228: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6229: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6230: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128 wiz 6231: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 6232: <dd><dl>
6233: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6234: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6235: </dl></dd>
1.128 wiz 6236: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6237: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6238: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6239: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6240: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6241: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6242: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6243: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6244: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6245: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106 rillig 6246: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6247: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6248: </dl>
6249: </div>
1.148 asau 6250: <div class="sect1">
1.75 rillig 6251: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6252: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6253: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6254: built. Building a package is separated into different
6255: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6256: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 6257: described in the following sections. Each phase is split into
1.87 wiz 6258: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6259: containing phase, prefixed by one of <code class="varname">pre-</code>,
6260: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6261: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6262: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6263: <p>Never override the regular targets (like
6264: <code class="varname">fetch</code>), if you have to, override the
6265: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6266: <p>The basic steps for building a program are always the same. First
1.87 wiz 6267: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6268: the local system and then extracted. After any pkgsrc-specific patches
6269: to compile properly are applied, the software can be configured, then
6270: built (usually by compiling), and finally the generated binaries, etc.
6271: can be put into place on the system.</p>
1.97 rillig 6272: <p>To get more details about what is happening at each step,
6273: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6274: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6275: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6276: </div>
1.148 asau 6277: <div class="sect1">
1.75 rillig 6278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6279: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6280: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6281: the next section, here's a brief discussion on where programs are
6282: installed, and which variables influence this.</p>
1.75 rillig 6283: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6284: where all files of the final program shall be installed. It is
6285: usually set to <code class="varname">LOCALBASE</code>
6286: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6287: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6288: <code class="varname">PREFIX</code> needs to be put
6289: into the various places in the program's source where paths to
1.110 hubertf 6290: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.75 rillig 6291: <p>When choosing which of these variables to use,
1.87 wiz 6292: follow the following rules:</p>
1.148 asau 6293: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6294: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 6295: where the current pkg will be installed. When referring to a
6296: pkg's own installation path, use
1.128 wiz 6297: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6298: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 6299: are installed. If you need to construct a -I or -L argument
6300: to the compiler to find includes and libraries installed by
1.128 wiz 6301: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 6302: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6303: installed all packages in <code class="filename">/usr/local</code>. As
6304: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6305: administrator, this variable is a misnomer.</p></li>
1.128 wiz 6306: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 6307: distribution (from xsrc, etc.) is installed. When looking for
6308: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 6309: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6310: <li class="listitem">
1.88 wiz 6311: <p>X11-based packages are special in that they may be
6312: installed in either <code class="varname">X11BASE</code> or
6313: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6314: <p>Usually, X11 packages should be installed under
1.88 wiz 6315: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6316: will need to include
6317: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6318: request the presence of X11 and to get the right compilation
6319: flags.</p>
1.75 rillig 6320: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6321: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6322: files. These packages are special and they must be placed under
6323: <code class="varname">X11BASE</code>. To accomplish this, set either
6324: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6325: your package.</p>
1.75 rillig 6326: <p>Some notes: If you need
1.87 wiz 6327: to find includes or libraries installed by a pkg that has
6328: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6329: its pkg <code class="filename">Makefile</code>, you need to look in
6330: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6331: <code class="filename">${LOCALBASE}</code>. To force installation of
6332: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6333: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87 wiz 6334: is enabled by default.</p>
1.75 rillig 6335: </li>
1.128 wiz 6336: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88 wiz 6337: the installed location of an X11
6338: package. <code class="varname">X11PREFIX</code> will be set to
6339: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6340: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6341: installed.</p></li>
1.128 wiz 6342: <li class="listitem">
1.88 wiz 6343: <p>If xpkgwedge is installed, it is possible to have some
6344: packages installed in <code class="varname">X11BASE</code> and some in
6345: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6346: installed package, the <code class="varname">EVAL_PREFIX</code>
6347: definition can be used. It takes pairs in the format
1.136 dholland 6348: <span class="quote">“<span class="quote">DIRNAME=<package></span>”</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 6349: variable <code class="varname">DIRNAME</code> will be set to the prefix
6350: of the installed package <package>, or
1.128 wiz 6351: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.88 wiz 6352: installed.</p>
1.75 rillig 6353: <p>This is best illustrated by example.</p>
6354: <p>The following lines are taken from
1.87 wiz 6355: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6356: <pre class="programlisting">
1.100 rillig 6357: EVAL_PREFIX+= GTKDIR=gtk+
6358: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6359: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6360: CONFIGURE_ARGS+= --enable-multibyte
6361: </pre>
1.88 wiz 6362: <p>Specific defaults can be defined for the packages
6363: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6364: definition of the form:</p>
1.75 rillig 6365: <pre class="programlisting">
1.100 rillig 6366: GTKDIR_DEFAULT= ${LOCALBASE}
6367: </pre>
1.75 rillig 6368: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6369: to the first definition in
6370: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6371: </li>
1.128 wiz 6372: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.136 dholland 6373: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 6374: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6375: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6376: </ul></div>
6377: </div>
1.148 asau 6378: <div class="sect1">
1.75 rillig 6379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6380: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 6381: <p>When building a package, various directories are used to store
1.87 wiz 6382: source files, temporary files, pkgsrc-internal files, and so on. These
6383: directories are explained here.</p>
1.75 rillig 6384: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6385: are two common base directories for these relative directories:
6386: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6387: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6388: inside the package itself.</p>
1.148 asau 6389: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6390: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6391: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6392: root directory. Generally, you don't need
6393: it.</p></dd>
1.97 rillig 6394: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6395: <dd><p>This is an absolute pathname that points to the
6396: current package.</p></dd>
1.75 rillig 6397: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6398: <dd><p>This is a pathname relative to
1.87 wiz 6399: <code class="varname">PKGSRCDIR</code> that points to the current
6400: package.</p></dd>
1.75 rillig 6401: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6402: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6403: where all work takes place. The distfiles are extracted to this
1.87 wiz 6404: directory. It also contains temporary directories and log files used by
6405: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6406: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6407: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6408: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6409: where the distfiles are extracted. It is usually a direct subdirectory
6410: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6411: that isn't hidden. This variable may be changed by a package
6412: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6413: </dl></div>
1.114 jmcneill 6414: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6415: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 6416: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 6417: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6418: If users would like to have their pkgsrc trees behave in a
6419: read-only manner, then the value of
6420: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6421: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 6422: </div>
1.148 asau 6423: <div class="sect1">
1.75 rillig 6424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6425: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6426: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6427: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6428: phase. This will automatically run all phases that are required for this
6429: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6430: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6431: the package will be built, but not installed.</p>
1.75 rillig 6432: </div>
1.148 asau 6433: <div class="sect1">
1.75 rillig 6434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6435: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6436: <p>The first step in building a package is to fetch the
1.88 wiz 6437: distribution files (distfiles) from the sites that are providing
6438: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6439: phase.</p>
1.148 asau 6440: <div class="sect2">
1.81 rillig 6441: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6442: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 6443: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6444: defines all URLs from where the distfile, whose name is
6445: derived from the <code class="varname">DISTNAME</code> variable, is
6446: fetched. The more complicated cases are described
6447: below.</p>
6448: <p>The variable <code class="varname">DISTFILES</code> specifies
6449: the list of distfiles that have to be fetched. Its value
1.174 asau 6450: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6451: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 6452: so that most packages don't need to define it at all.
6453: <code class="varname">EXTRACT_SUFX</code> is
6454: <code class="literal">.tar.gz</code> by default, but can be changed
6455: freely. Note that if your package requires additional
6456: distfiles to the default one, you cannot just append the
6457: additional filenames using the <code class="literal">+=</code>
6458: operator, but you have write for example:</p>
1.81 rillig 6459: <pre class="programlisting">
1.174 asau 6460: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 6461: </pre>
1.88 wiz 6462: <p>Each distfile is fetched from a list of sites, usually
6463: <code class="varname">MASTER_SITES</code>. If the package has multiple
6464: <code class="varname">DISTFILES</code> or multiple
6465: <code class="varname">PATCHFILES</code> from different sites, you can
6466: set
6467: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6468: to the list of URLs where the file
6469: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6470: (including the suffix) can be found.</p>
6471: <pre class="programlisting">
1.100 rillig 6472: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6473: DISTFILES+= foo-file.tar.gz
6474: SITES.foo-file.tar.gz= \
6475: http://www.somewhere.com/somehow/ \
6476: http://www.somewhereelse.com/mirror/somehow/
6477: </pre>
1.81 rillig 6478: <p>When actually fetching the distfiles, each item from
1.88 wiz 6479: <code class="varname">MASTER_SITES</code> or
6480: <code class="varname">SITES.*</code> gets the name of each distfile
6481: appended to it, without an intermediate slash. Therefore,
6482: all site values have to end with a slash or other separator
6483: character. This allows for example to set
6484: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6485: that gets the name of the distfile as a parameter. In this
6486: case, the definition would look like:</p>
1.81 rillig 6487: <pre class="programlisting">
1.100 rillig 6488: MASTER_SITES= http://www.example.com/download.cgi?file=
6489: </pre>
1.125 wiz 6490: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 6491: In that case the URL is taken as is, fetched and the result
6492: stored under the name of the distfile. You can use this style
6493: for the case when the download URL style does not match the
6494: above common case. For example, if permanent download URL is a
6495: redirector to the real download URL, or the download file name
6496: is offered by an HTTP Content-Disposition header. In the
6497: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6498: created instead of the default
6499: <code class="filename">v1.0.0.tar.gz</code>.</p>
6500: <pre class="programlisting">
6501: DISTNAME= foo-1.0.0
6502: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
6503: </pre>
1.81 rillig 6504: <p>There are some predefined values for
1.88 wiz 6505: <code class="varname">MASTER_SITES</code>, which can be used in
6506: packages. The names of the variables should speak for
6507: themselves.</p>
6508: <pre class="programlisting">
1.100 rillig 6509: ${MASTER_SITE_APACHE}
6510: ${MASTER_SITE_BACKUP}
6511: ${MASTER_SITE_CYGWIN}
6512: ${MASTER_SITE_DEBIAN}
6513: ${MASTER_SITE_FREEBSD}
6514: ${MASTER_SITE_FREEBSD_LOCAL}
6515: ${MASTER_SITE_GENTOO}
6516: ${MASTER_SITE_GNOME}
6517: ${MASTER_SITE_GNU}
6518: ${MASTER_SITE_GNUSTEP}
1.174 asau 6519: ${MASTER_SITE_HASKELL_HACKAGE}
1.100 rillig 6520: ${MASTER_SITE_IFARCHIVE}
6521: ${MASTER_SITE_KDE}
6522: ${MASTER_SITE_MOZILLA}
1.174 asau 6523: ${MASTER_SITE_MOZILLA_ALL}
6524: ${MASTER_SITE_MOZILLA_ESR}
1.100 rillig 6525: ${MASTER_SITE_MYSQL}
1.174 asau 6526: ${MASTER_SITE_NETLIB}
1.100 rillig 6527: ${MASTER_SITE_OPENOFFICE}
6528: ${MASTER_SITE_PERL_CPAN}
6529: ${MASTER_SITE_PGSQL}
1.174 asau 6530: ${MASTER_SITE_RUBYGEMS}
1.100 rillig 6531: ${MASTER_SITE_R_CRAN}
6532: ${MASTER_SITE_SOURCEFORGE}
6533: ${MASTER_SITE_SOURCEFORGE_JP}
6534: ${MASTER_SITE_SUNSITE}
6535: ${MASTER_SITE_SUSE}
6536: ${MASTER_SITE_TEX_CTAN}
6537: ${MASTER_SITE_XCONTRIB}
6538: ${MASTER_SITE_XEMACS}
1.174 asau 6539: ${MASTER_SITE_XORG}
1.100 rillig 6540: </pre>
1.88 wiz 6541: <p>Some explanations for the less self-explaining ones:
6542: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 6543: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.132 spz 6544: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.88 wiz 6545: <p>If you choose one of these predefined sites, you may
6546: want to specify a subdirectory of that site. Since these
6547: macros may expand to more than one actual site, you
6548: <span class="emphasis"><em>must</em></span> use the following construct to
6549: specify a subdirectory:</p>
1.81 rillig 6550: <pre class="programlisting">
1.100 rillig 6551: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6552: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6553: </pre>
1.81 rillig 6554: <p>Note the trailing slash after the subdirectory
1.88 wiz 6555: name.</p>
1.81 rillig 6556: </div>
1.148 asau 6557: <div class="sect2">
1.81 rillig 6558: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6559: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6560: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6561: all the distfiles exist in a local directory
1.93 rillig 6562: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6563: user). If the files do not exist, they are fetched using
6564: commands of the form</p>
1.75 rillig 6565: <pre class="programlisting">
1.100 rillig 6566: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6567: </pre>
1.88 wiz 6568: <p>where <code class="literal">${site}</code> varies through
6569: several possibilities in turn: first,
6570: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6571: sites specified in either <code class="varname">SITES.file</code> if
6572: defined, else <code class="varname">MASTER_SITES</code> or
6573: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6574: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6575: all except the first and the last can be optionally sorted
6576: by the user, via setting either
6577: <code class="varname">MASTER_SORT_RANDOM</code>, and
6578: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6579: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6580: <p> The specific command and arguments used depend on the
6581: <code class="varname">FETCH_USING</code> parameter. The example above is
6582: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6583: <p>The distfiles mirror run by the NetBSD Foundation uses the
6584: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6585: distfiles, if they are freely distributable. Packages setting
6586: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6587: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6588: mirrored.</p>
1.81 rillig 6589: </div>
1.75 rillig 6590: </div>
1.148 asau 6591: <div class="sect1">
1.75 rillig 6592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6593: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6594: <p>After the distfile(s) are fetched, their checksum is
6595: generated and compared with the checksums stored in the
6596: distinfo file. If the checksums don't match, the build is
6597: aborted. This is to ensure the same distfile is used for
6598: building, and that the distfile wasn't changed, e.g. by some
6599: malign force, deliberately changed distfiles on the master
6600: distribution site or network lossage.</p>
1.75 rillig 6601: </div>
1.148 asau 6602: <div class="sect1">
1.75 rillig 6603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6604: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6605: <p>When the distfiles are present on the local system, they
1.88 wiz 6606: need to be extracted, as they usually come in the form of some
6607: compressed archive format.</p>
1.75 rillig 6608: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6609: extracted. If you only need some of them, you can set the
6610: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6611: files.</p>
6612: <p>Extracting the files is usually done by a little
1.93 rillig 6613: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6614: already knows how to extract various archive formats, so most
6615: likely you will not need to change anything here. But if you
6616: need, the following variables may help you:</p>
1.148 asau 6617: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6618: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6619: <dd><p>Use these variables to override the default
1.88 wiz 6620: options for an extract command, which are defined in
1.93 rillig 6621: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6622: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6623: <dd><p>This variable can be set to
1.114 jmcneill 6624: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6625: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6626: absolute pathname pointing to the command with which tar
1.114 jmcneill 6627: archives should be extracted. It is preferred to choose bsdtar over gtar
6628: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6629: </dl></div>
1.88 wiz 6630: <p>If the <code class="filename">extract</code> program doesn't
6631: serve your needs, you can also override the
6632: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6633: command used for extracting the files. This command is
6634: executed in the <code class="filename">${WRKSRC}</code>
6635: directory. During execution of this command, the shell
6636: variable <code class="varname">extract_file</code> holds the absolute
6637: pathname of the file that is going to be extracted.</p>
1.75 rillig 6638: <p>And if that still does not suffice, you can override the
1.88 wiz 6639: <code class="varname">do-extract</code> target in the package
6640: Makefile.</p>
1.75 rillig 6641: </div>
1.148 asau 6642: <div class="sect1">
1.75 rillig 6643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6644: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6645: <p>After extraction, all the patches named by the
1.88 wiz 6646: <code class="varname">PATCHFILES</code>, those present in the patches
6647: subdirectory of the package as well as in
6648: $LOCALPATCHES/$PKGPATH (e.g.
6649: <code class="filename">/usr/local/patches/graphics/png</code>) are
6650: applied. Patchfiles ending in <code class="filename">.Z</code> or
6651: <code class="filename">.gz</code> are uncompressed before they are
6652: applied, files ending in <code class="filename">.orig</code> or
6653: <code class="filename">.rej</code> are ignored. Any special options to
1.136 dholland 6654: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.110 hubertf 6655: <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.136 dholland 6656: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 6657: it fail if the patches apply with some lines of fuzz. Please
6658: fix (regen) the patches so that they apply cleanly. The
6659: rationale behind this is that patches that don't apply cleanly
6660: may end up being applied in the wrong place, and cause severe
6661: harm there.</p>
1.75 rillig 6662: </div>
1.148 asau 6663: <div class="sect1">
1.75 rillig 6664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6665: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6666: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88 wiz 6667: </p>
1.75 rillig 6668: </div>
1.148 asau 6669: <div class="sect1">
1.75 rillig 6670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6671: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6672: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6673: linkers. The following variables can be used to tweak the
6674: wrappers.</p>
1.148 asau 6675: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6676: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6677: <dd><p>The command used to print progress
1.88 wiz 6678: messages. Does nothing by default. Set to
6679: <code class="literal">${ECHO}</code> to see the progress
6680: messages.</p></dd>
1.75 rillig 6681: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6682: <dd><p>This variable can be set to
1.88 wiz 6683: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6684: depending on whether you want additional information in the
6685: wrapper log file.</p></dd>
1.75 rillig 6686: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6687: <dd><p>This variable can be set to
1.88 wiz 6688: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6689: on whether the wrapper should use its cache, which will
6690: improve the speed. The default value is
6691: <code class="literal">yes</code>, but is forced to
6692: <code class="literal">no</code> if the platform does not support
6693: it.</p></dd>
1.75 rillig 6694: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6695: <dd><p>A list of reordering commands. A reordering
6696: command has the form
6697: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6698: It ensures that that
6699: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6700: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6701: </p></dd>
1.75 rillig 6702: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6703: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6704: investigate further]</p></dd>
1.75 rillig 6705: </dl></div>
6706: </div>
1.148 asau 6707: <div class="sect1">
1.75 rillig 6708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6709: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6710: <p>Most pieces of software need information on the header
6711: files, system calls, and library routines which are available
6712: on the platform they run on. The process of determining this
6713: information is known as configuration, and is usually
6714: automated. In most cases, a script is supplied with the
6715: distfiles, and its invocation results in generation of header
6716: files, Makefiles, etc.</p>
6717: <p>If the package contains a configure script, this can be
6718: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6719: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6720: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6721: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6722: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6723: <pre class="programlisting">
1.100 rillig 6724: .for d in ${CONFIGURE_DIRS}
6725: cd ${WRKSRC} \
6726: && cd ${d} \
6727: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6728: .endfor
6729: </pre>
1.88 wiz 6730: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6731: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6732: <code class="varname">WRKSRC</code>. In each of these directories, the
6733: configure script is run with the environment
6734: <code class="varname">CONFIGURE_ENV</code> and arguments
6735: <code class="varname">CONFIGURE_ARGS</code>. The variables
6736: <code class="varname">CONFIGURE_ENV</code>,
6737: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6738: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6739: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6740: package.</p>
1.144 wiz 6741: <p>If the program uses the Perl way of configuration (mainly Perl
6742: modules, but not only), i.e. a file called
6743: <code class="filename">Makefile.PL</code>, it should include
6744: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6745: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6746: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6747: <p>If the program uses an <code class="filename">Imakefile</code>
6748: for configuration, the appropriate steps can be invoked by
6749: setting <code class="varname">USE_IMAKE</code> to
1.128 wiz 6750: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.88 wiz 6751: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6752: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6753: xmkmf's environment by adding them to the
6754: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6755: <p>If the program uses <code class="filename">cmake</code>
6756: for configuration, the appropriate steps can be invoked by
1.128 wiz 6757: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6758: You can add variables to cmake's environment by adding them to the
6759: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6760: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6761: The top directory argument is given by the
6762: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6763: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6764: <p>If there is no configure step at all, set
1.128 wiz 6765: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6766: </div>
1.148 asau 6767: <div class="sect1">
1.75 rillig 6768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6769: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6770: <p>For building a package, a rough equivalent of the
6771: following code is executed.</p>
1.75 rillig 6772: <pre class="programlisting">
1.100 rillig 6773: .for d in ${BUILD_DIRS}
6774: cd ${WRKSRC} \
6775: && cd ${d} \
6776: && env ${MAKE_ENV} \
6777: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6778: -f ${MAKE_FILE} \
6779: ${BUILD_TARGET}
6780: .endfor
6781: </pre>
1.88 wiz 6782: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6783: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6784: <code class="varname">WRKSRC</code>. In each of these directories,
6785: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6786: <code class="varname">MAKE_ENV</code> and arguments
6787: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6788: <code class="varname">MAKE_ENV</code>,
6789: <code class="varname">BUILD_MAKE_FLAGS</code>,
6790: <code class="varname">MAKE_FILE</code> and
6791: <code class="varname">BUILD_TARGET</code> may all be changed by the
6792: package.</p>
1.75 rillig 6793: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6794: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6795: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6796: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6797: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6798: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6799: <p>If there is no build step at all, set
1.128 wiz 6800: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6801: </div>
1.148 asau 6802: <div class="sect1">
1.75 rillig 6803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6804: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6805: <p>[TODO]</p>
6806: </div>
1.148 asau 6807: <div class="sect1">
1.75 rillig 6808: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6809: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6810: <p>Once the build stage has completed, the final step is to
1.88 wiz 6811: install the software in public directories, so users can
6812: access the programs and files.</p>
1.75 rillig 6813: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6814: equivalent of the following code is executed. Additionally,
6815: before and after this code, much magic is performed to do
6816: consistency checks, registering the package, and so on.</p>
6817: <pre class="programlisting">
1.100 rillig 6818: .for d in ${INSTALL_DIRS}
6819: cd ${WRKSRC} \
6820: && cd ${d} \
6821: && env ${MAKE_ENV} \
6822: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6823: -f ${MAKE_FILE} \
6824: ${INSTALL_TARGET}
6825: .endfor
6826: </pre>
1.75 rillig 6827: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6828: <span class="emphasis"><em>build</em></span> phase.
6829: <code class="varname">INSTALL_DIRS</code> defaults to
6830: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6831: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6832: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6833: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6834: defined.</p>
1.75 rillig 6835: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6836: variables are useful. They are all variations of the
1.136 dholland 6837: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 6838: permissions preset. <code class="varname">INSTALL</code> is the plain
6839: install command. The specialized variants, together with their
6840: intended use, are:</p>
1.148 asau 6841: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6842: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6843: <dd><p>directories that contain
6844: binaries</p></dd>
1.75 rillig 6845: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6846: <dd><p>directories that contain
6847: scripts</p></dd>
1.75 rillig 6848: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6849: <dd><p>directories that contain shared and static
6850: libraries</p></dd>
1.75 rillig 6851: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6852: <dd><p>directories that contain data
6853: files</p></dd>
1.75 rillig 6854: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6855: <dd><p>directories that contain man
6856: pages</p></dd>
1.75 rillig 6857: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6858: <dd><p>binaries that can be stripped from debugging
6859: symbols</p></dd>
1.75 rillig 6860: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6861: <dd><p>binaries that cannot be
6862: stripped</p></dd>
1.75 rillig 6863: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6864: <dd><p>game
6865: binaries</p></dd>
1.75 rillig 6866: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6867: <dd><p>shared and static
6868: libraries</p></dd>
1.75 rillig 6869: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6870: <dd><p>data files</p></dd>
6871: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6872: <dd><p>data files for
6873: games</p></dd>
1.75 rillig 6874: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6875: <dd><p>man pages</p></dd>
6876: </dl></div>
6877: <p>Some other variables are:</p>
1.148 asau 6878: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6879: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6880: <dd><p>A list of directories relative to
1.88 wiz 6881: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6882: beginning of the <span class="emphasis"><em>install</em></span> phase.
6883: The package is supposed to create all needed directories itself
6884: before installing files to it and list all other directories here.
6885: </p></dd>
1.75 rillig 6886: </dl></div>
1.97 rillig 6887: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6888: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6889: mostly relevant for packages in the <code class="filename">regress</code>
6890: category.</p>
1.75 rillig 6891: </div>
1.148 asau 6892: <div class="sect1">
1.75 rillig 6893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6894: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6895: <p>Once the install stage has completed, a binary package of
6896: the installed files can be built. These binary packages can be
6897: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6898: the <span class="command"><strong>make bin-install</strong></span> or by using
6899: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6900: <p>By default, the binary packages are created in
6901: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6902: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6903: one for each category in the <code class="varname">CATEGORIES</code>
6904: variable. <code class="varname">PACKAGES</code> defaults to
6905: <code class="filename">pkgsrc/packages</code>.</p>
6906: </div>
1.148 asau 6907: <div class="sect1">
1.88 wiz 6908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6909: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 6910: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6911: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6912: to clean the work directories of all dependencies too, use
1.110 hubertf 6913: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6914: </div>
1.148 asau 6915: <div class="sect1">
1.75 rillig 6916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6917: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148 asau 6918: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6919: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6920: <dd><p>For any of the main targets described in the
6921: previous section, two auxiliary targets exist with
1.128 wiz 6922: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.87 wiz 6923: prefix for the main target's name. These targets are
1.88 wiz 6924: invoked before and after the main target is called,
6925: allowing extra configuration or installation steps be
6926: performed from a package's Makefile, for example, which
6927: a program's configure script or install target
6928: omitted.</p></dd>
1.75 rillig 6929: <dt><span class="term">do-*</span></dt>
1.88 wiz 6930: <dd><p>Should one of the main targets do the wrong thing,
6931: and should there be no variable to fix this, you can
6932: redefine it with the do-* target. (Note that redefining
6933: the target itself instead of the do-* target is a bad
6934: idea, as the pre-* and post-* targets won't be called
6935: anymore, etc.) You will not usually need to do
6936: this.</p></dd>
1.75 rillig 6937: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6938: <dd>
1.110 hubertf 6939: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6940: you noticed some file was not installed properly, you
6941: can repeat the installation with this target, which will
1.128 wiz 6942: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6943: <p>This is the default value of
6944: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6945: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6946: package</strong></span>, where the defaults are
1.128 wiz 6947: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6948: respectively.</p>
6949: </dd>
1.75 rillig 6950: <dt><span class="term">deinstall</span></dt>
6951: <dd>
1.136 dholland 6952: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 6953: current directory, effectively de-installing the
6954: package. The following variables can be used to tune the
6955: behaviour:</p>
1.148 asau 6956: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6957: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.136 dholland 6958: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 6959: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6960: <dd><p>Remove all packages that require (depend on)
6961: the given package. This can be used to remove any
6962: packages that may have been pulled in by a given
1.110 hubertf 6963: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6964: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6965: <code class="filename">pkgsrc/x11/kde</code>, this is
6966: likely to remove whole KDE. Works by adding
1.136 dholland 6967: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 6968: command line.</p></dd>
1.75 rillig 6969: </dl></div>
6970: </dd>
1.88 wiz 6971: <dt><span class="term">bin-install</span></dt>
6972: <dd><p>Install a binary package from local disk and via FTP
6973: from a list of sites (see the
6974: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6975: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6976: available anywhere. The arguments given to
1.110 hubertf 6977: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6978: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6979: operation, etc.</p></dd>
1.75 rillig 6980: <dt><span class="term">update</span></dt>
6981: <dd>
1.88 wiz 6982: <p>This target causes the current package to be
6983: updated to the latest version. The package and all
6984: depending packages first get de-installed, then current
6985: versions of the corresponding packages get compiled and
6986: installed. This is similar to manually noting which
6987: packages are currently installed, then performing a
1.110 hubertf 6988: series of <span class="command"><strong>make deinstall</strong></span> and
6989: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 6990: <code class="varname">UPDATE_TARGET</code> is set to) for these
6991: packages.</p>
1.128 wiz 6992: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 6993: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 6994: update</strong></span> was interrupted for some reason.
6995: However, in this case, make sure you don't call
1.110 hubertf 6996: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 6997: list of dependent packages in <code class="varname">WRKDIR</code>.
6998: Otherwise, you lose the ability to automatically update
6999: the current package along with the dependent packages
7000: you have installed.</p>
1.110 hubertf 7001: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7002: update</strong></span> will only work as long as the package
7003: tree remains unchanged. If the source code for one of
7004: the packages to be updated has been changed, resuming
1.110 hubertf 7005: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7006: fail!</p>
7007: <p>The following variables can be used either on the
1.110 hubertf 7008: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7009: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7010: update</strong></span>:</p>
1.148 asau 7011: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7012: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7013: <dd><p>Install target to recursively use for the
7014: updated package and the dependent packages.
7015: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 7016: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 7017: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 7018: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7019: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7020: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 7021: endless loop!</p></dd>
1.75 rillig 7022: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7023: <dd><p>Don't clean up after updating. Useful if
7024: you want to leave the work sources of the updated
7025: packages around for inspection or other purposes.
7026: Be sure you eventually clean up the source tree
1.128 wiz 7027: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 7028: or you may run into troubles with old source code
7029: still lying around on your next
1.110 hubertf 7030: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7031: update</strong></span>.</p></dd>
1.75 rillig 7032: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7033: <dd><p>Deinstall each package before installing
7034: (making <code class="varname">DEPENDS_TARGET</code>). This
7035: may be necessary if the
1.128 wiz 7036: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 7037: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7038: update</strong></span>.</p></dd>
1.75 rillig 7039: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7040: <dd><p>Allows you to disable recursion and hardcode
7041: the target for packages. The default is
1.128 wiz 7042: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 7043: facilitating a recursive update of prerequisite
7044: packages. Only set
7045: <code class="varname">DEPENDS_TARGET</code> if you want to
7046: disable recursive updates. Use
7047: <code class="varname">UPDATE_TARGET</code> instead to just
7048: set a specific target for each package to be
1.110 hubertf 7049: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7050: (see above).</p></dd>
1.75 rillig 7051: </dl></div>
7052: </dd>
7053: <dt><span class="term">clean-update</span></dt>
7054: <dd>
1.88 wiz 7055: <p>Clean the source tree for all packages that would
1.110 hubertf 7056: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7057: from the current directory. This target should not be
7058: used if the current package (or any of its depending
7059: packages) have already been de-installed (e.g., after
1.110 hubertf 7060: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7061: some packages you intended to update. As a rule of
7062: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7063: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7064: and only if you have a dirty package tree (e.g., if you
7065: used <code class="varname">NOCLEAN</code>).</p>
7066: <p>If you are unsure about whether your tree is
1.110 hubertf 7067: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7068: clean</strong></span> at the top of the tree, or use the
7069: following sequence of commands from the directory of the
7070: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7071: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7072: time, otherwise you lose all the packages you wanted to
7073: update!):</p>
1.87 wiz 7074: <pre class="screen">
7075: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7076: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7077: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7078: </pre>
1.88 wiz 7079: <p>The following variables can be used either on the
1.110 hubertf 7080: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7081: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 7082: <div class="variablelist"><dl class="variablelist">
1.75 rillig 7083: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7084: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7085: reconstruct the list of directories to update for
1.110 hubertf 7086: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7087: update</strong></span> successfully installed all
7088: packages you wanted to update. Normally, this is
1.110 hubertf 7089: done automatically on <span class="command"><strong>make
1.88 wiz 7090: update</strong></span>, but may have been suppressed by
7091: the <code class="varname">NOCLEAN</code> variable (see
7092: above).</p></dd>
1.75 rillig 7093: </dl></div>
7094: </dd>
1.88 wiz 7095: <dt><span class="term">replace</span></dt>
7096: <dd>
7097: <p>Update the installation of the current package. This
7098: differs from update in that it does not replace dependent
1.93 rillig 7099: packages. You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88 wiz 7100: target to work.</p>
7101: <p><span class="emphasis"><em>Be careful when using this
7102: target!</em></span> There are no guarantees that dependent
7103: packages will still work, in particular they will most
1.110 hubertf 7104: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7105: library package whose shared library major version changed
7106: between your installed version and the new one. For this
7107: reason, this target is not officially supported and only
7108: recommended for advanced users.</p>
7109: </dd>
1.75 rillig 7110: <dt><span class="term">info</span></dt>
1.136 dholland 7111: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 7112: package. You can use this to check which version of a
7113: package is installed.</p></dd>
7114: <dt><span class="term">index</span></dt>
7115: <dd>
7116: <p>This is a top-level command, i.e. it should be used in
7117: the <code class="filename">pkgsrc</code> directory. It creates a
7118: database of all packages in the local pkgsrc tree, including
7119: dependencies, comment, maintainer, and some other useful
7120: information. Individual entries are created by running
1.110 hubertf 7121: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7122: directories. This index file is saved as
7123: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7124: verbose format by running <span class="command"><strong>make
1.88 wiz 7125: print-index</strong></span>. You can search in it with
1.110 hubertf 7126: <span class="command"><strong>make search
1.88 wiz 7127: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7128: extract a list of all packages that depend on a particular
1.110 hubertf 7129: one by running <span class="command"><strong>make show-deps
1.88 wiz 7130: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7131: <p>Running this command takes a very long time, some
7132: hours even on fast machines!</p>
7133: </dd>
1.75 rillig 7134: <dt><span class="term">readme</span></dt>
1.88 wiz 7135: <dd>
7136: <p>This target generates a
7137: <code class="filename">README.html</code> file, which can be
1.91 rillig 7138: viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.88 wiz 7139: contain references to any packages which are in the
7140: <code class="varname">PACKAGES</code> directory on the local
7141: host. The generated files can be made to refer to URLs
7142: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7143: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7144: wanted to generate <code class="filename">README.html</code>
7145: files which pointed to binary packages on the local
7146: machine, in the directory
7147: <code class="filename">/usr/packages</code>, set
7148: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7149: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7150: <code class="varname">${PACKAGES}</code> directory and its
7151: subdirectories will be searched for all the binary
7152: packages.</p>
7153: <p>The target can be run at the toplevel or in category
7154: directories, in which case it descends recursively.</p>
7155: </dd>
1.75 rillig 7156: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7157: <dd><p>This is a top-level command, run it in
7158: <code class="filename">pkgsrc</code>. Use this target to create a
7159: file <code class="filename">README-all.html</code> which contains a
7160: list of all packages currently available in the NetBSD
7161: Packages Collection, together with the category they belong
7162: to and a short description. This file is compiled from the
7163: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7164: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7165: readme</strong></span>.</p></dd>
1.75 rillig 7166: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7167: <dd><p>This is very much the same as the
1.128 wiz 7168: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 7169: used when generating a pkgsrc tree to be written to a
7170: CD-ROM. This target also produces
7171: <code class="filename">README.html</code> files, and can be made
7172: to refer to URLs based on
7173: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7174: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7175: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7176: <dd><p>This target shows which distfiles and patchfiles
7177: are needed to build the package
7178: (<code class="varname">ALLFILES</code>, which contains all
7179: <code class="varname">DISTFILES</code> and
1.87 wiz 7180: <code class="varname">PATCHFILES</code>, but not
7181: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7182: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7183: <dd><p>This target shows nothing if the package is not
7184: installed. If a version of this package is installed,
7185: but is not the version provided in this version of
7186: pkgsrc, then a warning message is displayed. This target
7187: can be used to show which of your installed packages are
7188: downlevel, and so the old versions can be deleted, and
7189: the current ones added.</p></dd>
1.75 rillig 7190: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7191: <dd><p>This target shows the directory in the pkgsrc
7192: hierarchy from which the package can be built and
7193: installed. This may not be the same directory as the one
7194: from which the package was installed. This target is
7195: intended to be used by people who may wish to upgrade
7196: many packages on a single host, and can be invoked from
7197: the top-level pkgsrc Makefile by using the
1.128 wiz 7198: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 7199: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7200: <dd><p>This target shows which installed packages match
7201: the current package's <code class="varname">DEPENDS</code>. Useful
7202: if out of date dependencies are causing build
7203: problems.</p></dd>
1.75 rillig 7204: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7205: <dd><p>After a package is installed, check all its
7206: binaries and (on ELF platforms) shared libraries to see
7207: if they find the shared libs they need. Run by default
1.110 hubertf 7208: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75 rillig 7209: <dt><span class="term">print-PLIST</span></dt>
7210: <dd>
1.128 wiz 7211: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 7212: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7213: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7214: -newer work/.extract_done</strong></span>. An attempt is made
7215: to care for shared libs etc., but it is
1.87 wiz 7216: <span class="emphasis"><em>strongly</em></span> recommended to review the
7217: result before putting it into
7218: <code class="filename">PLIST</code>. On upgrades, it's useful to
7219: diff the output of this command against an already
7220: existing <code class="filename">PLIST</code> file.</p>
1.136 dholland 7221: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 7222: other methods that don't update file access times, be
7223: sure to add these files manually to your
1.128 wiz 7224: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7225: -newer</span>”</span> command used by this target won't catch
1.87 wiz 7226: them!</p>
1.128 wiz 7227: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.87 wiz 7228: information on this target.</p>
1.75 rillig 7229: </dd>
7230: <dt><span class="term">bulk-package</span></dt>
7231: <dd>
1.88 wiz 7232: <p>Used to do bulk builds. If an appropriate binary
7233: package already exists, no action is taken. If not, this
7234: target will compile, install and package it (and its
7235: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174 asau 7236: 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
7237: builds)</i></a>).
1.88 wiz 7238: After creating the binary package, the sources, the
7239: just-installed package and its required packages are
7240: removed, preserving free disk space.</p>
7241: <p><span class="emphasis"><em>Beware that this target may deinstall
7242: all packages installed on a system!</em></span></p>
1.75 rillig 7243: </dd>
7244: <dt><span class="term">bulk-install</span></dt>
7245: <dd>
1.88 wiz 7246: <p>Used during bulk-installs to install required
7247: packages. If an up-to-date binary package is available,
1.136 dholland 7248: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110 hubertf 7249: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7250: but the installed binary won't be removed.</p>
1.88 wiz 7251: <p>A binary package is considered
1.128 wiz 7252: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.136 dholland 7253: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148 asau 7254: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7255: <li class="listitem"><p>None of the package's files
1.88 wiz 7256: (<code class="filename">Makefile</code>, ...) were modified
7257: since it was built.</p></li>
1.128 wiz 7258: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 7259: packages were modified since it was built.</p></li>
1.75 rillig 7260: </ul></div>
1.88 wiz 7261: <p><span class="emphasis"><em>Beware that this target may deinstall
7262: all packages installed on a system!</em></span></p>
1.75 rillig 7263: </dd>
7264: </dl></div>
7265: </div>
7266: </div>
1.148 asau 7267: <div class="chapter">
1.75 rillig 7268: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7269: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7270: <div class="toc">
7271: <p><b>Table of Contents</b></p>
7272: <dl>
1.106 rillig 7273: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7274: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7275: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7276: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7277: </dl>
7278: </div>
1.87 wiz 7279: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7280: by pkgsrc and also for individual packages to define what commands
7281: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7282: or for later run-time of an installed packaged (such as
7283: <code class="varname">DEPENDS</code>).
7284: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7285: package will not be used.</p>
7286: <p>When building a package, the replacement tools are
1.75 rillig 7287: made available in a directory (as symlinks or wrapper scripts)
7288: that is early in the executable search path. Just like the buildlink
1.87 wiz 7289: system, this helps with consistent builds.</p>
7290: <p>A tool may be needed to help build a specific package. For example,
7291: perl, GNU make (gmake) or yacc may be needed.</p>
7292: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7293: tool may be inefficient for building a package with pkgsrc.
7294: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7295: yacc) or a better sed.</p>
7296: <p>The tools used by a package can be listed by running
1.110 hubertf 7297: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 7298: <div class="sect1">
1.75 rillig 7299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7300: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7301: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7302: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7303: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7304: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7305: These can be seen by running:
1.110 hubertf 7306: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7307: <p>If a package needs a specific program to build
1.75 rillig 7308: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7309: to define the tools needed.</p>
1.75 rillig 7310: </div>
1.148 asau 7311: <div class="sect1">
1.75 rillig 7312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7313: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 7314: <p>In the following examples, the :run means that it is needed at
7315: run-time (and becomes a DEPENDS).
1.75 rillig 7316: The default is a build dependency which can be set with
7317: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7318: and pkg-config:build.)</p>
1.75 rillig 7319: <pre class="programlisting">
7320: USE_TOOLS+= gmake perl:run pkg-config
7321: </pre>
1.87 wiz 7322: <p>When using the tools framework, a
1.75 rillig 7323: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7324: which contains the full path to the appropriate tool. For example,
1.128 wiz 7325: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 7326: on Linux systems.</p>
7327: <p>If you always need a pkgsrc version of the
1.75 rillig 7328: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7329: </p>
7330: </div>
1.148 asau 7331: <div class="sect1">
1.75 rillig 7332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7333: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7334: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7335: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7336: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7337: the name of the common tools. For example:</p>
7338: <pre class="programlisting">
7339: .if exists(/usr/bin/bzcat)
7340: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7341: .elif exists(/usr/bin/bzip2)
7342: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7343: .endif
1.69 rillig 7344:
1.75 rillig 7345: TOOLS_PLATFORM.true?= true # shell builtin
7346: </pre>
7347: </div>
1.148 asau 7348: <div class="sect1">
1.97 rillig 7349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7350: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148 asau 7351: <div class="qandaset">
1.185 jnemeth 7352: <a name="idm75779472"></a><dl>
1.106 rillig 7353: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7354: </dt>
1.106 rillig 7355: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7356: tools?</a>
7357: </dt>
1.106 rillig 7358: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7359: package is using while being built? I want to know whether it
7360: uses sed or not.</a>
7361: </dt>
7362: </dl>
1.148 asau 7363: <table border="0" style="width: 100%;">
7364: <colgroup>
1.97 rillig 7365: <col align="left" width="1%">
1.128 wiz 7366: <col>
1.148 asau 7367: </colgroup>
1.97 rillig 7368: <tbody>
1.148 asau 7369: <tr class="question">
1.97 rillig 7370: <td align="left" valign="top">
1.185 jnemeth 7371: <a name="tools.new"></a><a name="idm75779088"></a><p><b>18.4.1.</b></p>
1.97 rillig 7372: </td>
7373: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7374: </tr>
7375: <tr class="answer">
7376: <td align="left" valign="top"></td>
7377: <td align="left" valign="top"><p>TODO</p></td>
7378: </tr>
1.148 asau 7379: <tr class="question">
1.97 rillig 7380: <td align="left" valign="top">
1.185 jnemeth 7381: <a name="tools.listall"></a><a name="idm75778064"></a><p><b>18.4.2.</b></p>
1.97 rillig 7382: </td>
7383: <td align="left" valign="top"><p>How do I get a list of all available
7384: tools?</p></td>
7385: </tr>
7386: <tr class="answer">
7387: <td align="left" valign="top"></td>
7388: <td align="left" valign="top"><p>TODO</p></td>
7389: </tr>
1.148 asau 7390: <tr class="question">
1.97 rillig 7391: <td align="left" valign="top">
1.185 jnemeth 7392: <a name="tools.used"></a><a name="idm75776912"></a><p><b>18.4.3.</b></p>
1.97 rillig 7393: </td>
7394: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7395: package is using while being built? I want to know whether it
7396: uses sed or not.</p></td>
7397: </tr>
7398: <tr class="answer">
7399: <td align="left" valign="top"></td>
7400: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7401: to do it.)</p></td>
7402: </tr>
7403: </tbody>
7404: </table>
7405: </div>
7406: </div>
1.75 rillig 7407: </div>
1.148 asau 7408: <div class="chapter">
1.75 rillig 7409: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7410: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7411: <div class="toc">
7412: <p><b>Table of Contents</b></p>
7413: <dl>
1.106 rillig 7414: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7415: <dd><dl>
1.106 rillig 7416: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128 wiz 7417: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106 rillig 7418: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7419: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7420: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7421: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7422: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7423: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7424: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7425: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7426: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7427: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7428: </dl></dd>
1.128 wiz 7429: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 7430: <dd><dl>
7431: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7432: <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>
7433: </dl></dd>
1.128 wiz 7434: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106 rillig 7435: <dd><dl>
7436: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7437: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7438: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7439: </dl></dd>
7440: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7441: <dd><dl>
7442: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7443: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7444: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147 wiz 7445: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7446: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106 rillig 7447: </dl></dd>
1.128 wiz 7448: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106 rillig 7449: <dd><dl>
7450: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7451: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128 wiz 7452: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.106 rillig 7453: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7454: </dl></dd>
1.128 wiz 7455: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106 rillig 7456: <dd><dl>
7457: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7458: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7459: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7460: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7461: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7462: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7463: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7464: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7465: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119 mishka 7466: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106 rillig 7467: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7468: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7469: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7470: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7471: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7472: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7473: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7474: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7475: emulation</a></span></dt>
1.106 rillig 7476: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7477: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7478: </dl></dd>
1.106 rillig 7479: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7480: </dl>
7481: </div>
1.148 asau 7482: <div class="sect1">
1.75 rillig 7483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7484: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148 asau 7485: <div class="sect2">
1.75 rillig 7486: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7487: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7488: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7489: different platforms. As a result, it is important to ensure,
7490: where possible, that packages in pkgsrc are portable. This
7491: chapter mentions some particular details you should pay
7492: attention to while working on pkgsrc.</p>
1.78 rillig 7493: </div>
1.148 asau 7494: <div class="sect2">
1.78 rillig 7495: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7496: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 7497: </h3></div></div></div>
1.78 rillig 7498: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7499: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7500: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7501: want to use those variables in the preprocessor directives of
1.136 dholland 7502: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7503: <code class="literal">.for</code>), you need to include the file
7504: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7505: loads the user preferences.</p>
1.78 rillig 7506: <p>But note that some variables may not be completely defined
1.87 wiz 7507: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7508: included, as they may contain references to variables that are
7509: not yet defined. In shell commands this is no problem, since
7510: variables are actually macros, which are only expanded when they
7511: are used. But in the preprocessor directives mentioned above and
7512: in dependency lines (of the form <code class="literal">target:
7513: dependencies</code>) the variables are expanded at load
7514: time.</p>
1.148 asau 7515: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7516: <h3 class="title">Note</h3>
7517: <p>Currently there is no exhaustive list of all
1.87 wiz 7518: variables that tells you whether they can be used at load time
7519: or only at run time, but it is in preparation.</p>
1.78 rillig 7520: </div>
7521: </div>
1.148 asau 7522: <div class="sect2">
1.78 rillig 7523: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7524: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7525: <p>Occasionally, packages require interaction from the user,
7526: and this can be in a number of ways:</p>
1.148 asau 7527: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7528: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7529: interaction such as entering username/password or accepting a
7530: license on a web page.</p></li>
1.128 wiz 7531: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7532: passwords.</p></li>
1.128 wiz 7533: <li class="listitem"><p>help to configure the package before it is built</p></li>
7534: <li class="listitem"><p>help during the build process</p></li>
7535: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7536: </ul></div>
1.88 wiz 7537: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7538: provided to notify the pkgsrc mechanism of an interactive stage
7539: which will be needed, and this should be set in the package's
7540: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7541: <pre class="programlisting">
1.100 rillig 7542: INTERACTIVE_STAGE= build
1.87 wiz 7543: </pre>
1.78 rillig 7544: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7545: <pre class="programlisting">
1.100 rillig 7546: INTERACTIVE_STAGE= configure install
1.87 wiz 7547: </pre>
1.88 wiz 7548: <p>The user can then decide to skip this package by setting the
7549: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7550: </div>
1.148 asau 7551: <div class="sect2">
1.75 rillig 7552: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7553: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7554: <p>Authors of software can choose the licence under which
7555: software can be copied. This is due to copyright law, and reasons
7556: for license choices are outside the scope of pkgsrc. The pkgsrc
7557: system recognizes that there are a number of licenses which some
7558: users may find objectionable or difficult or impossible to comply
7559: with. The Free Software Foundation has declared some licenses
7560: "Free", and the Open Source Initiative has a definition of "Open
7561: Source". The pkgsrc system, as a policy choice, does not label
7562: packages which have licenses that are Free or Open Source.
7563: However, packages without a license meeting either of those tests
7564: are labeled with a license tag denoting the license. Note that a
7565: package with no license to copy trivially does not meet either the
7566: Free or Open Source test.</p>
7567: <p>For packages which are not Free or Open Source, pkgsrc will
7568: not build the package unless the user has indicated to pkgsrc that
7569: packages with that particular license may be built. Note that
7570: this documentation avoids the term "accepted the license". The
7571: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7572: accidentally building a package with a non-free license;
1.98 wiz 7573: judgement and responsibility remain with the user. (Installation
7574: of binary packages are not currently subject to this mechanism;
7575: this is a bug.)</p>
7576: <p>One might want to only install packages with a BSD license,
1.121 jnemeth 7577: or the GPL, and not the other. The free licenses are added to the
7578: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7579: user can override the default by setting the
7580: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7581: of "+=". The licenses accepted by default are:
7582: </p>
7583: <pre class="programlisting">
1.154 rodent 7584: apache-1.1 apache-2.0
7585: arphic-public
7586: artistic artistic-2.0
7587: boost-license
7588: cc-by-sa-v3.0
1.161 ryoon 7589: cc0-1.0-universal
1.154 rodent 7590: cddl-1.0
7591: cpl-1.0
7592: epl-v1.0
7593: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7594: gnu-gpl-v1
7595: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7596: gnu-gpl-v3 gnu-lgpl-v3
7597: ibm-public-license-1.0
7598: ipafont
7599: isc
7600: lppl-1.3c
7601: lucent
7602: miros
7603: mit
7604: mpl-1.0 mpl-1.1 mpl-2.0
7605: mplusfont
7606: ofl-v1.0 ofl-v1.1
7607: original-bsd modified-bsd 2-clause-bsd
7608: php
7609: png-license
7610: postgresql-license
7611: public-domain
7612: python-software-foundation
7613: qpl-v1.0
1.158 rodent 7614: sgi-free-software-b-v2.0
1.154 rodent 7615: sleepycat-public
7616: unlicense
7617: x11
7618: zlib
7619: zpl
1.121 jnemeth 7620: </pre>
7621: <p>
7622: </p>
1.78 rillig 7623: <p>The license tag mechanism is intended to address
1.87 wiz 7624: copyright-related issues surrounding building, installing and
7625: using a package, and not to address redistribution issues (see
7626: <code class="varname">RESTRICTED</code> and
1.121 jnemeth 7627: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7628: Packages with redistribution restrictions should set these
7629: tags.</p>
1.98 wiz 7630: <p>Denoting that a package may be copied according to a
7631: particular license is done by placing the license in
1.87 wiz 7632: <code class="filename">pkgsrc/licenses</code> and setting the
7633: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7634: license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87 wiz 7635: <pre class="programlisting">
1.100 rillig 7636: LICENSE= xv-license
1.87 wiz 7637: </pre>
7638: <p>When trying to build, the user will get a notice that the
1.98 wiz 7639: package is covered by a license which has not been placed in the
7640: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7641: <pre class="programlisting">
1.100 rillig 7642: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7643: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7644: ===> To view the license, enter "/usr/bin/make show-license".
7645: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7646: ===> ACCEPTABLE_LICENSES+=xv-license
7647: *** Error code 1
1.87 wiz 7648: </pre>
1.110 hubertf 7649: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7650: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7651: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7652: convey to pkgsrc that it should not in the future fail because of
7653: that license:</p>
1.78 rillig 7654: <pre class="programlisting">
1.100 rillig 7655: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7656: </pre>
1.154 rodent 7657: <p>When adding a package with a new license, the following steps
7658: are required:</p>
7659: <div class="orderedlist"><ol class="orderedlist" type="1">
7660: <li class="listitem">
7661: <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>
7662: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7663: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7664: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.158 rodent 7665: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154 rodent 7666: </ul></div>
7667: <p>with the proper syntax as demonstrated in those files, respectively.</p>
7668: </li>
7669: <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>
7670: </ol></div>
1.98 wiz 7671: <p>When the license changes (in a way other than formatting),
7672: please make sure that the new license has a different name (e.g.,
7673: append the version number if it exists, or the date). Just
7674: because a user told pkgsrc to build programs under a previous
7675: version of a license does not mean that pkgsrc should build
1.99 rillig 7676: programs under the new licenses. The higher-level point is that
1.98 wiz 7677: pkgsrc does not evaluate licenses for reasonableness; the only
7678: test is a mechanistic test of whether a particular text has been
7679: approved by either of two bodies.</p>
1.78 rillig 7680: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7681: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7682: is deprecated because it does not crisply refer to a particular
7683: license text. Another problem with such usage is that it does not
7684: enable a user to tell pkgsrc to proceed for a single package
7685: without also telling pkgsrc to proceed for all packages with that
7686: tag.</p>
1.75 rillig 7687: </div>
1.148 asau 7688: <div class="sect2">
1.75 rillig 7689: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7690: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7691: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7692: Because a license tag is required unless the package is Free or
7693: Open Source, all packages with restrictions should have license
7694: tags. By declaring the restrictions, package tools can
7695: automatically refrain from e.g. placing binary packages on FTP
7696: sites.</p>
7697: <p>There are four restrictions that may be encoded, which are
7698: the cross product of sources (distfiles) and binaries not being
7699: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7700: language in any license, and because non-Free licenses tend to be
7701: different from each other, pkgsrc adopts a definition of FTP and
7702: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7703: should not be made available over the Internet at no charge.
7704: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7705: made available on some kind of media, together with other source
7706: and binary packages, and which is sold for a distribution charge.
7707: </p>
7708: <p>In order to encode these restrictions, the package system
1.87 wiz 7709: defines five make variables that can be set to note these
7710: restrictions:</p>
1.148 asau 7711: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7712: <li class="listitem">
1.75 rillig 7713: <p><code class="varname">RESTRICTED</code></p>
7714: <p>This variable should be set whenever a restriction
1.87 wiz 7715: exists (regardless of its kind). Set this variable to a
1.98 wiz 7716: string containing the reason for the restriction. It should
7717: be understood that those wanting to understand the restriction
7718: will have to read the license, and perhaps seek advice of
7719: counsel.</p>
1.75 rillig 7720: </li>
1.128 wiz 7721: <li class="listitem">
1.75 rillig 7722: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7723: <p>Binaries may not be placed on CD-ROM containing other
7724: binary packages, for which a distribution charge may be made.
7725: In this case, set this variable to
7726: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7727: </li>
1.128 wiz 7728: <li class="listitem">
1.75 rillig 7729: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7730: <p>Binaries may not made available on the Internet without
7731: charge. In this case, set this variable to
7732: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7733: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7734: </li>
1.128 wiz 7735: <li class="listitem">
1.75 rillig 7736: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7737: <p>Distfiles may not be placed on CD-ROM, together with
7738: other distfiles, for which a fee may be charged. In this
7739: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7740: </p>
1.75 rillig 7741: </li>
1.128 wiz 7742: <li class="listitem">
1.75 rillig 7743: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7744: <p>Distfiles may not made available via FTP at no charge.
7745: In this case, set this variable to
7746: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7747: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7748: </li>
7749: </ul></div>
1.139 wiz 7750: <p>Please note that packages will to be removed from pkgsrc
7751: when the distfiles are not distributable and cannot be obtained
7752: for a period of one full quarter branch. Packages with manual /
7753: interactive fetch must have a maintainer and it is his/her
7754: responsibility to ensure this.</p>
1.75 rillig 7755: </div>
1.148 asau 7756: <div class="sect2">
1.75 rillig 7757: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7758: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7759: <p>Your package may depend on some other package being present
1.88 wiz 7760: - and there are various ways of expressing this dependency.
7761: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7762: <code class="varname">DEPENDS</code> definitions, the
7763: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7764: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7765: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7766: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7767: <p>The basic difference between the two variables is as
1.87 wiz 7768: follows: The <code class="varname">DEPENDS</code> definition registers
7769: that pre-requisite in the binary package so it will be pulled in
7770: when the binary package is later installed, whilst the
7771: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7772: dependency that is only needed for building the package.</p>
1.75 rillig 7773: <p>This means that if you only need a package present whilst
1.87 wiz 7774: you are building, it should be noted as a
7775: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7776: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7777: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7778: <pre class="programlisting">
1.100 rillig 7779: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7780: </pre>
1.128 wiz 7781: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7782: may include any of the wildcard version numbers recognized by
1.136 dholland 7783: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7784: <div class="orderedlist"><ol class="orderedlist" type="1">
7785: <li class="listitem">
1.75 rillig 7786: <p>If your package needs another package's binaries or
1.160 wiz 7787: libraries to build and run, and if that package has a
1.87 wiz 7788: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7789: <pre class="programlisting">
1.100 rillig 7790: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7791: </pre>
1.75 rillig 7792: </li>
1.128 wiz 7793: <li class="listitem">
1.160 wiz 7794: <p>If your package needs another package's binaries or
7795: libraries only for building, and if that package has a
7796: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7797: <pre class="programlisting">
7798: .include "../../graphics/jpeg/buildlink3.mk"
7799: </pre>
7800: <p>but set
7801: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7802: to make it a build dependency only. This case is rather
7803: rare.</p>
7804: </li>
7805: <li class="listitem">
1.132 spz 7806: <p>If your package needs binaries from another package to build,
7807: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75 rillig 7808: <pre class="programlisting">
1.132 spz 7809: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87 wiz 7810: </pre>
1.75 rillig 7811: </li>
1.132 spz 7812: <li class="listitem"><p>If your package needs a library with which to link and
7813: there is no <code class="filename">buildlink3.mk</code> file
7814: available, create one. Using
7815: <code class="varname">DEPENDS</code> won't be sufficient because the
7816: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7817: <li class="listitem">
1.132 spz 7818: <p>If your package needs some executable to be able to run
7819: correctly and if there's no
7820: <code class="filename">buildlink3.mk</code> file, this is specified
7821: using the <code class="varname">DEPENDS</code> variable. The
7822: <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
7823: be able to execute the latex binary from the teTeX package
7824: when it runs, and that is specified:</p>
1.75 rillig 7825: <pre class="programlisting">
1.132 spz 7826: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7827: </pre>
1.132 spz 7828: </li>
7829: <li class="listitem">
7830: <p>You can use wildcards in package dependencies. Note that
7831: such wildcard dependencies are retained when creating binary
7832: packages. The dependency is checked when installing the binary
7833: package and any package which matches the pattern will be
7834: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7835: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7836: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7837: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7838: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7839: <p>Wildcards can also be used to specify that a package
1.87 wiz 7840: will only build against a certain minimum version of a
7841: pre-requisite:</p>
1.75 rillig 7842: <pre class="programlisting">
1.132 spz 7843: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.87 wiz 7844: </pre>
1.132 spz 7845: <p>This means that the package will build using version 6.0
7846: of ImageMagick or newer. Such a dependency may be warranted
7847: if, for example, the command line options of an executable
7848: have changed.</p>
7849: <p>If you need to depend on minimum versions of libraries,
7850: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7851: <p>For security fixes, please update the package
1.110 hubertf 7852: vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, “Handling packages with security problems”</a> for more
1.87 wiz 7853: information.</p>
1.75 rillig 7854: </li>
1.165 bsiegert 7855: <li class="listitem">
7856: <p>If the package depends on either one of two (or more)
7857: packages, specify the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span> as a
7858: comma-separated list between curly braces.</p>
7859: <p>As an example, take a package that depends on the Perl
7860: <span class="quote">“<span class="quote">version</span>”</span> module, which has been part of Perl
7861: itself since version 5.10.0. This either/or dependency is
7862: expressed as:</p>
7863: <pre class="programlisting">
7864: DEPENDS+= {perl>=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
7865: </pre>
7866: </li>
1.75 rillig 7867: </ol></div>
7868: <p>If your package needs files from another package to build,
1.87 wiz 7869: add the relevant distribution files to
7870: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 7871: automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87 wiz 7872: (It relies on the jpeg sources being present in source form
7873: during the build.)</p>
1.75 rillig 7874: </div>
1.148 asau 7875: <div class="sect2">
1.75 rillig 7876: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7877: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7878: <p>Your package may conflict with other packages a user might
1.87 wiz 7879: already have installed on his system, e.g. if your package
1.88 wiz 7880: installs the same set of files as another package in the pkgsrc
7881: tree.</p>
1.75 rillig 7882: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7883: space-separated list of packages (including version string) your
7884: package conflicts with.</p>
1.91 rillig 7885: <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>
7886: 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>
1.87 wiz 7887: install the same shared library, thus you set in
7888: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7889: <pre class="programlisting">
1.100 rillig 7890: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 7891: </pre>
7892: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7893: <pre class="programlisting">
1.100 rillig 7894: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 7895: </pre>
1.75 rillig 7896: <p>Packages will automatically conflict with other packages
1.87 wiz 7897: with the name prefix and a different version
1.128 wiz 7898: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
7899: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.75 rillig 7900: </div>
1.148 asau 7901: <div class="sect2">
1.75 rillig 7902: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7903: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7904: <p>There are several reasons why a package might be
1.88 wiz 7905: instructed to not build under certain circumstances. If the
1.87 wiz 7906: package builds and runs on most platforms, the exceptions
7907: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7908: the package builds and runs on a small handful of platforms,
7909: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7910: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7911: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7912: (OS-version-platform) that can use glob-style
7913: wildcards.</p>
1.88 wiz 7914: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 7915: operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.88 wiz 7916: backwards compatible with other versions of the OS, and should be
7917: uploaded to a version specific directory on the FTP server. Mark
7918: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7919: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7920: the package system internals, but may be used in the
7921: future.</p>
1.75 rillig 7922: <p>If the package should be skipped (for example, because it
1.87 wiz 7923: provides functionality already provided by the system), set
1.88 wiz 7924: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7925: the package should fail because some preconditions are not met,
7926: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7927: message.</p>
1.75 rillig 7928: </div>
1.148 asau 7929: <div class="sect2">
1.75 rillig 7930: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7931: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7932: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7933: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7934: be set in the package Makefile. This will be carried into any
7935: binary package that is made from this pkgsrc entry. A
1.128 wiz 7936: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.136 dholland 7937: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7938: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7939: </div>
1.148 asau 7940: <div class="sect2">
1.75 rillig 7941: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7942: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7943: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7944: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7945: and after committing that file, ask pkgsrc-security@NetBSD.org to
7946: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7947: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7948: <code class="varname">PKGREVISION</code> should be increased (this is of
7949: course not necessary if the problem is fixed by using a newer
7950: release of the software), and the pattern in the
7951: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7952: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7953: branch, be sure to submit a pullup request!</p>
1.75 rillig 7954: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7955: semi-automatically by a weekly cron job.</p>
1.75 rillig 7956: </div>
1.148 asau 7957: <div class="sect2">
1.75 rillig 7958: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7959: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 7960: <p>When making fixes to an existing package it can be useful
1.87 wiz 7961: to change the version number in <code class="varname">PKGNAME</code>. To
7962: avoid conflicting with future versions by the original author, a
1.128 wiz 7963: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 7964: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7965: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7966: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7967: <pre class="programlisting">
1.100 rillig 7968: DISTNAME= foo-17.42
7969: PKGREVISION= 9
1.87 wiz 7970: </pre>
1.75 rillig 7971: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7972: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7973: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7974: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7975: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7976: <p>When a new release of the package is released, the
1.87 wiz 7977: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7978: minor release of the above package, things should be like:</p>
1.75 rillig 7979: <pre class="programlisting">
1.100 rillig 7980: DISTNAME= foo-17.43
1.87 wiz 7981: </pre>
7982: <p><code class="varname">PKGREVISION</code> should be incremented for any
7983: non-trivial change in the resulting binary package. Without a
7984: <code class="varname">PKGREVISION</code> bump, someone with the previous
7985: version installed has no way of knowing that their package is out
7986: of date. Thus, changes without increasing
7987: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7988: trivial that no reasonable person would want to upgrade", and this
7989: is the rough test for when increasing
7990: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7991: changes that do not merit increasing
7992: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7993: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7994: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 7995: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 7996: or comments in Makefile.</p></li>
1.128 wiz 7997: <li class="listitem"><p>
1.100 rillig 7998: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 7999: <li class="listitem"><p>
1.100 rillig 8000: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 8001: <li class="listitem"><p>
1.100 rillig 8002: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8003: </ul></div>
1.87 wiz 8004: <p>Examples of changes that do merit an increase to
8005: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 8006: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8007: <li class="listitem"><p>
1.100 rillig 8008: Security fixes</p></li>
1.128 wiz 8009: <li class="listitem"><p>
1.100 rillig 8010: Changes or additions to a patch file</p></li>
1.128 wiz 8011: <li class="listitem"><p>
1.100 rillig 8012: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 8013: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8014: </ul></div>
1.78 rillig 8015: <p>PKGREVISION must also be incremented when dependencies have ABI
8016: changes.</p>
1.75 rillig 8017: </div>
1.148 asau 8018: <div class="sect2">
1.79 rillig 8019: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8020: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 8021: <p>When you want to replace the same text in multiple files
1.87 wiz 8022: or when the replacement text varies, patches alone cannot help.
8023: This is where the SUBST framework comes in. It provides an
8024: easy-to-use interface for replacing text in files.
8025: Example:</p>
8026: <pre class="programlisting">
1.100 rillig 8027: SUBST_CLASSES+= fix-paths
8028: SUBST_STAGE.fix-paths= pre-configure
8029: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8030: SUBST_FILES.fix-paths= src/*.c
8031: SUBST_FILES.fix-paths+= scripts/*.sh
8032: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8033: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8034: </pre>
1.79 rillig 8035: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8036: that are used to identify the different SUBST blocks that are
8037: defined. The SUBST framework is heavily used by pkgsrc, so it is
8038: important to always use the <code class="literal">+=</code> operator with
8039: this variable. Otherwise some substitutions may be
8040: skipped.</p>
1.79 rillig 8041: <p>The remaining variables of each SUBST block are
1.87 wiz 8042: parameterized with the identifier from the first line
8043: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8044: parameters to a function call.</p>
1.79 rillig 8045: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8046: which the replacement will take place. All combinations of
8047: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8048: <code class="literal">post-</code> together with a phase name are
8049: possible, though only few are actually used. Most commonly used
8050: are <code class="literal">post-patch</code> and
8051: <code class="literal">pre-configure</code>. Of these two,
8052: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8053: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8054: have the state after applying the patches but before making any
8055: other changes. This is especially useful when you are debugging
8056: a package in order to create new patches for it. Similarly,
8057: <code class="literal">post-build</code> is preferred over
8058: <code class="literal">pre-install</code>, because the install phase should
8059: generally be kept as simple as possible. When you use
8060: <code class="literal">post-build</code>, you have the same files in the
8061: working directory that will be installed later, so you can check
8062: if the substitution has succeeded.</p>
1.79 rillig 8063: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8064: that is printed just before the substitution is done.</p>
1.79 rillig 8065: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8066: globbing patterns that specifies the files in which the
8067: substitution will take place. The patterns are interpreted
8068: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8069: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.136 dholland 8070: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87 wiz 8071: command should be prefixed with <code class="literal">-e</code>, so that
8072: all SUBST blocks look uniform.</p>
1.79 rillig 8073: <p>There are some more variables, but they are so seldomly
1.87 wiz 8074: used that they are only documented in the
8075: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8076: </div>
1.75 rillig 8077: </div>
1.148 asau 8078: <div class="sect1">
1.75 rillig 8079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8080: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8081: <div class="sect2">
1.75 rillig 8082: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8083: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8084: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8085: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8086: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8087: with the name of each file to download as an argument, expecting
8088: it to output the URL of the directory from which to download
1.91 rillig 8089: it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87 wiz 8090: example of this usage.</p>
1.75 rillig 8091: <p>If the download can't be automated, because the user must
1.87 wiz 8092: submit personal information to apply for a password, or must pay
8093: for the source, or whatever, you can set
8094: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8095: displayed to the user before aborting the build. Example:</p>
8096: <pre class="programlisting">
1.100 rillig 8097: FETCH_MESSAGE= "Please download the files"
8098: FETCH_MESSAGE+= " "${DISTFILES:Q}
8099: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8100: </pre>
1.75 rillig 8101: </div>
1.148 asau 8102: <div class="sect2">
1.75 rillig 8103: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8104: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8105: <p>Sometimes authors of a software package make some
1.87 wiz 8106: modifications after the software was released, and they put up a
8107: new distfile without changing the package's version number. If a
8108: package is already in pkgsrc at that time, the checksum will
8109: no longer match. The contents of the new distfile should be
8110: compared against the old one before changing anything, to make
8111: sure the distfile was really updated on purpose, and that
8112: no trojan horse or so crept in.
1.97 rillig 8113: Please mention that the distfiles were compared and what was found
1.159 rodent 8114: in your commit message.</p>
8115: <p>Then, the correct way to work around this is to
1.87 wiz 8116: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8117: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8118: <code class="varname">DISTFILES</code> and
1.93 rillig 8119: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8120: subdirectory of the local distfiles directory.
1.110 hubertf 8121: (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
1.97 rillig 8122: In case this
1.87 wiz 8123: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8124: including the <code class="filename">nbX</code> suffix) or a date stamp
1.159 rodent 8125: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8126: <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>
8127: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8128: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8129: path in the filenames.
1.159 rodent 8130: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8131: Furthermore, a mail to the package's authors seems appropriate
8132: telling them that changing distfiles after releases without
8133: changing the file names is not good practice.</p>
1.75 rillig 8134: </div>
8135: </div>
1.148 asau 8136: <div class="sect1">
1.75 rillig 8137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8138: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8139: <div class="sect2">
1.75 rillig 8140: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8141: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8142: <p>pkgsrc supports many different machines, with different
1.87 wiz 8143: object formats like a.out and ELF, and varying abilities to do
8144: shared library and dynamic loading at all. To accompany this,
8145: varying commands and options have to be passed to the
8146: compiler, linker, etc. to get the Right Thing, which can be
8147: pretty annoying especially if you don't have all the machines
8148: at your hand to test things. The
1.91 rillig 8149: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128 wiz 8150: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8151: both static and dynamic libraries from a set of source files,
8152: thus being platform-independent.</p>
8153: <p>Here's how to use libtool in a package in seven simple
8154: steps:</p>
1.128 wiz 8155: <div class="orderedlist"><ol class="orderedlist" type="1">
8156: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8157: Makefile.</p></li>
1.128 wiz 8158: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8159: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8160: add it to the definition of <code class="varname">CC</code>, if only
8161: libraries are being built in a given Makefile. This one command
8162: will build both PIC and non-PIC library objects, so you need not
8163: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8164: <li class="listitem">
1.75 rillig 8165: <p>For the linking of the library, remove any
1.128 wiz 8166: <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
8167: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8168: <pre class="programlisting">
1.100 rillig 8169: ${LIBTOOL} --mode=link \
8170: ${CC} -o ${.TARGET:.a=.la} \
8171: ${OBJS:.o=.lo} \
8172: -rpath ${PREFIX}/lib \
8173: -version-info major:minor
1.87 wiz 8174: </pre>
1.75 rillig 8175: <p>Note that the library is changed to have a
1.87 wiz 8176: <code class="filename">.la</code> extension, and the objects are
8177: changed to have a <code class="filename">.lo</code>
8178: extension. Change <code class="varname">OBJS</code> as
8179: necessary. This automatically creates all of the
8180: <code class="filename">.a</code>,
8181: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8182: necessary) in the build directory. Be sure to include
1.128 wiz 8183: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8184: minor are zero, as libtool will otherwise strip off the
8185: shared library version.</p>
1.75 rillig 8186: <p>From the libtool manual:</p>
8187: <pre class="programlisting">
1.100 rillig 8188: So, libtool library versions are described by three integers:
1.69 rillig 8189:
1.100 rillig 8190: CURRENT
8191: The most recent interface number that this library implements.
1.69 rillig 8192:
1.100 rillig 8193: REVISION
8194: The implementation number of the CURRENT interface.
1.69 rillig 8195:
1.100 rillig 8196: AGE
8197: The difference between the newest and oldest interfaces that
8198: this library implements. In other words, the library implements
8199: all the interface numbers in the range from number `CURRENT -
8200: AGE' to `CURRENT'.
1.1 grant 8201:
1.100 rillig 8202: If two libraries have identical CURRENT and AGE numbers, then the
8203: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8204: </pre>
1.128 wiz 8205: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8206: different results for a.out and ELF (excluding symlinks)
8207: in only one case. An ELF library of the form
1.128 wiz 8208: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8209: will have a symlink of
1.128 wiz 8210: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8211: on an a.out platform. This is handled
8212: automatically.</p>
1.128 wiz 8213: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8214: directory of the library being built.</p>
1.76 rillig 8215: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8216: <code class="filename">.la</code> file, the other files will be
8217: added automatically.</p>
1.75 rillig 8218: </li>
1.128 wiz 8219: <li class="listitem">
1.76 rillig 8220: <p>When linking shared object (<code class="filename">.so</code>)
1.136 dholland 8221: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8222: shared libraries, use <span class="quote">“<span class="quote">-module
8223: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8224: tacked on.</p>
1.76 rillig 8225: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8226: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8227: </li>
1.128 wiz 8228: <li class="listitem">
1.75 rillig 8229: <p>When linking programs that depend on these libraries
1.87 wiz 8230: <span class="emphasis"><em>before</em></span> they are installed, preface
1.136 dholland 8231: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8232: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8233: libraries (static or shared), but please be aware that
8234: libtool will not allow you to specify a relative path in
1.128 wiz 8235: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8236: expects you to change that argument to be the
8237: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8238: <pre class="programlisting">
1.100 rillig 8239: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8240: </pre>
1.75 rillig 8241: <p>should be changed to:</p>
8242: <pre class="programlisting">
1.100 rillig 8243: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8244: </pre>
1.75 rillig 8245: <p>and it will do the right thing with the libraries.</p>
8246: </li>
1.128 wiz 8247: <li class="listitem">
1.136 dholland 8248: <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>
8249: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8250: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8251: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8252: <pre class="programlisting">
1.126 jakllsch 8253: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8254: </pre>
1.76 rillig 8255: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8256: shared library, any needed symlinks, and run
1.136 dholland 8257: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8258: </li>
1.128 wiz 8259: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8260: the <code class="filename">.la</code>
8261: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8262: </ol></div>
8263: </div>
1.148 asau 8264: <div class="sect2">
1.75 rillig 8265: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8266: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8267: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8268: package Makefile. This will override the package's own libtool
8269: in most cases. For older libtool using packages, libtool is
8270: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8271: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8272: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8273: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8274: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8275: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8276: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8277: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8278: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8279: libraries built and installed, then use
8280: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8281: <p>If your package makes use of the platform-independent library
1.87 wiz 8282: for loading dynamic shared objects, that comes with libtool
8283: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8284: <p>Some packages use libtool incorrectly so that the package
8285: may not work or build in some circumstances. Some of the more
8286: common errors are:</p>
1.148 asau 8287: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8288: <li class="listitem">
1.75 rillig 8289: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8290: executable or library. This in itself isn't a problem if one of two things
8291: has been done:</p>
1.128 wiz 8292: <div class="orderedlist"><ol class="orderedlist" type="1">
8293: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8294: <code class="filename">libfoo.la</code>, not
8295: <code class="filename">foo.la</code></p></li>
1.128 wiz 8296: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8297: </ol></div>
8298: </li>
1.128 wiz 8299: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8300: The function lt_dlinit() should be called and the macro
8301: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8302: executables.</p></li>
1.75 rillig 8303: </ul></div>
8304: </div>
1.148 asau 8305: <div class="sect2">
1.75 rillig 8306: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8307: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8308: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8309: to regenerate the configure script and Makefile.in makefile
8310: templates, then they should be executed in a pre-configure
8311: target.</p>
1.75 rillig 8312: <p>For packages that need only autoconf:</p>
8313: <pre class="programlisting">
1.100 rillig 8314: AUTOCONF_REQD= 2.50 # if default version is not good enough
8315: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8316: ...
1.1 grant 8317:
1.100 rillig 8318: pre-configure:
8319: cd ${WRKSRC} && autoconf
1.1 grant 8320:
1.100 rillig 8321: ...
1.87 wiz 8322: </pre>
1.75 rillig 8323: <p>and for packages that need automake and autoconf:</p>
8324: <pre class="programlisting">
1.100 rillig 8325: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8326: USE_TOOLS+= automake # use "automake14" for automake-1.4
8327: ...
8328:
8329: pre-configure:
8330: set -e; cd ${WRKSRC}; \
8331: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8332:
1.100 rillig 8333: ...
1.87 wiz 8334: </pre>
1.75 rillig 8335: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8336: require GNU Make.</p>
1.75 rillig 8337: <p>There are times when the configure process makes
1.87 wiz 8338: additional changes to the generated files, which then causes
8339: the build process to try to re-execute the automake sequence.
8340: This is prevented by touching various files in the configure
8341: stage. If this causes problems with your package you can set
8342: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8343: Makefile.</p>
1.75 rillig 8344: </div>
8345: </div>
1.148 asau 8346: <div class="sect1">
1.75 rillig 8347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8348: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148 asau 8349: <div class="sect2">
1.87 wiz 8350: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8351: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8352: <p>Compilers for the C, C++, and Fortran languages comes with
8353: the NetBSD base system. By default, pkgsrc assumes that a package
8354: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8355: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8356: <p>To declare which language's compiler a package needs, set
8357: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8358: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8359: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8360: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8361: written in C++, usually need a C compiler for the configure
8362: phase.</p>
8363: </div>
1.148 asau 8364: <div class="sect2">
1.87 wiz 8365: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8366: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8367: <p>If a program is written in Java, use the Java framework in
8368: pkgsrc. The package must include
8369: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8370: provides the following variables:</p>
1.148 asau 8371: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8372: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8373: dependency on the JDK is added. If
1.128 wiz 8374: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8375: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8376: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8377: JDK.</p></li>
1.128 wiz 8378: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8379: a package needs a Java2 implementation. The supported values
1.128 wiz 8380: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8381: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8382: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8383: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8384: above. This variable is not set by default.</p></li>
1.130 wiz 8385: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8386: automatically set to the runtime location of the used Java
8387: implementation dependency. It may be used to set
8388: <code class="varname">JAVA_HOME</code> to a good value if the program
8389: needs this variable to be defined.
8390: </p></li>
1.87 wiz 8391: </ul></div>
8392: </div>
1.148 asau 8393: <div class="sect2">
1.87 wiz 8394: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8395: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8396: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8397: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8398: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8399: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8400: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8401: that you want adjusted. Every occurrence of
8402: <code class="filename">*/bin/perl</code> in a she-bang line will be
8403: replaced with the full path to the perl executable.</p>
1.87 wiz 8404: <p>If a particular version of perl is needed, set the
8405: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8406: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.110 hubertf 8407: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.87 wiz 8408: about handling perl modules.</p>
8409: </div>
1.148 asau 8410: <div class="sect2">
1.87 wiz 8411: <div class="titlepage"><div><div><h3 class="title">
1.147 wiz 8412: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8413: <p><code class="varname">REPLACE_SH</code>,
8414: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8415: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8416: hash bangs in files. Please use the appropriate one, prefering
8417: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8418: Each should contain a list of scripts, relative to
8419: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8420: occurrence of the matching shell in a she-bang line will be
8421: replaced with the full path to the shell executable.
1.147 wiz 8422: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8423: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8424: </div>
1.148 asau 8425: <div class="sect2">
1.147 wiz 8426: <div class="titlepage"><div><div><h3 class="title">
8427: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8428: <p>Currently, there is no special handling for other languages
8429: in pkgsrc. If a compiler package provides a
8430: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8431: just add a (build) dependency on the appropriate compiler
8432: package.</p>
8433: </div>
8434: </div>
1.148 asau 8435: <div class="sect1">
1.87 wiz 8436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8437: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8438: <p>The most common failures when building a package are that
8439: some platforms do not provide certain header files, functions or
8440: libraries, or they provide the functions in a library that the
8441: original package author didn't know. To work around this, you
8442: can rewrite the source code in most cases so that it does not
8443: use the missing functions or provides a replacement function.</p>
1.148 asau 8444: <div class="sect2">
1.77 rillig 8445: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8446: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8447: <p>If a package already comes with a GNU configure script, the
8448: preferred way to fix the build failure is to change the
8449: configure script, not the code. In the other cases, you can
8450: utilize the C preprocessor, which defines certain macros
8451: depending on the operating system and hardware architecture it
8452: compiles for. These macros can be queried using for example
8453: <code class="varname">#if defined(__i386)</code>. Almost every operating
8454: system, hardware architecture and compiler has its own macro.
8455: For example, if the macros <code class="varname">__GNUC__</code>,
8456: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8457: are all defined, you know that you are using NetBSD on an i386
8458: compatible CPU, and your compiler is GCC.</p>
8459: <p>The list of the following macros for hardware and
8460: operating system depends on the compiler that is used. For
8461: example, if you want to conditionally compile code on Solaris,
8462: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8463: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8464: <div class="sect3">
1.75 rillig 8465: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8466: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8467: <p>To distinguish between 4.4 BSD-derived systems and the
8468: rest of the world, you should use the following code.</p>
8469: <pre class="programlisting">
1.100 rillig 8470: #include <sys/param.h>
8471: #if (defined(BSD) && BSD >= 199306)
8472: /* BSD-specific code goes here */
8473: #else
8474: /* non-BSD-specific code goes here */
8475: #endif
1.75 rillig 8476: </pre>
1.77 rillig 8477: <p>If this distinction is not fine enough, you can also test
8478: for the following macros.</p>
1.75 rillig 8479: <pre class="programlisting">
1.151 obache 8480: Cygwin __CYGWIN__
8481: DragonFly __DragonFly__
1.100 rillig 8482: FreeBSD __FreeBSD__
1.151 obache 8483: Haiku __HAIKU__
1.100 rillig 8484: Interix __INTERIX
8485: IRIX __sgi (TODO: get a definite source for this)
8486: Linux linux, __linux, __linux__
1.151 obache 8487: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8488: Minix3 __minix
1.100 rillig 8489: NetBSD __NetBSD__
8490: OpenBSD __OpenBSD__
8491: Solaris sun, __sun
1.75 rillig 8492: </pre>
8493: </div>
1.148 asau 8494: <div class="sect3">
1.75 rillig 8495: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8496: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8497: <pre class="programlisting">
1.100 rillig 8498: i386 i386, __i386, __i386__
8499: MIPS __mips
8500: SPARC sparc, __sparc
1.75 rillig 8501: </pre>
8502: </div>
1.148 asau 8503: <div class="sect3">
1.75 rillig 8504: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8505: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8506: <pre class="programlisting">
1.100 rillig 8507: GCC __GNUC__ (major version), __GNUC_MINOR__
8508: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8509: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8510: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8511: </pre>
8512: </div>
8513: </div>
1.148 asau 8514: <div class="sect2">
1.78 rillig 8515: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8516: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8517: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8518: combinations of compiler version and architecture and almost
8519: always relation to optimisation being enabled. Common symptoms
8520: are gcc internal errors or never finishing compiling a
1.78 rillig 8521: file.</p>
8522: <p>Typically, a workaround involves testing the
8523: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8524: optimisation for that combination of file,
8525: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8526: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8527: number of examples.</p>
8528: </div>
1.148 asau 8529: <div class="sect2">
1.78 rillig 8530: <div class="titlepage"><div><div><h3 class="title">
1.128 wiz 8531: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8532: </h3></div></div></div>
1.92 rillig 8533: <p>This error message often means that a package did not
1.78 rillig 8534: link to a shared library it needs. The following functions are
8535: known to cause this error message over and over.</p>
8536: <div class="informaltable">
8537: <a name="undefined-reference-functions"></a><table border="1">
8538: <colgroup>
8539: <col>
8540: <col>
8541: <col>
8542: </colgroup>
8543: <thead><tr>
8544: <th>Function</th>
8545: <th>Library</th>
8546: <th>Affected platforms</th>
8547: </tr></thead>
8548: <tbody>
8549: <tr>
8550: <td>accept, bind, connect</td>
8551: <td>-lsocket</td>
8552: <td>Solaris</td>
8553: </tr>
8554: <tr>
8555: <td>crypt</td>
8556: <td>-lcrypt</td>
8557: <td>DragonFly, NetBSD</td>
8558: </tr>
8559: <tr>
8560: <td>dlopen, dlsym</td>
8561: <td>-ldl</td>
8562: <td>Linux</td>
8563: </tr>
8564: <tr>
8565: <td>gethost*</td>
8566: <td>-lnsl</td>
8567: <td>Solaris</td>
8568: </tr>
8569: <tr>
8570: <td>inet_aton</td>
8571: <td>-lresolv</td>
8572: <td>Solaris</td>
8573: </tr>
8574: <tr>
8575: <td>nanosleep, sem_*, timer_*</td>
8576: <td>-lrt</td>
8577: <td>Solaris</td>
8578: </tr>
8579: <tr>
8580: <td>openpty</td>
8581: <td>-lutil</td>
8582: <td>Linux</td>
8583: </tr>
8584: </tbody>
8585: </table>
8586: </div>
8587: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8588: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8589: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8590: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8591: bmake</strong></span>.</p>
1.148 asau 8592: <div class="sect3">
1.92 rillig 8593: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8594: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8595: <p>When you are using the SunPro compiler, there is another
8596: possibility. That compiler cannot handle the following code:</p>
8597: <pre class="programlisting">
1.100 rillig 8598: extern int extern_func(int);
1.93 rillig 8599:
1.100 rillig 8600: static inline int
8601: inline_func(int x)
8602: {
1.92 rillig 8603: return extern_func(x);
1.100 rillig 8604: }
1.93 rillig 8605:
1.100 rillig 8606: int main(void)
8607: {
1.92 rillig 8608: return 0;
1.100 rillig 8609: }
1.92 rillig 8610: </pre>
8611: <p>It generates the code for <code class="function">inline_func</code> even if
8612: that function is never used. This code then refers to
8613: <code class="function">extern_func</code>, which can usually not be resolved. To
8614: solve this problem you can try to tell the package to disable inlining
8615: of functions.</p>
8616: </div>
1.87 wiz 8617: </div>
1.148 asau 8618: <div class="sect2">
1.87 wiz 8619: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8620: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8621: <p>Sometimes packages fail to build because the compiler runs
8622: into an operating system specific soft limit. With the
8623: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8624: to unlimit the resources. Currently, the allowed values are
1.128 wiz 8625: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.87 wiz 8626: Setting this variable is similar to running the shell builtin
1.110 hubertf 8627: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8628: segment size or maximum stack size of a process, respectively, to
8629: their hard limits.</p>
1.78 rillig 8630: </div>
1.75 rillig 8631: </div>
1.148 asau 8632: <div class="sect1">
1.75 rillig 8633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8634: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 8635: <div class="sect2">
1.75 rillig 8636: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8637: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8638: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8639: with some operating systems cannot create more than one
8640: directory at a time. As such, you should call
8641: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8642: <pre class="programlisting">
1.100 rillig 8643: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8644: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8645: </pre>
1.128 wiz 8646: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8647: dir2</code></span>”</span> to the
1.87 wiz 8648: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8649: automatically do the right thing.</p>
1.75 rillig 8650: </div>
1.148 asau 8651: <div class="sect2">
1.75 rillig 8652: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8653: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8654: <p>In general, documentation should be installed into
1.87 wiz 8655: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8656: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8657: includes the version number of the package).</p>
1.84 wiz 8658: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8659: directory where HTML documentation is installed with the
1.128 wiz 8660: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8661: is needed because otherwise the documentation ends up in
8662: <code class="filename">${PREFIX}/share/doc/html</code> or other
8663: places.</p>
8664: <p>An exception to the above is that library API documentation
1.91 rillig 8665: generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87 wiz 8666: browsers (devhelp) should be left at their default location, which
8667: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8668: documentation can be recognized from files ending in
8669: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8670: (It is also acceptable to install such files in
8671: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8672: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8673: <code class="filename">.devhelp*</code> file must be directly in that
8674: directory then, no additional subdirectory level is allowed in
8675: this case. This is usually achieved by using
1.128 wiz 8676: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8677: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8678: though.)</p>
1.75 rillig 8679: </div>
1.148 asau 8680: <div class="sect2">
1.75 rillig 8681: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8682: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8683: <p>Certain packages, most of them in the games category, install
1.87 wiz 8684: a score file that allows all users on the system to record their
8685: highscores. In order for this to work, the binaries need to be
8686: installed setgid and the score files owned by the appropriate
1.142 wiz 8687: group and/or owner (traditionally the "games" user/group). Set
8688: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8689: following variables, documented in more detail in
8690: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8691: behaviour: <code class="varname">GAMEDATAMODE</code>,
8692: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8693: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114 jmcneill 8694: <p>A package should therefore never hard code file ownership or
1.87 wiz 8695: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8696: <code class="varname">INSTALL_GAME_DATA</code> to set these
8697: correctly.</p>
1.75 rillig 8698: </div>
1.148 asau 8699: <div class="sect2">
1.75 rillig 8700: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8701: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8702: <p><code class="varname">DESTDIR</code> support means that a package
8703: installs into a staging directory, not the final location of the
8704: files. Then a binary package is created which can be used for
8705: installation as usual. There are two ways: Either the package must
1.128 wiz 8706: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8707: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8708: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8709: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145 wiz 8710: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8711: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8712: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8713: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8714: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8715: the inclusion.</p></li>
1.128 wiz 8716: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8717: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8718: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8719: automatically. Many manual rules and pre/post-install often are
8720: incorrect; fix them.</p></li>
1.128 wiz 8721: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8722: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8723: <li class="listitem"><p>In general, packages should support
1.103 wiz 8724: <code class="varname">UNPRIVILEGED</code> to be able to use
8725: DESTDIR.</p></li>
8726: </ul></div>
8727: </div>
1.148 asau 8728: <div class="sect2">
1.103 wiz 8729: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8730: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8731: <p>Your package may also contain scripts with hardcoded paths to
8732: other interpreters besides (or as well as) perl. To correct the
8733: full pathname to the script interpreter, you need to set the
8734: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8735: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8736: <pre class="programlisting">
1.100 rillig 8737: REPLACE_INTERPRETER+= tcl
8738: REPLACE.tcl.old= .*/bin/tclsh
8739: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8740: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8741: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8742: </pre>
1.148 asau 8743: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8744: <h3 class="title">Note</h3>
8745: <p>Before March 2006, these variables were called
1.87 wiz 8746: <code class="varname">_REPLACE.*</code> and
8747: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8748: </div>
8749: </div>
1.148 asau 8750: <div class="sect2">
1.75 rillig 8751: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8752: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8753: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8754: the Makefile fragment
8755: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8756: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8757: configuration for such modules as well as various hooks to tune
8758: this configuration. See comments in this file for
8759: details.</p>
1.75 rillig 8760: <p>Perl5 modules will install into different places depending
1.87 wiz 8761: on the version of perl used during the build process. To
8762: address this, pkgsrc will append lines to the
8763: <code class="filename">PLIST</code> corresponding to the files listed in
8764: the installed <code class="filename">.packlist</code> file generated by
8765: most perl5 modules. This is invoked by defining
8766: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8767: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8768: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8769: e.g.:</p>
1.75 rillig 8770: <pre class="programlisting">
1.153 wiz 8771: PERL5_PACKLIST= auto/Pg/.packlist
1.87 wiz 8772: </pre>
1.153 wiz 8773: <p>The perl5 config variables
8774: <code class="varname">installarchlib</code>,
8775: <code class="varname">installscript</code>,
8776: <code class="varname">installvendorbin</code>,
8777: <code class="varname">installvendorscript</code>,
8778: <code class="varname">installvendorarch</code>,
8779: <code class="varname">installvendorlib</code>,
8780: <code class="varname">installvendorman1dir</code>, and
8781: <code class="varname">installvendorman3dir</code> represent those
8782: locations in which components of perl5 modules may be installed,
8783: provided as variable with uppercase and prefixed with
8784: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8785: and may be used by perl5 packages that don't have a packlist.
8786: These variables are also substituted for in the
8787: <code class="filename">PLIST</code> as uppercase prefixed with
8788: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8789: </div>
1.148 asau 8790: <div class="sect2">
1.75 rillig 8791: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8792: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8793: <p>Some packages install info files or use the
1.128 wiz 8794: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8795: commands. <code class="varname">INFO_FILES</code> should be defined in
8796: the package Makefile so that <code class="filename">INSTALL</code> and
8797: <code class="filename">DEINSTALL</code> scripts will be generated to
8798: handle registration of the info files in the Info directory
1.128 wiz 8799: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8800: files registration is either provided by the system, or by a
8801: special purpose package automatically added as dependency if
8802: needed.</p>
1.75 rillig 8803: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8804: <code class="filename">${PREFIX}</code> where info files are primarily
8805: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8806: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8807: <p>The info files for the package should be listed in the
1.87 wiz 8808: package <code class="filename">PLIST</code>; however any split info files
8809: need not be listed.</p>
1.128 wiz 8810: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8811: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8812: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8813: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8814: should be noted with the <code class="varname">TEXINFO_REQD</code>
8815: variable in the package <code class="filename">Makefile</code>. By
8816: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8817: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8818: does not match the required minimum, a build dependency on the
1.91 rillig 8819: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87 wiz 8820: be added automatically.</p>
1.75 rillig 8821: <p>The build and installation process of the software provided
1.87 wiz 8822: by the package should not use the
1.110 hubertf 8823: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8824: info files is the task of the package
8825: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8826: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8827: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8828: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8829: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8830: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8831: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8832: no effect except the logging of a message. The script overriding
1.110 hubertf 8833: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8834: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8835: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8836: </div>
1.148 asau 8837: <div class="sect2">
1.75 rillig 8838: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8839: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8840: <p>All packages that install manual pages should install them
1.87 wiz 8841: into the same directory, so that there is one common place to look
8842: for them. In pkgsrc, this place is
8843: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8844: should be used in packages. The default for
8845: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8846: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8847: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8848: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8849: <h3 class="title">Note</h3>
1.87 wiz 8850: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8851: is far from complete.</p>
1.75 rillig 8852: </div>
1.81 rillig 8853: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8854: <code class="filename">man/</code> as the top level directory for the man
8855: page file entries, and the pkgsrc framework will convert as
8856: needed. In all other places, the correct
8857: <code class="varname">PKGMANDIR</code> must be used.</p>
8858: <p>Packages that are
8859: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8860: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8861: <code class="filename">./configure</code>
8862: --mandir switch to set where the man pages should be installed.
8863: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8864: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8865: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8866: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8867: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8868: Or if the <code class="filename">./configure</code> script uses
8869: a non-standard use of --mandir, you can set
8870: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8871: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.87 wiz 8872: information on installation of compressed manual pages.</p>
1.75 rillig 8873: </div>
1.148 asau 8874: <div class="sect2">
1.75 rillig 8875: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8876: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8877: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8878: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8879: you need to take some extra steps to make sure they get registered
8880: in the database:</p>
1.128 wiz 8881: <div class="orderedlist"><ol class="orderedlist" type="1">
8882: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8883: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8884: takes care of rebuilding the GConf database at installation and
1.87 wiz 8885: deinstallation time, and tells the package where to install
1.107 rillig 8886: GConf data files using some standard configure arguments. It
1.87 wiz 8887: also disallows any access to the database directly from the
8888: package.</p></li>
1.128 wiz 8889: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8890: <code class="filename">.schemas</code> files under
8891: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8892: installed under <code class="filename">${PREFIX}/etc</code>, you will
8893: need to manually patch the package.</p></li>
1.128 wiz 8894: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8895: directory, as they will be handled automatically. See
1.173 wiz 8896: <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.128 wiz 8897: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8898: your <code class="filename">Makefile</code> with a list of all
8899: <code class="filename">.schemas</code> files installed by the package, if
8900: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8901: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8902: your <code class="filename">Makefile</code> with a
8903: list of all <code class="filename">.entries</code> files installed by the
8904: package, if any. Names must not contain any directories in
8905: them.</p></li>
1.75 rillig 8906: </ol></div>
8907: </div>
1.148 asau 8908: <div class="sect2">
1.75 rillig 8909: <div class="titlepage"><div><div><h3 class="title">
1.119 mishka 8910: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8911: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8912: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8913: get registered in the database:</p>
1.128 wiz 8914: <div class="orderedlist"><ol class="orderedlist" type="1">
8915: <li class="listitem"><p>Include
1.119 mishka 8916: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8917: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8918: takes care of rebuilding the scrollkeeper database at
8919: installation and deinstallation time, and disallows any access
8920: to it directly from the package.</p></li>
1.128 wiz 8921: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8922: <code class="filename">libdata/scrollkeeper</code> directory, as they
8923: will be handled automatically.</p></li>
1.128 wiz 8924: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 8925: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8926: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 8927: </ol></div>
8928: </div>
1.148 asau 8929: <div class="sect2">
1.75 rillig 8930: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8931: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8932: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8933: the fonts database in the directory where they get installed at
8934: installation and deinstallation time. This can be automatically
8935: done by using the pkginstall framework.</p>
1.75 rillig 8936: <p>You can list the directories where fonts are installed in the
1.87 wiz 8937: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8938: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 8939: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.87 wiz 8940: Also make sure that the database file
8941: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8942: <p>Note that you should not create new directories for fonts;
1.87 wiz 8943: instead use the standard ones to avoid that the user needs to
8944: manually configure his X server to find them.</p>
1.75 rillig 8945: </div>
1.148 asau 8946: <div class="sect2">
1.75 rillig 8947: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8948: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8949: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8950: take some extra steps to get them registered in the GTK2 database
8951: properly:</p>
1.128 wiz 8952: <div class="orderedlist"><ol class="orderedlist" type="1">
8953: <li class="listitem"><p>Include
1.87 wiz 8954: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8955: <code class="filename">buildlink3.mk</code> file. This takes care of
8956: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 8957: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 8958: your package installs GTK2 immodules.</p></li>
1.128 wiz 8959: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 8960: GTK2 loaders.</p></li>
1.128 wiz 8961: <li class="listitem">
1.87 wiz 8962: <p>Patch the package to not touch any of the GTK2
8963: databases directly. These are:</p>
1.148 asau 8964: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8965: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8966: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8967: </ul></div>
8968: </li>
1.128 wiz 8969: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 8970: any entries under the <code class="filename">libdata/gtk-2.0</code>
8971: directory, as they will be handled automatically.</p></li>
1.75 rillig 8972: </ol></div>
8973: </div>
1.148 asau 8974: <div class="sect2">
1.75 rillig 8975: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8976: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8977: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8978: registered in system-wide catalogs (like DTDs, sub-catalogs,
8979: etc.), you need to take some extra steps:</p>
1.128 wiz 8980: <div class="orderedlist"><ol class="orderedlist" type="1">
8981: <li class="listitem"><p>Include
1.87 wiz 8982: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8983: your <code class="filename">Makefile</code>, which takes care of
8984: registering those files in system-wide catalogs at
8985: installation and deinstallation time.</p></li>
1.128 wiz 8986: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8987: any SGML catalogs installed by the package.</p></li>
1.128 wiz 8988: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 8989: any XML catalogs installed by the package.</p></li>
1.128 wiz 8990: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 8991: to be added to the SGML catalog. These come in groups of
8992: three strings; see xmlcatmgr(1) for more information
8993: (specifically, arguments recognized by the 'add' action).
8994: Note that you will normally not use this variable.</p></li>
1.128 wiz 8995: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 8996: to be added to the XML catalog. These come in groups of three
8997: strings; see xmlcatmgr(1) for more information (specifically,
8998: arguments recognized by the 'add' action). Note that you will
8999: normally not use this variable.</p></li>
1.75 rillig 9000: </ol></div>
9001: </div>
1.148 asau 9002: <div class="sect2">
1.75 rillig 9003: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9004: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9005: <p>If a package provides extensions to the MIME database by
1.87 wiz 9006: installing <code class="filename">.xml</code> files inside
9007: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9008: need to take some extra steps to ensure that the database is kept
9009: consistent with respect to these new files:</p>
1.128 wiz 9010: <div class="orderedlist"><ol class="orderedlist" type="1">
9011: <li class="listitem"><p>Include
1.87 wiz 9012: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9013: (avoid using the <code class="filename">buildlink3.mk</code> file from
9014: this same directory, which is reserved for inclusion from
9015: other <code class="filename">buildlink3.mk</code> files). It takes
9016: care of rebuilding the MIME database at installation and
9017: deinstallation time, and disallows any access to it directly
9018: from the package.</p></li>
1.128 wiz 9019: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9020: <code class="filename">share/mime</code> directory,
9021: <span class="emphasis"><em>except</em></span> for files saved under
9022: <code class="filename">share/mime/packages</code>. The former are
9023: handled automatically by
9024: the update-mime-database program, but the latter are
9025: package-dependent and must be removed by the package that
9026: installed them in the first place.</p></li>
1.128 wiz 9027: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9028: from the PLIST. They will be handled by the shared-mime-info
9029: package.</p></li>
1.75 rillig 9030: </ol></div>
9031: </div>
1.148 asau 9032: <div class="sect2">
1.75 rillig 9033: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9034: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9035: <p>If a package uses intltool during its build, add
9036: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9037: which forces it to use the intltool package provided by pkgsrc,
9038: instead of the one bundled with the distribution file.</p>
1.75 rillig 9039: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9040: latest available version; this way, the package benefits of any
9041: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9042: </div>
1.148 asau 9043: <div class="sect2">
1.75 rillig 9044: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9045: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9046: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9047: the startup directory by default, but you can enable it, by adding
9048: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9049: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9050: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9051: it will automatically remove the scripts when the package is
9052: deinstalled.</p>
1.75 rillig 9053: </div>
1.148 asau 9054: <div class="sect2">
1.75 rillig 9055: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9056: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9057: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9058: the <code class="filename">ls-R</code> database of the tree needs to be
9059: updated.</p>
1.148 asau 9060: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9061: <h3 class="title">Note</h3>
1.125 wiz 9062: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9063: packages should install files
1.125 wiz 9064: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9065: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9066: </div>
1.128 wiz 9067: <div class="orderedlist"><ol class="orderedlist" type="1">
9068: <li class="listitem"><p>Include
1.125 wiz 9069: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9070: takes care of rebuilding the <code class="filename">ls-R</code>
9071: database at installation and deinstallation time.</p></li>
1.128 wiz 9072: <li class="listitem">
1.75 rillig 9073: <p>If your package installs files into a texmf
1.87 wiz 9074: tree other than the one
1.125 wiz 9075: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9076: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9077: trees that need database update.</p>
1.75 rillig 9078: <p>If your package also installs font map files that need
1.110 hubertf 9079: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9080: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9081: set <code class="varname">TEX_MAP_FILES</code> and/or
9082: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9083: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9084: be run automatically at installation/deinstallation to
9085: enable/disable font map files for TeX output
9086: drivers.</p>
1.75 rillig 9087: </li>
1.128 wiz 9088: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9089: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9090: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9091: </ol></div>
9092: </div>
1.148 asau 9093: <div class="sect2">
1.85 jmmv 9094: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9095: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9096: emulation</h3></div></div></div>
9097: <p>There are some packages that provide libraries and
9098: executables for running binaries from a one operating system
9099: on a different one (if the latter supports it). One example
9100: is running Linux binaries on NetBSD.</p>
1.91 rillig 9101: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87 wiz 9102: helps in extracting and packaging Linux rpm packages.</p>
9103: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9104: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9105: if all libraries for each installed executable can be found by
9106: the dynamic linker. Since the standard dynamic linker is run,
9107: this fails for emulation packages, because the libraries used
9108: by the emulation are not in the standard directories.</p>
9109: </div>
1.148 asau 9110: <div class="sect2">
1.87 wiz 9111: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9112: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9113: <p>If a package installs images under the
1.87 wiz 9114: <code class="filename">share/icons/hicolor</code> and/or updates the
9115: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9116: database, you need to take some extra steps to make sure that the
9117: shared theme directory is handled appropriately and that the cache
9118: database is rebuilt:</p>
1.128 wiz 9119: <div class="orderedlist"><ol class="orderedlist" type="1">
9120: <li class="listitem"><p>Include
1.87 wiz 9121: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 9122: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 9123: entry that refers to the theme cache.</p></li>
1.128 wiz 9124: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 9125: directories from the <code class="filename">share/icons/hicolor</code>
9126: hierarchy because they will be handled automatically.</p></li>
9127: </ol></div>
9128: <p>The best way to verify that the PLIST is correct with
9129: respect to the last two points is to regenerate it using
1.110 hubertf 9130: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9131: </div>
1.148 asau 9132: <div class="sect2">
1.85 jmmv 9133: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9134: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9135: <p>If a package installs <code class="filename">.desktop</code> files
9136: under <code class="filename">share/applications</code> and these include
1.159 rodent 9137: MIME information (MimeType key), you need to take extra steps to
9138: ensure that they are registered into the MIME database:</p>
1.128 wiz 9139: <div class="orderedlist"><ol class="orderedlist" type="1">
9140: <li class="listitem"><p>Include
1.85 jmmv 9141: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 9142: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 9143: <code class="filename">share/applications/mimeinfo.cache</code> file.
9144: It will be handled automatically.</p></li>
9145: </ol></div>
9146: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9147: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9148: print-PLIST</strong></span>.</p>
1.75 rillig 9149: </div>
9150: </div>
1.148 asau 9151: <div class="sect1">
1.87 wiz 9152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9153: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9154: <p>In some cases one does not have the time to solve a problem
1.125 wiz 9155: immediately. In this case, one can plainly mark a package as broken. For
9156: this, one just sets the variable <code class="varname">BROKEN</code> to the
9157: reason why the package is broken (similar to the
9158: <code class="varname">RESTRICTED</code> variable). A user trying to build
9159: the package will immediately be shown this message, and the build
9160: will not be even tried.</p>
9161: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 9162: intervals.</p>
9163: </div>
1.75 rillig 9164: </div>
1.148 asau 9165: <div class="chapter">
1.75 rillig 9166: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9167: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9168: <p>To check out all the gotchas when building a package, here are
9169: the steps that I do in order to get a package working. Please note
9170: this is basically the same as what was explained in the previous
9171: sections, only with some debugging aids.</p>
1.148 asau 9172: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9173: <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>
9174: <li class="listitem">
1.91 rillig 9175: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88 wiz 9176: create a directory for a new package, change into it, then run
1.110 hubertf 9177: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9178: <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>
9179: <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>
9180: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9181: </li>
1.128 wiz 9182: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9183: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9184: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9185: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9186: configure step to the package's
9187: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 9188: <li class="listitem">
1.75 rillig 9189: <p>Make the package compile, doing multiple rounds of</p>
9190: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9191: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9192: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9193: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9194: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9195: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9196: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9197: <p>Doing this step as non-root user will ensure that no files
9198: are modified that shouldn't be, especially during the build
1.110 hubertf 9199: phase. <span class="command"><strong>mkpatches</strong></span>,
9200: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9201: from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88 wiz 9202: package.</p>
1.75 rillig 9203: </li>
1.128 wiz 9204: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9205: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9206: <li class="listitem">
1.76 rillig 9207: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9208: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9209: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9210: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9211: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9212: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9213: <p>You usually need to be <code class="username">root</code> to do
9214: this. Look if there are any files left:</p>
1.75 rillig 9215: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9216: <p>If this reveals any files that are missing in
1.88 wiz 9217: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9218: </li>
1.128 wiz 9219: <li class="listitem">
1.88 wiz 9220: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9221: package again and make a binary package:</p>
1.75 rillig 9222: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9223: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9224: </li>
1.128 wiz 9225: <li class="listitem">
1.75 rillig 9226: <p>Delete the installed package:</p>
1.88 wiz 9227: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75 rillig 9228: </li>
1.128 wiz 9229: <li class="listitem">
1.110 hubertf 9230: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9231: command, which shouldn't find anything now:</p>
1.75 rillig 9232: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9233: </li>
1.128 wiz 9234: <li class="listitem">
1.75 rillig 9235: <p>Reinstall the binary package:</p>
1.93 rillig 9236: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75 rillig 9237: </li>
1.128 wiz 9238: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9239: <li class="listitem">
1.110 hubertf 9240: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88 wiz 9241: reports:</p>
1.75 rillig 9242: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9243: </li>
1.128 wiz 9244: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.75 rillig 9245: </ul></div>
9246: </div>
1.148 asau 9247: <div class="chapter">
1.75 rillig 9248: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9249: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9250: <div class="toc">
9251: <p><b>Table of Contents</b></p>
9252: <dl>
1.106 rillig 9253: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9254: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9255: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140 wiz 9256: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106 rillig 9257: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122 reed 9258: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9259: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9260: </dl>
9261: </div>
1.148 asau 9262: <div class="sect1">
1.75 rillig 9263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9264: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9265: <p>Our policy is that we accept binaries only from pkgsrc
9266: developers to guarantee that the packages don't contain any
9267: trojan horses etc. This is not to annoy anyone but rather to
9268: protect our users! You're still free to put up your home-made
9269: binary packages and tell the world where to get them. NetBSD
9270: developers doing bulk builds and wanting to upload them please
1.174 asau 9271: 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
9272: builds)</i></a>.</p>
1.75 rillig 9273: </div>
1.148 asau 9274: <div class="sect1">
1.75 rillig 9275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9276: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9277: <p>First, check that your package is complete, compiles and
1.110 hubertf 9278: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.136 dholland 9279: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9280: archive that contains all files that make up the package.
1.87 wiz 9281: Finally, send this package to the pkgsrc bug tracking system,
1.136 dholland 9282: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9283: that, go to the web page
1.110 hubertf 9284: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 9285: which contains some instructions and a link to a form where you
9286: can submit packages. The
9287: <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
9288: also available as a substitute for either of the above two tools.
9289: </p>
1.87 wiz 9290: <p>In the form of the problem report, the category should be
1.128 wiz 9291: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9292: and version number, and the description field should contain a
9293: short description of your package (contents of the COMMENT
9294: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9295: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9296: <p>If you want to submit several packages, please send a
9297: separate PR for each one, it's easier for us to track things
9298: that way.</p>
9299: <p>Alternatively, you can also import new packages into
1.128 wiz 9300: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.110 hubertf 9301: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9302: for details.</p>
9303: </div>
1.148 asau 9304: <div class="sect1">
1.75 rillig 9305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9306: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9307: <p>Please note all package additions, updates, moves, and
1.93 rillig 9308: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9309: important to keep this file up to date and conforming to the
9310: existing format, because it will be used by scripts to
1.110 hubertf 9311: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9312: sites. Additionally, check the
1.76 rillig 9313: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9314: for the package you updated or removed, in case it was mentioned
9315: there.</p>
9316: <p>When the <code class="varname">PKGREVISION</code> of a package is
9317: bumped, the change should appear in
1.93 rillig 9318: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9319: related or otherwise relevant. Mass bumps that result from a
9320: dependency being updated should not be mentioned. In all other
9321: cases it's the developer's decision.</p>
9322: <p>There is a make target that helps in creating proper
1.110 hubertf 9323: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9324: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9325: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9326: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9327: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9328: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9329: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9330: For new packages, or package moves or removals, set the
9331: <code class="varname">CTYPE</code> variable on the command line to "Added",
9332: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9333: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9334: not the same as your NetBSD login name. The target also automatically
9335: removes possibly existing entries for the package in the
9336: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9337: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9338: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9339: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9340: makes the cvs commands use the main repository.
9341: </p>
1.75 rillig 9342: </div>
1.148 asau 9343: <div class="sect1">
1.75 rillig 9344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140 wiz 9345: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9346: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9347: access to the pkgsrc repository.</p>
9348: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9349: Start by adding the directory and then files in the directory. Don't
9350: forget to add the new package to the category's
9351: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9352: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9353: <pre class="programlisting">
9354: <code class="prompt">$</code> cd .../pkgsrc/category
9355: <code class="prompt">$</code> cvs add pkgname
9356: <code class="prompt">$</code> cd pkgname
9357: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9358: <code class="prompt">$</code> cvs add patches/p*
9359: <code class="prompt">$</code> cvs status | less
1.141 wiz 9360: <code class="prompt">$</code> cvs commit
1.140 wiz 9361: <code class="prompt">$</code> cd ..
9362: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9363: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9364: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9365: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9366: </pre>
1.87 wiz 9367: <p>The commit message of the initial import should include part of the
1.76 rillig 9368: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9369: what the package is/does.</p>
1.140 wiz 9370: <p>Also mention the new package in
9371: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9372: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9373: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9374: </div>
1.148 asau 9375: <div class="sect1">
1.75 rillig 9376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9377: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9378: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9379: changes between old and new versions into the commit log when updating
1.87 wiz 9380: a package. There are various reasons for this:</p>
1.148 asau 9381: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9382: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9383: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9384: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9385: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9386: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9387: repository is very useful for people who read the pkgsrc-changes mailing
9388: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9389: the package.</p></li>
1.75 rillig 9390: </ul></div>
1.87 wiz 9391: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9392: has been released, it should not automatically be upgraded in the CVS
9393: repository. We prefer to be conservative in the packages that are
9394: included in pkgsrc - development or beta packages are not really the
9395: best thing for most places in which pkgsrc is used. Please use your
9396: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9397: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9398: </div>
1.148 asau 9399: <div class="sect1">
1.75 rillig 9400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122 reed 9401: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9402: <p>Renaming packages is not recommended.</p>
9403: <p>When renaming packages, be sure to fix any references to old name
9404: in other Makefiles, options, buildlink files, etc.</p>
9405: <p>Also When renaming a package, please define
9406: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9407: pattern(s) of the previous package name.
9408: This may be repeated for multiple renames.
9409: The new package would be an exact replacement.
9410: </p>
1.128 wiz 9411: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9412: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9413: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9414: not be an exact replacement but is a suggestion for the replaced
9415: functionality.</p>
9416: </div>
1.148 asau 9417: <div class="sect1">
1.122 reed 9418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9419: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9420: <p>It is preferred that packages are not renamed or moved, but if needed
9421: please follow these steps.
9422: </p>
1.128 wiz 9423: <div class="orderedlist"><ol class="orderedlist" type="1">
9424: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9425: <li class="listitem">
1.75 rillig 9426: <p>Remove all CVS dirs.</p>
1.87 wiz 9427: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9428: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87 wiz 9429: <p>and use that for further work.</p>
1.75 rillig 9430: </li>
1.128 wiz 9431: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9432: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9433: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9434: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9435: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9436: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9437: for doing an update using pkgsrc building; for example, it can
1.136 dholland 9438: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122 reed 9439: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9440: new <code class="varname">PKGPATH</code> for that moved package. Note that
9441: it may have multiple matches, so the tool should also check on the
9442: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9443: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9444: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9445: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9446: place.</p></li>
1.128 wiz 9447: <li class="listitem">
1.75 rillig 9448: <p>Check if any package depends on it:
9449: </p>
9450: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9451: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9452: </li>
1.128 wiz 9453: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9454: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9455: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9456: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9457: <li class="listitem">
1.75 rillig 9458: <p>Commit the changed and removed files:</p>
9459: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 9460: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9461: </li>
9462: </ol></div>
9463: </div>
9464: </div>
1.148 asau 9465: <div class="chapter">
1.75 rillig 9466: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9467: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9468: <p>This section contains the answers to questions that may
9469: arise when you are writing a package. If you don't find your
9470: question answered here, first have a look in the other chapters,
9471: and if you still don't have the answer, ask on the
9472: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9473: <div class="qandaset">
1.185 jnemeth 9474: <a name="idm77314064"></a><dl>
1.106 rillig 9475: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9476: MAKEFLAGS, .MAKEFLAGS and
9477: MAKE_FLAGS?</a>
9478: </dt>
1.106 rillig 9479: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9480: MAKE, GMAKE and
9481: MAKE_PROGRAM?</a>
9482: </dt>
1.106 rillig 9483: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9484: CC, PKG_CC and
9485: PKGSRC_COMPILER?</a>
9486: </dt>
1.106 rillig 9487: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9488: BUILDLINK_LDFLAGS,
9489: BUILDLINK_LDADD and
9490: BUILDLINK_LIBS?</a>
9491: </dt>
1.106 rillig 9492: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9493: VARNAME=BUILDLINK_PREFIX.foo
9494: say it's empty?</a>
9495: </dt>
1.106 rillig 9496: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9497: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9498: don't understand the := inside
9499: it.</a>
9500: </dt>
1.106 rillig 9501: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9502: developers?</a>
9503: </dt>
1.106 rillig 9504: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9505: documentation?</a>
9506: </dt>
1.106 rillig 9507: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9508: do?</a>
9509: </dt>
1.75 rillig 9510: </dl>
1.148 asau 9511: <table border="0" style="width: 100%;">
9512: <colgroup>
1.75 rillig 9513: <col align="left" width="1%">
1.128 wiz 9514: <col>
1.148 asau 9515: </colgroup>
1.75 rillig 9516: <tbody>
1.148 asau 9517: <tr class="question">
1.75 rillig 9518: <td align="left" valign="top">
1.185 jnemeth 9519: <a name="devfaq.makeflags"></a><a name="idm77313680"></a><p><b>22.1.</b></p>
1.75 rillig 9520: </td>
9521: <td align="left" valign="top"><p>What is the difference between
9522: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9523: <code class="varname">MAKE_FLAGS</code>?</p></td>
9524: </tr>
9525: <tr class="answer">
1.91 rillig 9526: <td align="left" valign="top"></td>
1.75 rillig 9527: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.136 dholland 9528: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 9529: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9530: the <code class="varname">MAKE_PROGRAM</code> when building the
9531: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9532: </tr>
1.148 asau 9533: <tr class="question">
1.75 rillig 9534: <td align="left" valign="top">
1.185 jnemeth 9535: <a name="devfaq.make"></a><a name="idm77309584"></a><p><b>22.2.</b></p>
1.75 rillig 9536: </td>
9537: <td align="left" valign="top"><p>What is the difference between
9538: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9539: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9540: </tr>
9541: <tr class="answer">
1.91 rillig 9542: <td align="left" valign="top"></td>
1.75 rillig 9543: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.136 dholland 9544: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 9545: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9546: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9547: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9548: Make program that is used for building the
9549: package.</p></td>
9550: </tr>
1.148 asau 9551: <tr class="question">
1.75 rillig 9552: <td align="left" valign="top">
1.185 jnemeth 9553: <a name="devfaq.cc"></a><a name="idm77305104"></a><p><b>22.3.</b></p>
1.75 rillig 9554: </td>
9555: <td align="left" valign="top"><p>What is the difference between
9556: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9557: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9558: </tr>
9559: <tr class="answer">
1.91 rillig 9560: <td align="left" valign="top"></td>
1.75 rillig 9561: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9562: compiler, which can be configured by the pkgsrc user.
9563: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9564: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9565: path to a compiler, but the type of compiler that should be
1.76 rillig 9566: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9567: information about the latter variable.</p></td>
9568: </tr>
1.148 asau 9569: <tr class="question">
1.75 rillig 9570: <td align="left" valign="top">
1.185 jnemeth 9571: <a name="devfaq.bl3flags"></a><a name="idm77301008"></a><p><b>22.4.</b></p>
1.75 rillig 9572: </td>
9573: <td align="left" valign="top"><p>What is the difference between
9574: <code class="varname">BUILDLINK_LDFLAGS</code>,
9575: <code class="varname">BUILDLINK_LDADD</code> and
9576: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9577: </tr>
9578: <tr class="answer">
1.91 rillig 9579: <td align="left" valign="top"></td>
1.75 rillig 9580: <td align="left" valign="top"><p>[FIXME]</p></td>
9581: </tr>
1.148 asau 9582: <tr class="question">
1.75 rillig 9583: <td align="left" valign="top">
1.185 jnemeth 9584: <a name="devfaq.bl3prefix"></a><a name="idm77298832"></a><p><b>22.5.</b></p>
1.75 rillig 9585: </td>
1.110 hubertf 9586: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9587: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9588: say it's empty?</p></td>
9589: </tr>
9590: <tr class="answer">
1.91 rillig 9591: <td align="left" valign="top"></td>
1.75 rillig 9592: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9593: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9594: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9595: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9596: command.</p></td>
9597: </tr>
1.148 asau 9598: <tr class="question">
1.78 rillig 9599: <td align="left" valign="top">
1.185 jnemeth 9600: <a name="devfaq.master_sites"></a><a name="idm77283344"></a><p><b>22.6.</b></p>
1.78 rillig 9601: </td>
9602: <td align="left" valign="top"><p>What does
9603: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9604: don't understand the <code class="literal">:=</code> inside
9605: it.</p></td>
9606: </tr>
9607: <tr class="answer">
1.91 rillig 9608: <td align="left" valign="top"></td>
1.78 rillig 9609: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9610: assignment operator, like you might expect at first sight.
9611: Instead, it is a degenerate form of
9612: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.136 dholland 9613: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78 rillig 9614: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9615: case of <code class="varname">MASTER_SITE_*</code>,
9616: <em class="replaceable"><code>old_string</code></em> is the empty string and
9617: <em class="replaceable"><code>new_string</code></em> is
9618: <code class="literal">package/</code>. That's where the
9619: <code class="literal">:</code> and the <code class="literal">=</code> fall
9620: together.</p></td>
9621: </tr>
1.148 asau 9622: <tr class="question">
1.78 rillig 9623: <td align="left" valign="top">
1.185 jnemeth 9624: <a name="devfaq.mailinglists"></a><a name="idm77275280"></a><p><b>22.7.</b></p>
1.78 rillig 9625: </td>
9626: <td align="left" valign="top"><p>Which mailing lists are there for package
9627: developers?</p></td>
9628: </tr>
9629: <tr class="answer">
1.91 rillig 9630: <td align="left" valign="top"></td>
1.148 asau 9631: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9632: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78 rillig 9633: <dd><p>This is a list for technical discussions related
9634: to pkgsrc development, e.g. soliciting feedback for changes to
9635: pkgsrc infrastructure, proposed new features, questions related
9636: to porting pkgsrc to a new platform, advice for maintaining a
9637: package, patches that affect many packages, help requests moved
9638: from pkgsrc-users when an infrastructure bug is found,
9639: etc.</p></dd>
1.110 hubertf 9640: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78 rillig 9641: <dd><p>All bug reports in category "pkg" sent with
1.136 dholland 9642: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 9643: directly; use one of the other mailing
9644: lists.</p></dd>
9645: </dl></div></td>
9646: </tr>
1.148 asau 9647: <tr class="question">
1.80 rillig 9648: <td align="left" valign="top">
1.185 jnemeth 9649: <a name="devfaq.documentation"></a><a name="idm77271568"></a><p><b>22.8.</b></p>
1.80 rillig 9650: </td>
9651: <td align="left" valign="top"><p>Where is the pkgsrc
9652: documentation?</p></td>
9653: </tr>
9654: <tr class="answer">
1.91 rillig 9655: <td align="left" valign="top"></td>
1.80 rillig 9656: <td align="left" valign="top">
9657: <p>There are many places where you can find
9658: documentation about pkgsrc:</p>
1.148 asau 9659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9660: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9661: of chapters that explain large parts of pkgsrc, but some
9662: chapters tend to be outdated. Which ones they are is hard to
9663: say.</p></li>
1.128 wiz 9664: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80 rillig 9665: about certain features, announcements of new parts of the pkgsrc
9666: infrastructure and sometimes even announcements that a certain
9667: feature has been marked as obsolete. The benefit here is that
9668: each message has a date appended to it.</p></li>
1.128 wiz 9669: <li class="listitem"><p>Many of the files in the
1.80 rillig 9670: <code class="filename">mk/</code> directory start with a comment that
9671: describes the purpose of the file and how it can be used by the
1.92 rillig 9672: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9673: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9674: help</strong></span>.</p></li>
1.128 wiz 9675: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9676: information, but they tend to be highly abbreviated, especially
9677: for actions that occur often. Some contain a detailed
9678: description of what has changed, but they are geared towards the
9679: other pkgsrc developers, not towards an average pkgsrc user.
9680: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9681: don't know what has been before, these messages may not be worth
9682: too much to you.</p></li>
1.128 wiz 9683: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9684: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9685: mind of the developer who wrote the code. To get this
1.110 hubertf 9686: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9687: to see who has written it and ask on the
9688: <code class="literal">tech-pkg</code> mailing list, so that others can
9689: find your questions later (see above). To be sure that the
9690: developer in charge reads the mail, you may CC him or
9691: her.</p></li>
9692: </ul></div>
9693: </td>
9694: </tr>
1.148 asau 9695: <tr class="question">
1.92 rillig 9696: <td align="left" valign="top">
1.185 jnemeth 9697: <a name="devfaq.too-much-time"></a><a name="idm77265040"></a><p><b>22.9.</b></p>
1.92 rillig 9698: </td>
9699: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9700: do?</p></td>
9701: </tr>
9702: <tr class="answer">
9703: <td align="left" valign="top"></td>
9704: <td align="left" valign="top">
1.93 rillig 9705: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9706: anyway.</p>
1.148 asau 9707: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9708: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9709: <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
9710: will tell you about newer versions of installed packages that are
9711: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9712: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9713: — it contains a list of suggested new packages and a list of
1.92 rillig 9714: cleanups and enhancements for pkgsrc that would be nice to
9715: have.</p></li>
1.128 wiz 9716: <li class="listitem"><p>Review packages for which review was requested on
1.180 wiz 9717: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92 rillig 9718: mailing list.</p></li>
9719: </ul></div>
9720: </td>
9721: </tr>
1.75 rillig 9722: </tbody>
9723: </table>
9724: </div>
9725: </div>
1.148 asau 9726: <div class="chapter">
1.85 jmmv 9727: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9728: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9729: <div class="toc">
9730: <p><b>Table of Contents</b></p>
9731: <dl>
1.106 rillig 9732: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9733: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9734: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9735: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9736: </dl>
9737: </div>
1.110 hubertf 9738: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9739: site</a>:</p>
9740: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9741: environment, an intuitive and attractive desktop for users, and the
9742: GNOME development platform, an extensive framework for building
9743: applications that integrate into the rest of the desktop.</p></blockquote></div>
9744: <p>pkgsrc provides a seamless way to automatically build and install
9745: a complete GNOME environment <span class="emphasis"><em>under many different
9746: platforms</em></span>. We can say with confidence that pkgsrc is one of
9747: the most advanced build and packaging systems for GNOME due to its
9748: included technologies buildlink3, the wrappers and tools framework and
9749: automatic configuration file management. Lots of efforts are put into
9750: achieving a completely clean deinstallation of installed software
9751: components.</p>
1.110 hubertf 9752: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9753: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9754: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9755: pkgsrc as its preferred packaging system, contributing lots of
9756: portability fixes to make GNOME build and install under it.</p>
9757: <p>This chapter is aimed at pkgsrc developers and other people
9758: interested in helping our GNOME porting and packaging efforts. It
9759: provides instructions on how to manage the existing packages and some
9760: important information regarding their internals.</p>
1.148 asau 9761: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9762: <h3 class="title">We need your help!</h3>
9763: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9764: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9765: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9766: work</a> list! There is still a long way to go to get a
9767: fully-functional GNOME desktop under NetBSD and we need your help to
9768: achieve it!</p>
9769: </div>
1.148 asau 9770: <div class="sect1">
1.85 jmmv 9771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9772: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9773: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9775: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85 jmmv 9776: the core GNOME desktop environment. It only includes the necessary
9777: bits to get it to boot correctly, although it may lack important
9778: functionality for daily operation. The idea behind this package is
9779: to let end users build their own configurations on top of this one,
9780: first installing this meta package to achieve a functional setup and
9781: then adding individual applications.</p></li>
1.128 wiz 9782: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85 jmmv 9783: complete installation of the GNOME platform and desktop as defined
9784: by the GNOME project; this is based on the components distributed in
9785: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9786: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9787: official FTP server. Developer-only tools found in those
9788: directories are not installed unless required by some other
9789: component to work properly. Similarly, packages from the bindings
9790: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9791: in unless required as a dependency for an end-user component. This
1.91 rillig 9792: 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.128 wiz 9793: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85 jmmv 9794: Installs all the tools required to build a GNOME component when
9795: fetched from the CVS repository. These are required to let the
1.110 hubertf 9796: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9797: </ul></div>
9798: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9799: sorted in a way that eases updates: a package may depend on other
9800: packages listed before it but not on any listed after it. It is very
9801: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9802: change it to alphabetical sorting!</em></span></p>
9803: </div>
1.148 asau 9804: <div class="sect1">
1.85 jmmv 9805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9806: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9807: <p>Almost all GNOME applications are written in C and use a common
9808: set of tools as their build system. Things get different with the new
9809: bindings to other languages (such as Python), but the following will
9810: give you a general idea on the minimum required tools:</p>
1.148 asau 9811: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9812: <li class="listitem">
1.85 jmmv 9813: <p>Almost all GNOME applications use the GNU Autotools as their
9814: build system. As a general rule you will need to tell this to your
9815: package:</p>
1.100 rillig 9816: <pre class="programlisting">
9817: GNU_CONFIGURE=yes
1.85 jmmv 9818: USE_LIBTOOL=yes
1.100 rillig 9819: USE_TOOLS+=gmake
9820: </pre>
1.85 jmmv 9821: </li>
1.128 wiz 9822: <li class="listitem">
1.85 jmmv 9823: <p>If the package uses pkg-config to detect dependencies, add this
9824: tool to the list of required utilities:</p>
9825: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9826: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85 jmmv 9827: the end of the build process to ensure that you did not miss to
9828: specify any dependency in your package and that the version
9829: requirements are all correct.</p>
9830: </li>
1.128 wiz 9831: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9832: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9833: to handle dependencies and to force the package to use the latest
9834: available version.</p></li>
1.128 wiz 9835: <li class="listitem">
1.85 jmmv 9836: <p>If the package uses gtk-doc (a documentation generation
9837: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9838: tool is rather big and the distfile should come with pregenerated
9839: documentation anyway; if it does not, it is a bug that you ought to
9840: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9841: the default):</p>
9842: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9843: <p>The default location of installed HTML files
9844: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9845: and should not be changed unless the package insists on installing
9846: them somewhere else. Otherwise programs as
1.110 hubertf 9847: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9848: do that with an entry similar to:</p>
9849: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9850: </li>
9851: </ul></div>
9852: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9853: files under the installation prefix to maintain databases. In this
9854: context, shared means that those exact same directories and files are
9855: used among several different packages, leading to conflicts in the
9856: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9857: handle the most common cases, so you have to forget about using
9858: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9859: omitting shared files from them. If you find yourself doing those,
9860: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9861: <p>The following table lists the common situations that result in
9862: using shared directories or files. For each of them, the appropriate
9863: solution is given. After applying the solution be sure to
9864: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9865: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9866: <div class="table">
1.106 rillig 9867: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9868: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9869: <colgroup>
9870: <col>
9871: <col>
9872: </colgroup>
9873: <thead><tr>
9874: <th>If the package...</th>
9875: <th>Then...</th>
9876: </tr></thead>
9877: <tbody>
9878: <tr>
9879: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119 mishka 9880: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.85 jmmv 9881: </tr>
9882: <tr>
9883: <td>Installs icons under the
9884: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9885: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9886: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.85 jmmv 9887: </tr>
9888: <tr>
9889: <td>Installs files under
9890: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9891: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.85 jmmv 9892: </tr>
9893: <tr>
9894: <td>Installs <code class="filename">.desktop</code> files under
9895: <code class="filename">share/applications</code> and these include MIME
9896: information.</td>
1.110 hubertf 9897: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.85 jmmv 9898: </tr>
9899: </tbody>
1.91 rillig 9900: </table></div>
1.85 jmmv 9901: </div>
1.91 rillig 9902: <br class="table-break">
1.85 jmmv 9903: </div>
1.148 asau 9904: <div class="sect1">
1.85 jmmv 9905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9906: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9907: <p>When seeing GNOME as a whole, there are two kinds of
9908: updates:</p>
1.148 asau 9909: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9910: <dt><span class="term">Major update</span></dt>
9911: <dd>
9912: <p>Given that there is still a very long way for GNOME 3 (if it
9913: ever appears), we consider a major update one that goes from a
9914: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9915: where <code class="literal">Y</code> is even and greater than
9916: <code class="literal">X</code>. These are hard to achieve because they
9917: introduce lots of changes in the components' code and almost all
9918: GNOME distfiles are updated to newer versions. Some of them can
9919: even break API and ABI compatibility with the previous major
9920: version series. As a result, the update needs to be done all at
9921: once to minimize breakage.</p>
9922: <p>A major update typically consists of around 80 package
9923: updates and the addition of some new ones.</p>
9924: </dd>
9925: <dt><span class="term">Minor update</span></dt>
9926: <dd>
9927: <p>We consider a minor update one that goes from a
9928: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9929: one where <code class="literal">Y</code> is greater than
9930: <code class="literal">X</code>. These are easy to achieve because they do
9931: not update all GNOME components, can be done in an incremental way
9932: and do not break API nor ABI compatibility.</p>
9933: <p>A minor update typically consists of around 50 package
9934: updates, although the numbers here may vary a lot.</p>
9935: </dd>
9936: </dl></div>
9937: <p>In order to update the GNOME components in pkgsrc to a new stable
9938: release (either major or minor), the following steps should be
9939: followed:</p>
1.128 wiz 9940: <div class="orderedlist"><ol class="orderedlist" type="1">
9941: <li class="listitem">
1.85 jmmv 9942: <p>Get a list of all the tarballs that form the new release by
9943: using the following commands. These will leave the full list of the
1.120 snj 9944: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 9945: file:</p>
1.88 wiz 9946: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9947: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9948: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9949: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9950: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9951: awk '{ print $9 }' >>list.txt</code></strong></pre>
9952: </li>
1.128 wiz 9953: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 9954: bump their version to the release you are updating them to. The
9955: three meta packages should be always consistent with versioning.
9956: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9957: in them.</p></li>
1.128 wiz 9958: <li class="listitem">
1.85 jmmv 9959: <p>For each meta package, update all its
9960: <code class="varname">DEPENDS</code> lines to match the latest versions as
9961: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9962: newer version (even if found in the FTP) because the meta packages
9963: are supposed to list the exact versions that form a specific GNOME
9964: release. Exceptions are permitted here if a newer version solves a
9965: serious issue in the overall desktop experience; these typically
9966: come in the form of a revision bump in pkgsrc, not in newer versions
9967: from the developers.</p>
9968: <p>Packages not listed in the <code class="filename">list.txt</code> file
9969: should be updated to the latest version available (if found in
9970: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 9971: GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85 jmmv 9972: </li>
1.128 wiz 9973: <li class="listitem">
1.85 jmmv 9974: <p>Generate a patch from the modified meta packages and extract the
9975: list of "new" lines. This will provide you an outline on what
9976: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9977: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.85 jmmv 9978: </li>
1.128 wiz 9979: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 9980: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 9981: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 9982: of <code class="filename">todo.txt</code> and update the packages listed in
9983: it in order. For major desktop updates none of these should be
1.93 rillig 9984: committed until the entire set is completed because there are chances
1.85 jmmv 9985: of breaking not-yet-updated packages.</p></li>
1.128 wiz 9986: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 9987: the tree one by one with appropriate log messages. At the end,
9988: commit the three meta package updates and all the corresponding
9989: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9990: <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>
9991: </ol></div>
9992: </div>
1.148 asau 9993: <div class="sect1">
1.85 jmmv 9994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9995: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9996: <p>GNOME is a very big component in pkgsrc which approaches 100
9997: packages. Please, it is very important that you always, always,
9998: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 9999: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.85 jmmv 10000: their attention on portability issues and to ensure that future versions
10001: can be built out-of-the box on NetBSD. The less custom patches in
10002: pkgsrc, the easier further updates are. Those developers in charge of
10003: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 10004: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85 jmmv 10005: Bugzilla</a>. Not all components use these to track bugs, but most
10006: of them do. Do not be short on your reports: always provide detailed
10007: explanations of the current failure, how it can be improved to achieve
10008: maximum portability and, if at all possible, provide a patch against CVS
10009: head. The more verbose you are, the higher chances of your patch being
10010: accepted.</p>
10011: <p>Also, please avoid using preprocessor magic to fix portability
10012: issues. While the FreeBSD GNOME people are doing a great job in porting
10013: GNOME to their operating system, the official GNOME sources are now
10014: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10015: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 10016: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 10017: details.</p>
10018: </div>
10019: </div>
1.75 rillig 10020: </div>
1.148 asau 10021: <div class="part">
1.75 rillig 10022: <div class="titlepage"><div><div><h1 class="title">
10023: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10024: <div class="partintro">
1.75 rillig 10025: <div></div>
10026: <p>This part of the guide deals with everything
10027: from the infrastructure that is behind the interfaces described
10028: in the developer's guide. A casual package maintainer should not
10029: need anything from this part.</p>
10030: <div class="toc">
10031: <p><b>Table of Contents</b></p>
10032: <dl>
1.106 rillig 10033: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10034: <dd><dl>
1.106 rillig 10035: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10036: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10037: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10038: <dd><dl>
1.106 rillig 10039: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10040: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10041: </dl></dd>
1.106 rillig 10042: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10043: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10044: <dd><dl>
1.106 rillig 10045: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10046: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10047: </dl></dd>
1.106 rillig 10048: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10049: <dd><dl>
1.128 wiz 10050: <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>
10051: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10052: </dl></dd>
10053: </dl></dd>
1.106 rillig 10054: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10055: <dd><dl>
1.106 rillig 10056: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10057: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10058: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10059: <dd><dl>
1.106 rillig 10060: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10061: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10062: </dl></dd>
10063: </dl></dd>
1.106 rillig 10064: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10065: <dd><dl>
1.106 rillig 10066: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10067: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10068: </dl></dd>
10069: </dl>
10070: </div>
10071: </div>
1.148 asau 10072: <div class="chapter">
1.75 rillig 10073: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10074: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10075: <div class="toc">
10076: <p><b>Table of Contents</b></p>
10077: <dl>
1.106 rillig 10078: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10079: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10080: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10081: <dd><dl>
1.106 rillig 10082: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10083: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10084: </dl></dd>
1.106 rillig 10085: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10086: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10087: <dd><dl>
1.106 rillig 10088: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10089: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10090: </dl></dd>
1.106 rillig 10091: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10092: <dd><dl>
1.128 wiz 10093: <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>
10094: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10095: </dl></dd>
10096: </dl>
10097: </div>
10098: <p>The pkgsrc infrastructure consists of many small Makefile
10099: fragments. Each such fragment needs a properly specified
10100: interface. This chapter explains how such an interface looks
10101: like.</p>
1.148 asau 10102: <div class="sect1">
1.75 rillig 10103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10104: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10105: <p>Whenever a variable is defined in the pkgsrc
10106: infrastructure, the location and the way of definition provide
10107: much information about the intended use of that variable.
10108: Additionally, more documentation may be found in a header
10109: comment or in this pkgsrc guide.</p>
10110: <p>A special file is
10111: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10112: variables that are intended to be user-defined. They are either
10113: defined using the <code class="literal">?=</code> operator or they are
10114: left undefined because defining them to anything would
1.128 wiz 10115: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10116: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10117: file.</p>
10118: <p>Outside this file, the following conventions apply:
10119: Variables that are defined using the <code class="literal">?=</code>
10120: operator may be overridden by a package.</p>
10121: <p>Variables that are defined using the <code class="literal">=</code>
10122: operator may be used read-only at run-time.</p>
10123: <p>Variables whose name starts with an underscore must not be
10124: accessed outside the pkgsrc infrastructure at all. They may
10125: change without further notice.</p>
1.148 asau 10126: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10127: <h3 class="title">Note</h3>
10128: <p>These conventions are currently not applied
10129: consistently to the complete pkgsrc
10130: infrastructure.</p>
10131: </div>
10132: </div>
1.148 asau 10133: <div class="sect1">
1.81 rillig 10134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10135: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10136: <p>All variables that contain lists of things should default
10137: to being empty. Two examples that do not follow this rule are
10138: <code class="varname">USE_LANGUAGES</code> and
10139: <code class="varname">DISTFILES</code>. These variables cannot simply be
10140: modified using the <code class="literal">+=</code> operator in package
10141: <code class="filename">Makefile</code>s (or other files included by
10142: them), since there is no guarantee whether the variable is
10143: already set or not, and what its value is. In the case of
1.128 wiz 10144: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10145: the default value and just define it as in the following
10146: example.</p>
10147: <pre class="programlisting">
1.100 rillig 10148: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10149: </pre>
10150: <p>Because of the selection of this default value, the same
10151: value appears in many package Makefiles. Similarly for
10152: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10153: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10154: doesn't stand out. Nevertheless it is mentioned in many
10155: files.</p>
10156: </div>
1.148 asau 10157: <div class="sect1">
1.81 rillig 10158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10159: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148 asau 10160: <div class="sect2">
1.75 rillig 10161: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10162: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10163: <p>Variable evaluation takes place either at load time or at
10164: runtime, depending on the context in which they occur. The
10165: contexts where variables are evaluated at load time are:</p>
1.148 asau 10166: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10167: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10168: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10169: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10170: <code class="literal">.for</code>,</p></li>
1.128 wiz 10171: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10172: </ul></div>
10173: <p>A special exception are references to the iteration
10174: variables of <code class="literal">.for</code> loops, which are expanded
10175: inline, no matter in which context they appear.</p>
10176: <p>As the values of variables may change during load time,
10177: care must be taken not to evaluate them by accident. Typical
10178: examples for variables that should not be evaluated at load time
10179: are <code class="varname">DEPENDS</code> and
10180: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10181: clear, here is an example:</p>
10182: <pre class="programlisting">
1.100 rillig 10183: CONFIGURE_ARGS= # none
10184: CFLAGS= -O
10185: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10186:
1.100 rillig 10187: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10188:
1.100 rillig 10189: CFLAGS+= -Wall
1.75 rillig 10190: </pre>
10191: <p>This code shows how the use of the <code class="literal">:=</code>
10192: operator can quickly lead to unexpected results. The first
10193: paragraph is fairly common code. The second paragraph evaluates
10194: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10195: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10196: <code class="literal">-Wall</code> is appended to the
10197: <code class="varname">CFLAGS</code>, but this addition will not appear in
10198: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10199: paragraphs from above typically occur in completely unrelated
10200: files.</p>
10201: </div>
1.148 asau 10202: <div class="sect2">
1.75 rillig 10203: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10204: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10205: <p>After all the files have been loaded, the values of the
10206: variables cannot be changed anymore. Variables that are used in
10207: the shell commands are expanded at this point.</p>
10208: </div>
10209: </div>
1.148 asau 10210: <div class="sect1">
1.75 rillig 10211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10212: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10213: <p>There are many ways in which the definition and use of a
10214: variable can be restricted in order to detect bugs and
10215: violations of the (mostly unwritten) policies. See the
10216: <code class="literal">pkglint</code> developer's documentation for further
10217: details.</p>
10218: </div>
1.148 asau 10219: <div class="sect1">
1.78 rillig 10220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10221: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10222: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10223: of the following classes. Cases where a file falls into more
10224: than one class should be avoided as it often leads to subtle
10225: bugs.</p>
1.148 asau 10226: <div class="sect2">
1.75 rillig 10227: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10228: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10229: <p>In a traditional imperative programming language some of
1.76 rillig 10230: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10231: procedures. They take some input parameters and—after
10232: inclusion—provide a result in output parameters. Since all
1.76 rillig 10233: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10234: care must be taken not to use parameter names that have already
10235: another meaning. For example, <code class="varname">PKGNAME</code> is a
10236: bad choice for a parameter name.</p>
10237: <p>Procedures are completely evaluated at preprocessing time.
10238: That is, when calling a procedure all input parameters must be
10239: completely resolvable. For example,
10240: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10241: parameter since it is very likely that further text will be
10242: added after calling the procedure, which would effectively apply
10243: the procedure to only a part of the variable. Also, references
10244: to other variables wit will be modified after calling the
10245: procedure.</p>
10246: <p>A procedure can declare its output parameters either as
10247: suitable for use in preprocessing directives or as only
10248: available at runtime. The latter alternative is for variables
10249: that contain references to other runtime variables.</p>
10250: <p>Procedures shall be written such that it is possible to
10251: call the procedure more than once. That is, the file must not
10252: contain multiple-inclusion guards.</p>
10253: <p>Examples for procedures are
1.76 rillig 10254: <code class="filename">mk/bsd.options.mk</code> and
10255: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10256: that the parameters are evaluated at load time, they should be
10257: assigned using the <code class="literal">:=</code> operator, which should
10258: be used only for this purpose.</p>
10259: </div>
1.148 asau 10260: <div class="sect2">
1.75 rillig 10261: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10262: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10263: <p>Action files take some input parameters and may define
10264: runtime variables. They shall not define loadtime variables.
10265: There are action files that are included implicitly by the
10266: pkgsrc infrastructure, while other must be included
10267: explicitly.</p>
10268: <p>An example for action files is
1.76 rillig 10269: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10270: </div>
10271: </div>
1.148 asau 10272: <div class="sect1">
1.81 rillig 10273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10274: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10275: <p>Package <code class="filename">Makefile</code>s usually consist of
10276: a set of variable definitions, and include the file
10277: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10278: Before that, they may also include various other
10279: <code class="filename">*.mk</code> files if they need to query the
10280: availability of certain features like the type of compiler or
10281: the X11 implementation. Due to the heavy use of preprocessor
10282: directives like <code class="literal">.if</code> and
10283: <code class="literal">.for</code>, the order in which the files are loaded
10284: matters.</p>
10285: <p>This section describes at which point the various files
10286: are loaded and gives reasons for that order.</p>
1.148 asau 10287: <div class="sect2">
1.81 rillig 10288: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10289: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10290: </h3></div></div></div>
10291: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10292: is to define some essential variables like
10293: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10294: <code class="varname">MACHINE_ARCH</code>.</p>
10295: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10296: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 10297: After that, those variables
1.81 rillig 10298: that have not been overridden by the user are loaded from
10299: <code class="filename">mk/defaults/mk.conf</code>.</p>
10300: <p>After the user settings, the system settings and platform
10301: settings are loaded, which may override the user
10302: settings.</p>
10303: <p>Then, the tool definitions are loaded. The tool wrappers
10304: are not yet in effect. This only happens when building a
10305: package, so the proper variables must be used instead of the
10306: direct tool names.</p>
10307: <p>As the last steps, some essential variables from the
10308: wrapper and the package system flavor are loaded, as well as the
10309: variables that have been cached in earlier phases of a package
10310: build.</p>
10311: </div>
1.148 asau 10312: <div class="sect2">
1.81 rillig 10313: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10314: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10315: </h3></div></div></div>
1.81 rillig 10316: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10317: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10318: loaded, which fill default values for those variables that have
1.93 rillig 10319: not been defined by the package. These variables may later
1.81 rillig 10320: be used even in unrelated files.</p>
10321: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10322: provides the target <code class="literal">error-check</code> that is added
10323: as a special dependency to all other targets that use
10324: <code class="varname">DELAYED_ERROR_MSG</code> or
10325: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10326: <p>Then, the package-specific hacks from
10327: <code class="filename">hacks.mk</code> are included.</p>
10328: <p>Then, various other files follow. Most of them don't have
10329: any dependencies on what they need to have included before or
10330: after them, though some do.</p>
10331: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10332: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10333: restricts the use of these variables to all the files that have
10334: been included before. Appearances in later files will be
10335: silently ignored.</p>
10336: <p>Then, the files for the main targets are included, in the
10337: order of later execution, though the actual order should not
10338: matter.</p>
10339: <p>At last, some more files are included that don't set any
10340: interesting variables but rather just define make targets to be
10341: executed.</p>
10342: </div>
10343: </div>
1.75 rillig 10344: </div>
1.148 asau 10345: <div class="chapter">
1.75 rillig 10346: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10347: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10348: <div class="toc">
10349: <p><b>Table of Contents</b></p>
10350: <dl>
1.106 rillig 10351: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10352: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10353: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10354: <dd><dl>
1.106 rillig 10355: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10356: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10357: </dl></dd>
10358: </dl>
10359: </div>
10360: <p>The pkgsrc infrastructure consists of a large codebase,
10361: and there are many corners where every little bit of a file is
10362: well thought out, making pkgsrc likely to fail as soon as
10363: anything is changed near those parts. To prevent most changes
10364: from breaking anything, a suite of regression tests should go
10365: along with every important part of the pkgsrc infrastructure.
10366: This chapter describes how regression tests work in pkgsrc and
10367: how you can add new tests.</p>
1.148 asau 10368: <div class="sect1">
1.75 rillig 10369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10370: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10371: <p></p>
10372: </div>
1.148 asau 10373: <div class="sect1">
1.75 rillig 10374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10375: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10376: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110 hubertf 10377: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10378: can simply run that command, which will run all tests in the
1.76 rillig 10379: <code class="filename">regress</code> category.</p>
1.75 rillig 10380: </div>
1.148 asau 10381: <div class="sect1">
1.75 rillig 10382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10383: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10384: <p>Every directory in the <code class="filename">regress</code>
10385: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10386: is considered a regression test. This file is a shell program
1.110 hubertf 10387: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10388: The following functions can be overridden to suit your
10389: needs.</p>
1.148 asau 10390: <div class="sect2">
1.75 rillig 10391: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10392: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10393: <p>These functions do not take any parameters. They are all
1.128 wiz 10394: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.75 rillig 10395: to check the exitcodes of any commands you run in the
10396: test.</p>
1.148 asau 10397: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10398: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10399: <dd><p>This function prepares the environment for the
10400: test. By default it does nothing.</p></dd>
10401: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10402: <dd><p>This function runs the actual test. By default,
10403: it calls <code class="varname">TEST_MAKE</code> with the arguments
10404: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10405: error messages into the file
10406: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10407: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10408: <dd><p>This function is run after the test and is
10409: typically used to compare the actual output from the one that is
10410: expected. It can make use of the various helper functions from
10411: the next section.</p></dd>
10412: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10413: <dd><p>This function cleans everything up after the
10414: test has been run. By default it does nothing.</p></dd>
10415: </dl></div>
10416: </div>
1.148 asau 10417: <div class="sect2">
1.75 rillig 10418: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10419: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148 asau 10420: <div class="variablelist"><dl class="variablelist">
1.75 rillig 10421: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10422: <dd><p>This function compares the exitcode of the
1.110 hubertf 10423: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10424: If they differ, the test will fail.</p></dd>
10425: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10426: <dd><p>This function checks for each of its parameters
1.110 hubertf 10427: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10428: extended regular expression. If it does not, the test will
10429: fail.</p></dd>
10430: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10431: <dd><p>This function checks for each of its parameters
1.110 hubertf 10432: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10433: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10434: If any of the regular expressions matches, the test will
10435: fail.</p></dd>
10436: </dl></div>
10437: </div>
10438: </div>
10439: </div>
1.148 asau 10440: <div class="chapter">
1.75 rillig 10441: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10442: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10443: <div class="toc">
10444: <p><b>Table of Contents</b></p>
10445: <dl>
1.106 rillig 10446: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10447: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10448: </dl>
10449: </div>
10450: <p>The pkgsrc system has already been ported to many
10451: operating systems, hardware architectures and compilers. This
10452: chapter explains the necessary steps to make pkgsrc even more
10453: portable.</p>
1.148 asau 10454: <div class="sect1">
1.75 rillig 10455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10456: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10457: <p>To port pkgsrc to a new operating system (called
10458: <code class="literal">MyOS</code> in this example), you need to touch the
10459: following files:</p>
1.148 asau 10460: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10461: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10462: <dd><p>This file contains some basic definitions, for
10463: example the name of the C
10464: compiler.</p></dd>
1.76 rillig 10465: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10466: <dd><p>Insert code that defines the variables
10467: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10468: <code class="varname">LOWER_OS_VERSION</code>,
10469: <code class="varname">LOWER_VENDOR</code>,
10470: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10471: <code class="varname">APPEND_ELF</code>, and the other variables that
10472: appear in this file.</p></dd>
1.93 rillig 10473: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10474: <dd><p>This file contains the platform-specific
10475: definitions that are used by pkgsrc. Start by copying one of the
10476: other files and edit it to your
10477: needs.</p></dd>
1.93 rillig 10478: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10479: <dd><p>This file defines the paths to all the tools
10480: that are needed by one or the other package in pkgsrc, as well
10481: as by pkgsrc itself. Find out where these tools are on your
10482: platform and add them.</p></dd>
10483: </dl></div>
10484: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10485: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75 rillig 10486: </div>
1.148 asau 10487: <div class="sect1">
1.75 rillig 10488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10489: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10490: <p>TODO</p>
10491: </div>
10492: </div>
10493: </div>
1.148 asau 10494: <div class="appendix">
10495: <div class="titlepage"><div><div><h1 class="title">
10496: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10497: <div class="toc">
10498: <p><b>Table of Contents</b></p>
10499: <dl>
10500: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10501: <dd><dl>
10502: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10503: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10504: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10505: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 10506: </dl></dd>
10507: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10508: </dl>
10509: </div>
10510: <p>We checked to find a piece of software that wasn't in the packages
10511: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10512: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10513: present in the tree is beyond us, but it's useful for the purposes of
10514: this exercise.</p>
1.148 asau 10515: <div class="sect1">
1.75 rillig 10516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10517: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10518: <div class="sect2">
1.75 rillig 10519: <div class="titlepage"><div><div><h3 class="title">
10520: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10521: <pre class="programlisting">
1.100 rillig 10522: # $NetBSD$
10523: #
1.1 grant 10524:
1.100 rillig 10525: DISTNAME= bison-1.25
10526: CATEGORIES= devel
10527: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10528:
1.136 dholland 10529: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10530: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10531: COMMENT= GNU yacc clone
1.1 grant 10532:
1.100 rillig 10533: GNU_CONFIGURE= yes
1.152 wiz 10534: INFO_FILES= yes
1.1 grant 10535:
1.100 rillig 10536: .include "../../mk/bsd.pkg.mk"
1.1 grant 10537: </pre>
1.75 rillig 10538: </div>
1.148 asau 10539: <div class="sect2">
1.75 rillig 10540: <div class="titlepage"><div><div><h3 class="title">
10541: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10542: <pre class="programlisting">
1.100 rillig 10543: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.136 dholland 10544: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10545: of the NetBSD source tree is beyond me.
1.1 grant 10546: </pre>
1.75 rillig 10547: </div>
1.148 asau 10548: <div class="sect2">
1.75 rillig 10549: <div class="titlepage"><div><div><h3 class="title">
10550: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10551: <pre class="programlisting">
1.100 rillig 10552: @comment $NetBSD$
10553: bin/bison
10554: man/man1/bison.1.gz
10555: share/bison.simple
10556: share/bison.hairy
1.1 grant 10557: </pre>
1.75 rillig 10558: </div>
1.148 asau 10559: <div class="sect2">
1.75 rillig 10560: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10561: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10562: </h3></div></div></div>
1.75 rillig 10563: <p>The NetBSD package system comes with
1.91 rillig 10564: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10565: which helps to check the contents of these
10566: files. After installation it is quite easy to use, just change to the
10567: directory of the package you wish to examine and execute
1.110 hubertf 10568: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10569: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10570: looks fine.</pre>
10571: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10572: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10573: -Wall</strong></span> for a very thorough check.</p>
10574: </div>
10575: </div>
1.148 asau 10576: <div class="sect1">
1.75 rillig 10577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10578: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10579: <p>Create the directory where the package lives,
10580: plus any auxiliary directories:</p>
10581: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10582: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10583: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10584: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10585: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10586: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10587: then continue with fetching the distfile:</p>
10588: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10589: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10590: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10591: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10592: ftp: Error retrieving file: 500 Internal error
10593:
10594: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10595: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10596: ftp: Error retrieving file: 500 Internal error
10597:
10598: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10599: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10600: Successfully retrieved file.</pre>
10601: <p>Generate the checksum of the distfile into
1.76 rillig 10602: <code class="filename">distinfo</code>:</p>
1.88 wiz 10603: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10604: <p>Now compile:</p>
10605: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10606: >> Checksum OK for bison-1.25.tar.gz.
10607: ===> Extracting for bison-1.25
10608: ===> Patching for bison-1.25
10609: ===> Ignoring empty patch directory
10610: ===> Configuring for bison-1.25
10611: creating cache ./config.cache
10612: checking for gcc... cc
10613: checking whether we are using GNU C... yes
10614: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10615: checking how to run the C preprocessor... cc -E
10616: checking for minix/config.h... no
10617: checking for POSIXized ISC... no
10618: checking whether cross-compiling... no
10619: checking for ANSI C header files... yes
10620: checking for string.h... yes
10621: checking for stdlib.h... yes
10622: checking for memory.h... yes
10623: checking for working const... yes
10624: checking for working alloca.h... no
10625: checking for alloca... yes
10626: checking for strerror... yes
10627: updating cache ./config.cache
10628: creating ./config.status
10629: creating Makefile
10630: ===> Building for bison-1.25
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 LR0.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 allocate.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 closure.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 conflicts.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 derives.c
1.68 rillig 10636: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
1.1 grant 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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.c
10646: 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
10647: 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
10648: 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
10649: 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
10650: 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
10651: 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
10652: 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
10653: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10654: rm -f bison.s1
1.75 rillig 10655: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10656: <p>Everything seems OK, so install the files:</p>
10657: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10658: >> Checksum OK for bison-1.25.tar.gz.
10659: ===> Installing for bison-1.25
10660: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10661: rm -f /usr/pkg/bin/bison
10662: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10663: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10664: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10665: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10666: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10667: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10668: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10669: ===> Registering installation for bison-1.25</pre>
10670: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10671: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10672: binary package, do this now:</p>
10673: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10674: >> Checksum OK for bison-1.25.tar.gz.
10675: ===> Building package for bison-1.25
10676: Creating package bison-1.25.tgz
10677: Registering depends:.
1.75 rillig 10678: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10679: <p>Now that you don't need the source and object files
10680: any more, clean up:</p>
10681: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10682: ===> Cleaning for bison-1.25</pre>
10683: </div>
10684: </div>
1.148 asau 10685: <div class="appendix">
10686: <div class="titlepage"><div><div><h1 class="title">
10687: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10688: <div class="toc">
10689: <p><b>Table of Contents</b></p>
10690: <dl>
10691: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10692: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10693: </dl>
10694: </div>
1.148 asau 10695: <div class="sect1">
1.75 rillig 10696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10697: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10698: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10699: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10700: => figlet221.tar.gz doesn't seem to exist on this system.
10701: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10702: => [172219 bytes]
10703: Connected to ftp.plig.net.
10704: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10705: 331 Guest login ok, send your complete e-mail address as password.
10706: 230-You are user #5 of 500 simultaneous users allowed.
10707: 230-
1.68 rillig 10708: 230- ___ _ _ _
10709: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10710: 230- | _| _| . |_| . | | | . |_| . | _| . |
10711: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10712: 230- |_| |_| |___| |___|
10713: 230-
10714: 230-** Welcome to ftp.plig.org **
10715: 230-
10716: 230-Please note that all transfers from this FTP site are logged. If you
10717: 230-do not like this, please disconnect now.
10718: 230-
1.120 snj 10719: 230-This archive is available via
1.1 grant 10720: 230-
10721: 230-HTTP: http://ftp.plig.org/
10722: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10723: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10724: 230-
10725: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10726: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10727: 230-
10728: 230-
10729: 230 Logged in anonymously.
10730: Remote system type is UNIX.
10731: Using binary mode to transfer files.
10732: 200 Type okay.
10733: 250 "/pub" is new cwd.
10734: 250-"/pub/figlet" is new cwd.
10735: 250-
10736: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10737: 250-
1.75 rillig 10738: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10739: 250-
10740: 250-The official FIGlet web page is:
1.75 rillig 10741: 250- http://www.figlet.org/
1.1 grant 10742: 250-
10743: 250-If you have questions, please mailto:info@figlet.org. If you want to
10744: 250-contribute a font or something else, you can email us.
1.68 rillig 10745: 250
1.1 grant 10746: 250 "/pub/figlet/program" is new cwd.
10747: 250 "/pub/figlet/program/unix" is new cwd.
10748: local: figlet221.tar.gz remote: figlet221.tar.gz
10749: 502 Unimplemented command.
10750: 227 Entering Passive Mode (195,40,6,41,246,104)
10751: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10752: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10753: 226 Transfer completed.
10754: 172219 bytes received in 00:02 (75.99 KB/s)
10755: 221 Goodbye.
10756: => Checksum OK for figlet221.tar.gz.
10757: ===> Extracting for figlet-2.2.1nb2
10758: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10759: ===> Patching for figlet-2.2.1nb2
10760: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10761: ===> Overriding tools for figlet-2.2.1nb2
10762: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10763: ===> Configuring for figlet-2.2.1nb2
10764: ===> Building for figlet-2.2.1nb2
10765: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10766: chmod a+x figlet
10767: gcc -O2 -o chkfont chkfont.c
10768: => Unwrapping files-to-be-installed.
1.14 xtraeme 10769: <code class="prompt">#</code>
1.75 rillig 10770: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10771: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10772: ===> Installing for figlet-2.2.1nb2
10773: install -d -o root -g wheel -m 755 /usr/pkg/bin
10774: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10775: mkdir -p /usr/pkg/share/figlet
10776: cp figlet /usr/pkg/bin
10777: cp chkfont /usr/pkg/bin
10778: chmod 555 figlist showfigfonts
10779: cp figlist /usr/pkg/bin
10780: cp showfigfonts /usr/pkg/bin
10781: cp fonts/*.flf /usr/pkg/share/figlet
10782: cp fonts/*.flc /usr/pkg/share/figlet
10783: cp figlet.6 /usr/pkg/man/man6
10784: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10785: <code class="prompt">#</code></pre>
10786: </div>
1.148 asau 10787: <div class="sect1">
1.75 rillig 10788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10789: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10790: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10791: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10792: ===> Packaging figlet-2.2.1nb2
10793: ===> Building binary package for figlet-2.2.1nb2
10794: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10795: Using SrcDir value of /usr/pkg
1.68 rillig 10796: Registering depends:.
1.75 rillig 10797: <code class="prompt">#</code></pre>
10798: </div>
10799: </div>
1.148 asau 10800: <div class="appendix">
10801: <div class="titlepage"><div><div><h1 class="title">
10802: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10803: <div class="toc">
10804: <p><b>Table of Contents</b></p>
10805: <dl>
1.128 wiz 10806: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10807: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10808: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10809: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10810: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10811: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10812: source packages</a></span></dt>
10813: </dl>
10814: </div>
10815: <p>As in other big projects, the directory layout of pkgsrc
10816: is quite complex for newbies. This chapter explains where you
10817: find things on the FTP server. The base directory on
1.110 hubertf 10818: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89 rillig 10819: On other servers it may be different, but inside this directory,
10820: everything should look the same, no matter on which server you
10821: are. This directory contains some subdirectories, which are
10822: explained below.</p>
1.148 asau 10823: <div class="sect1">
1.76 rillig 10824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10825: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10826: <p>The directory <code class="filename">distfiles</code> contains lots
10827: of archive files from all pkgsrc packages, which are mirrored
10828: here. The subdirectories are called after their package names
10829: and are used when the distributed files have names that don't
10830: explicitly contain a version number or are otherwise too generic
10831: (for example <code class="filename">release.tar.gz</code>).</p>
10832: </div>
1.148 asau 10833: <div class="sect1">
1.76 rillig 10834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10835: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10836: <p>This directory contains things that individual pkgsrc
10837: developers find worth publishing.</p>
10838: </div>
1.148 asau 10839: <div class="sect1">
1.76 rillig 10840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10841: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10842: <p>This directory contains binary packages for the various
10843: platforms that are supported by pkgsrc.
10844: Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.148 asau 10845: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10846: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10847: operating system for which the packages have been built. The
1.110 hubertf 10848: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10849: command, so it may differ from the one you are used to
10850: hear.</p></li>
1.128 wiz 10851: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10852: architecture of the platform for which the packages have been
1.110 hubertf 10853: built. It also includes the <code class="varname">ABI</code> (Application
10854: Binary Interface) for platforms that have several of
10855: them.</p></li>
1.128 wiz 10856: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10857: the operating system. For version numbers that change often (for
10858: example NetBSD-current), the often-changing part should be
10859: replaced with an <code class="literal">x</code>, for example
10860: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10861: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10862: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10863: for a stable branch, or <code class="literal">head</code> for packages
10864: built from the HEAD branch. The latter should only be used when
10865: the packages are updated on a regular basis. Otherwise the date
10866: from checking out pkgsrc should be appended, for example
10867: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10868: </ul></div>
10869: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10870: can quickly click through the directories on the
10871: server and find the best binary packages for their machines. Since they
10872: usually know the operating system and the hardware architecture, OPSYS
10873: and ARCH are placed first. After these choices, they can select the
10874: best combination of OSVERSION and TAG together, since it is usually the
10875: case that packages stay compatible between different version of the
10876: operating system.</p>
10877: <p>In each of these directories, there is a
10878: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10879: <code class="filename">All</code> which contains all binary packages.
10880: Besides that, there are various category directories that
10881: contain symbolic links to the real binary packages.</p>
10882: </div>
1.148 asau 10883: <div class="sect1">
1.76 rillig 10884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10885: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10886: <p>Here are the reports from bulk builds, for those who want
10887: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10888: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.108 rillig 10889: </div>
1.148 asau 10890: <div class="sect1">
1.108 rillig 10891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10892: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10893: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10894: source packages</h2></div></div></div>
1.128 wiz 10895: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10896: that is the files that define how to create binary packages from
10897: source archives.</p>
10898: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10899: snapshot of the CVS repository, which is updated regularly. The
10900: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10901: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10902: <p>In the directories for the quarterly branches, there is an
10903: additional file called
1.126 jakllsch 10904: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76 rillig 10905: which contains the state of pkgsrc when it was branched.</p>
10906: </div>
1.75 rillig 10907: </div>
1.148 asau 10908: <div class="appendix">
10909: <div class="titlepage"><div><div><h1 class="title">
10910: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 10911: <div class="toc">
10912: <p><b>Table of Contents</b></p>
10913: <dl>
1.79 rillig 10914: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10915: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10916: </dl>
10917: </div>
1.79 rillig 10918: <p>This section contains information on editing the pkgsrc
10919: guide itself.</p>
1.148 asau 10920: <div class="sect1">
1.75 rillig 10921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10922: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10923: <p>The pkgsrc guide's source code is stored in
10924: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10925: are created from it:</p>
1.148 asau 10926: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10927: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10928: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
10929: <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>
10930: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79 rillig 10931: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 10932: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79 rillig 10933: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10934: </ul></div>
10935: </div>
1.148 asau 10936: <div class="sect1">
1.75 rillig 10937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10938: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10939: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 10940: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 10941: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 10942: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 10943: documentation) installed. These are automatically installed when
10944: you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148 asau 10945: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 10946: right directory. All further steps will take place
10947: here.</p></li>
1.148 asau 10948: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 10949: <code class="filename">files/</code>.</p></li>
1.148 asau 10950: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 10951: guide for valid XML and to build the final output files. If you
10952: get any errors at this stage, you can just edit the files, as
10953: there are only symbolic links in the working directory, pointing
10954: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 10955: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 10956: commit)</strong></span></p></li>
1.148 asau 10957: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 10958: regenerate the output files with the proper RCS
10959: Ids.</p></li>
1.148 asau 10960: <li class="step">
1.110 hubertf 10961: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 10962: commit the files in both <code class="filename">pkgsrc/doc</code> and
10963: <code class="filename">htdocs</code>.</p>
1.148 asau 10964: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 10965: <h3 class="title">Note</h3>
10966: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 10967: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10968: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 10969: directory.</p>
10970: </div>
10971: </li>
1.79 rillig 10972: </ol></div>
1.75 rillig 10973: </div>
10974: </div>
10975: </div></body>
1.1 grant 10976: </html>
CVSweb <webmaster@jp.NetBSD.org>